{"components":{"examples":{"cache-rules_cache_reserve_clear_completed":{"value":{"errors":[],"messages":[],"result":{"end_ts":"2023-10-02T12:00:00.12345Z","id":"cache_reserve_clear","start_ts":"2023-10-02T10:00:00.12345Z","state":"Completed"},"success":true}},"cache-rules_cache_reserve_clear_in_progress":{"value":{"errors":[],"messages":[],"result":{"id":"cache_reserve_clear","start_ts":"2023-10-02T10:00:00.12345Z","state":"In-progress"},"success":true}},"cache-rules_cache_reserve_clear_not_found":{"value":{"errors":[{"code":1142,"message":"Unable to retrieve cache_reserve_clear setting value. The zone setting does not exist because you never performed a Cache Reserve Clear operation."}],"messages":[],"result":null,"success":false}},"cache-rules_cache_reserve_clear_rejected_cr_on":{"value":{"errors":[{"code":1152,"message":"Turn off Cache Reserve sync to proceed with deletion."}],"messages":[],"result":null,"success":false}},"cache-rules_cache_reserve_denied_clearing":{"value":{"errors":[{"code":1153,"message":"Cache Reserve cannot be enabled because a deletion is already in progress."}],"messages":[],"result":null,"success":false}},"cache-rules_cache_reserve_off":{"value":{"errors":[],"messages":[],"result":{"editable":true,"id":"cache_reserve","value":"off"},"success":true}},"cache-rules_cache_reserve_on":{"value":{"errors":[],"messages":[],"result":{"editable":true,"id":"cache_reserve","value":"on"},"success":true}},"cache-rules_dummy_error_response":{"value":{"errors":[{"code":12345,"message":"Some error message"}],"messages":[],"result":null,"success":false}},"cache-rules_origin_h2_max_streams_50":{"value":{"errors":[],"messages":[],"result":{"editable":true,"id":"origin_h2_max_streams","value":50},"success":true}},"cache-rules_origin_max_http_version_2":{"value":{"errors":[],"messages":[],"result":{"editable":true,"id":"origin_max_http_version","value":"2"},"success":true}},"cache_dummy_automatic_upgrader_disabled_response":{"value":{"errors":[],"messages":[],"result":{"editable":true,"id":"ssl_automatic_mode","modified_on":"2014-01-01T05:20:00.12345Z","value":"custom"},"success":true}},"cache_dummy_automatic_upgrader_enabled_response":{"value":{"errors":[],"messages":[],"result":{"editable":true,"id":"ssl_automatic_mode","modified_on":"2014-01-01T05:20:00.12345Z","next_scheduled_scan":"2014-02-01T05:20:00.12345Z","value":"auto"},"success":true}},"cache_dummy_error_response":{"value":{"errors":[{"code":1008,"message":"Invalid SSL/TLS encryption configuration value, only auto or custom accepted"}],"messages":[],"result":{"editable":true,"id":"ssl_automatic_mode","modified_on":"2014-01-01T05:20:00.12345Z","value":"custom"},"success":false}},"realtimekit_DaywiseStatsSuccessResponse":{"summary":"Daywise stats response","value":{"data":[{"date":"2022-03-01","recordings_minutes_consumed":129.14,"sessions_count":10,"sessions_minutes_consumed":123.22},{"date":"2022-03-02","recordings_minutes_consumed":338.12,"sessions_count":16,"sessions_minutes_consumed":1278.87}],"success":true}},"realtimekit_GetActiveSessionNotFoundResponse":{"summary":"Active Session not found","value":{"error":{"code":404,"message":"No active session found for meeting_id 6bf2b8be-04dd-4191-b602-1128921a306b"},"success":false}},"realtimekit_GetActiveSessionSuccessResponse":{"summary":"Success response for fetching active session","value":{"data":{"associated_id":"6bf2b8be-04dd-4191-b602-1128921a306b","created_at":"2022-01-12T14:21:34.398Z","ended_at":"null","id":"813432c7-3c5a-45e2-9acf-eef7061c7584","live_participants":1,"max_concurrent_participants":2,"minutes_consumed":2.3434,"started_at":"2022-01-12T14:21:34.388Z","status":"LIVE","type":"meeting","updated_at":"2022-01-12T14:26:00.784Z"},"success":true}},"realtimekit_OverallStatsSuccessResponse":{"summary":"Overall Stats response","value":{"data":{"recordings_minutes_consumed":468.8932,"sessions_count":26,"sessions_minutes_consumed":1323.23},"success":true}},"realtimekit_ParticipantListSuccess":{"summary":"success response for session's participants list","value":{"data":{"paging":{"end_offset":2,"start_offset":1,"total_count":123},"participants":[{"created_at":"2023-02-01T10:51:08.039Z","custom_participant_id":"83qi0i","display_name":"Mark","duration":5.8097,"id":"005f4e0c-4d08-4d4e-a391-a76be75cd296","joined_at":"2023-02-01T10:51:08.030Z","left_at":"2023-02-01T10:56:56.612Z","preset_name":"webinar_participant","updated_at":"2023-02-01T10:56:56.618Z","user_id":"0a08343d-a9dc-45f0-9feb-6a64afcc4f81"},{"created_at":"2023-02-01T10:50:36.853Z","custom_participant_id":"3uggr","display_name":"Henry","duration":6.9263,"id":"51fdf95f-d893-471a-922b-7db7adb14453","joined_at":"2023-02-01T10:50:36.846Z\"","left_at":"2023-02-01T10:57:32.424Z","preset_name":"webinar_participant","updated_at":"2023-02-01T10:57:32.431Z","user_id":"85e7f0fd-7c16-45e9-9d68-f17ef007c4eb"}]},"success":true}},"realtimekit_ParticipantListWithPeerEventSucces":{"summary":"success response for sessions participants list with peer events","value":{"data":{"paging":{"end_offset":2,"start_offset":1,"total_count":123},"participants":[{"created_at":"2023-02-01T10:51:08.039Z","custom_participant_id":"83qi0i","display_name":"Mark","duration":5.8097,"id":"005f4e0c-4d08-4d4e-a391-a76be75cd296","joined_at":"2023-02-01T10:51:08.030Z","left_at":"2023-02-01T10:56:56.612Z","peer_events":[{"created_at":"2023-02-01T10:51:50.786Z","event_name":"PEER_JOINING","id":"94af3bac-f30b-40b9-ab45-4b9e6eff191a","peer_id":"79d87ca5-7e47-452a-b3c1-b6842ad84bf5","updated_at":"2023-02-01T10:51:50.792Z"},{"created_at":"2023-02-01T10:56:50.786Z","event_name":"PEER_LEAVING","id":"94af3bac-f30b-40b9-ab45-4b9e6eff191b","peer_id":"79d87ca5-7e47-452a-b3c1-b6842ad84bf5","updated_at":"2023-02-01T10:56:50.792Z"}],"preset_name":"webinar_participant","updated_at":"2023-02-01T10:56:56.618Z","user_id":"0a08343d-a9dc-45f0-9feb-6a64afcc4f81"},{"created_at":"2023-02-01T10:50:36.853Z","custom_participant_id":"3uggr","display_name":"Henry","duration":6.9263,"id":"51fdf95f-d893-471a-922b-7db7adb14453","joined_at":"2023-02-01T10:50:36.846Z\"","left_at":"2023-02-01T10:57:32.424Z","peer_events":[{"created_at":"2023-02-01T10:51:50.786Z","event_name":"PEER_JOINING","id":"94af3bac-f30b-40b9-ab45-4b9e6eff191a","peer_id":"51fdf95f-d893-471a-922b-7db7adb14453","updated_at":"2023-02-01T10:51:50.792Z"},{"created_at":"2023-02-01T10:56:50.786Z","event_name":"PEER_LEAVING","id":"94af3bac-f30b-40b9-ab45-4b9e6eff191b","peer_id":"51fdf95f-d893-471a-922b-7db7adb14453","updated_at":"2023-02-01T10:56:50.792Z"}],"preset_name":"webinar_participant","updated_at":"2023-02-01T10:57:32.431Z","user_id":"85e7f0fd-7c16-45e9-9d68-f17ef007c4eb"}]},"success":true}},"realtimekit_ParticipantNotFoundResponse":{"summary":"Participant Not Found","value":{"error":{"code":404,"message":"No user found with id 813432c7-3c5a-45e2-9acf-eef7061c7584"},"success":false}},"smartshield_cache_reserve_clear_completed":{"value":{"errors":[],"messages":[],"result":{"end_ts":"2023-10-02T12:00:00.12345Z","id":"cache_reserve_clear","start_ts":"2023-10-02T10:00:00.12345Z","state":"Completed"},"success":true}},"smartshield_cache_reserve_clear_in_progress":{"value":{"errors":[],"messages":[],"result":{"id":"cache_reserve_clear","start_ts":"2023-10-02T10:00:00.12345Z","state":"In-progress"},"success":true}},"smartshield_cache_reserve_clear_not_found":{"value":{"errors":[{"code":1142,"message":"Unable to retrieve cache_reserve_clear setting value. The zone setting does not exist because you never performed a Cache Reserve Clear operation."}],"messages":[],"result":null,"success":false}},"smartshield_cache_reserve_clear_rejected_cr_on":{"value":{"errors":[{"code":1152,"message":"Turn off Cache Reserve sync to proceed with deletion."}],"messages":[],"result":null,"success":false}},"smartshield_smart_shield_4xx_get_response":{"value":{"errors":[{"code":1034,"message":"Upgrade Smart Shield to unlock smart_tiered_cache."},{"code":1034,"message":"Upgrade Smart Shield to unlock argo_smart_routing."},{"code":1034,"message":"Upgrade Smart Shield to unlock regional_tiered_cache."},{"code":1034,"message":"Upgrade Smart Shield to unlock cache_reserve."},{"code":1034,"message":"Upgrade Smart Shield to unlock healthchecks_count."}],"messages":[],"result":null,"success":false}},"smartshield_smart_shield_4xx_patch_response":{"value":{"errors":[{"code":1035,"message":"Invalid value for smart_tiered_cache. Value must be 'on' or 'off'."}],"messages":[],"result":null,"success":false}},"smartshield_smart_shield_500_response":{"value":{"errors":[{"code":1137,"message":"Unable to process request. Internal error."}],"messages":[],"result":null,"success":false}},"smartshield_smart_shield_502_get_response":{"value":{"errors":[{"code":1016,"message":"Unable to retrieve smart_tiered_cache."},{"code":1016,"message":"Unable to retrieve cache_reserve."},{"code":1016,"message":"Unable to retrieve smart_routing."},{"code":1016,"message":"Unable to retrieve regional_tiered_cache."},{"code":1016,"message":"Unable to retrieve healthchecks_count."}],"messages":[],"result":null,"success":false}},"smartshield_smart_shield_502_patch_response":{"value":{"errors":[{"code":1016,"message":"Unable to update smart_tiered_cache."}],"messages":[],"result":null,"success":false}}},"parameters":{"access_page":{"in":"query","name":"page","schema":{"default":1,"description":"Page number of results.","type":"integer"}},"access_per_page":{"in":"query","name":"per_page","schema":{"default":1000,"description":"Number of results per page.","type":"integer"}},"api-shield_api_discovery_origin_parameter":{"description":"Filter results to only include discovery results sourced from a particular discovery engine\n  * `ML` - Discovered operations that were sourced using ML API Discovery\n  * `SessionIdentifier` - Discovered operations that were sourced using Session Identifier API Discovery\n","in":"query","name":"origin","schema":{"$ref":"#/components/schemas/api-shield_api_discovery_origin"}},"api-shield_api_discovery_state_parameter":{"description":"Filter results to only include discovery results in a particular state. States are as follows\n  * `review` - Discovered operations that are not saved into API Shield Endpoint Management\n  * `saved` - Discovered operations that are already saved into API Shield Endpoint Management\n  * `ignored` - Discovered operations that have been marked as ignored\n","in":"query","name":"state","schema":{"$ref":"#/components/schemas/api-shield_api_discovery_state"}},"api-shield_config_id":{"description":"Token Configuration ID","example":"4a7ee8d3-dd63-4ceb-9d5f-c27831854ce7","in":"path","name":"config_id","required":true,"schema":{"$ref":"#/components/schemas/api-shield_schemas-uuid"}},"api-shield_diff_parameter":{"in":"query","name":"diff","schema":{"description":"When `true`, only return API Discovery results that are not saved into API Shield Endpoint Management","type":"boolean"}},"api-shield_direction_parameter":{"in":"query","name":"direction","schema":{"description":"Direction to order results.","enum":["asc","desc"],"example":"desc","type":"string"}},"api-shield_endpoint_parameter":{"in":"query","name":"endpoint","schema":{"description":"Filter results to only include endpoints containing this pattern.","example":"/api/v1","type":"string"}},"api-shield_host_parameter":{"in":"query","name":"host","schema":{"description":"Filter results to only include the specified hosts.","items":{"example":"api.cloudflare.com","type":"string"},"type":"array","uniqueItems":true}},"api-shield_method_parameter":{"in":"query","name":"method","schema":{"description":"Filter results to only include the specified HTTP methods.","items":{"example":"GET","type":"string"},"type":"array","uniqueItems":true}},"api-shield_old_omit_source":{"description":"Omit the source-files of schemas and only retrieve their meta-data.","in":"query","name":"omit_source","schema":{"default":false,"type":"boolean"}},"api-shield_old_schema_id":{"description":"Identifier for the schema-ID","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","in":"path","name":"schema_id","required":true,"schema":{"format":"uuid","maxLength":36,"readOnly":true,"type":"string"}},"api-shield_omit_source_query":{"description":"Omit the source-files of schemas and only retrieve their meta-data.","in":"query","name":"omit_source","schema":{"default":false,"type":"boolean"}},"api-shield_operation_feature_parameter":{"description":"Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.","in":"query","name":"feature","schema":{"example":["thresholds"],"items":{"enum":["thresholds","parameter_schemas","schema_info"],"example":"thresholds","type":"string"},"type":"array","uniqueItems":true}},"api-shield_operation_id":{"description":"Identifier for the operation","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","in":"path","name":"operation_id","required":true,"schema":{"$ref":"#/components/schemas/api-shield_uuid"}},"api-shield_order_parameter":{"in":"query","name":"order","schema":{"description":"Field to order by","enum":["host","method","endpoint","traffic_stats.requests","traffic_stats.last_updated"],"example":"method","type":"string"}},"api-shield_page":{"description":"Page number of paginated results.","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},"api-shield_parameters-operation_id":{"description":"Identifier for the discovered operation","in":"path","name":"operation_id","required":true,"schema":{"$ref":"#/components/schemas/api-shield_schemas-uuid"}},"api-shield_per_page":{"description":"Maximum number of results per page.","in":"query","name":"per_page","schema":{"default":20,"maximum":50,"minimum":5,"type":"integer"}},"api-shield_rule_id":{"description":"Token Validation Rule ID","example":"4a7ee8d3-dd63-4ceb-9d5f-c27831854ce7","in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/api-shield_schemas-uuid"}},"api-shield_schema_id_path":{"description":"The unique identifier of the schema","in":"path","name":"schema_id","required":true,"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_schemas-uuid"},{"format":"uuid","readOnly":true,"type":"string"}],"type":"string"}},"api-shield_zone_id":{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/api-shield_schemas-identifier"}},"builds_AccountId":{"description":"Account identifier","in":"path","name":"account_id","required":true,"schema":{"example":"account-123","type":"string"}},"builds_BuildUuid":{"description":"Build UUID","in":"path","name":"build_uuid","required":true,"schema":{"format":"uuid","type":"string"}},"builds_Page":{"description":"Page number for pagination","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},"builds_PerPage":{"description":"Number of items per page","in":"query","name":"per_page","schema":{"default":50,"maximum":200,"minimum":1,"type":"integer"}},"builds_RepoConnectionUuid":{"description":"Repository connection UUID","in":"path","name":"repo_connection_uuid","required":true,"schema":{"format":"uuid","type":"string"}},"builds_TriggerUuid":{"description":"Trigger UUID","in":"path","name":"trigger_uuid","required":true,"schema":{"format":"uuid","type":"string"}},"dls_account_id":{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dls_identifier"}},"dls_hostname":{"in":"path","name":"hostname","required":true,"schema":{"$ref":"#/components/schemas/dls_hostname"}},"dls_zone_id":{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dls_identifier"}},"healthchecks_page":{"description":"Page number of paginated results.","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"number"}},"healthchecks_per_page":{"description":"Maximum number of results per page. Must be a multiple of 5.","in":"query","name":"per_page","schema":{"default":25,"maximum":1000,"minimum":5,"type":"number"}},"organizations-api_OrganizationListFiltersContainingAccount":{"description":"Filter the list of organizations to the ones that contain this particular\naccount.","explode":false,"in":"query","name":"containing.account","schema":{"type":"string"}},"organizations-api_OrganizationListFiltersContainingOrganization":{"description":"Filter the list of organizations to the ones that contain this particular\norganization.","explode":false,"in":"query","name":"containing.organization","schema":{"type":"string"}},"organizations-api_OrganizationListFiltersContainingUser":{"description":"Filter the list of organizations to the ones that contain this particular\nuser.\n\nIMPORTANT: Just because an organization \"contains\" a user is not a\nrepresentation of any authorization or privilege to manage any resources\ntherein. An organization \"containing\" a user simply means the user is managed by\nthat organization.","explode":false,"in":"query","name":"containing.user","schema":{"type":"string"}},"organizations-api_OrganizationListFiltersId":{"description":"Only return organizations with the specified IDs (ex. id=foo\u0026id=bar). Send multiple elements\nby repeating the query value.","explode":false,"in":"query","name":"id","schema":{"items":{"$ref":"#/components/schemas/organizations-api_OrganizationID"},"type":"array"}},"organizations-api_OrganizationListFiltersName":{"description":"(case-sensitive) Filter the list of organizations to where the name is equal to a\nparticular string.","explode":false,"in":"query","name":"name","schema":{"type":"string"}},"organizations-api_OrganizationListFiltersNameContains":{"description":"(case-insensitive) Filter the list of organizations to where the name contains a particular\nstring.","explode":false,"in":"query","name":"name.contains","schema":{"type":"string"}},"organizations-api_OrganizationListFiltersNameEndsWith":{"description":"(case-insensitive) Filter the list of organizations to where the name ends with a particular\nstring.","explode":false,"in":"query","name":"name.endsWith","schema":{"type":"string"}},"organizations-api_OrganizationListFiltersNameStartsWith":{"description":"(case-insensitive) Filter the list of organizations to where the name starts with a\nparticular string.","explode":false,"in":"query","name":"name.startsWith","schema":{"type":"string"}},"organizations-api_OrganizationListFiltersParentId":{"description":"Filter the list of organizations to the ones that are a sub-organization\nof the specified organization.\n\n\"null\" is a valid value to provide for this parameter. It means \"where\nan organization has no parent (i.e. it is a 'root' organization).\"","explode":false,"in":"query","name":"parent.id","schema":{"anyOf":[{"$ref":"#/components/schemas/organizations-api_OrganizationID"},{"enum":["null"],"type":"string"}]}},"organizations-api_PageTokenParamsPageSize":{"description":"The amount of items to return. Defaults to 10.","explode":false,"in":"query","name":"page_size","schema":{"maximum":1000,"minimum":0,"type":"integer"}},"organizations-api_PageTokenParamsPageToken":{"description":"An opaque token returned from the last list response that when\nprovided will retrieve the next page.\n\nParameters used to filter the retrieved list must remain in subsequent\nrequests with a page token.","explode":false,"in":"query","name":"page_token","schema":{"type":"string"}},"realtimekit_account_id":{"description":"The account identifier tag.","example":"023e105f4ecef8ad9ca31a8372d0c353","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},"realtimekit_app_id":{"description":"A Cloudflare-generated unique identifier for an item.","example":"14a396e7-ca44-4937-bf1f-050a69118543","in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},"realtimekit_endDate":{"description":"end date in YYYY-MM-DD format","examples":{"default":{"value":"2022-09-22"}},"in":"query","name":"end_date","schema":{"example":"2022-09-22","type":"string"}},"realtimekit_endTime":{"description":"The end time range for which you want to retrieve the meetings. The time must be specified in ISO format.","in":"query","name":"end_time","schema":{"format":"date-time","type":"string"}},"realtimekit_meetingId":{"description":"ID of the meeting","in":"path","name":"meeting_id","required":true,"schema":{"type":"string"}},"realtimekit_meeting_id":{"description":"The unique identifier for the meeting.","example":"550e8400-e29b-41d4-a716-446655440000","in":"path","name":"meeting_id","required":true,"schema":{"pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$","type":"string"}},"realtimekit_pageNo":{"allowEmptyValue":true,"description":"The page number from which you want your page search results to be displayed.","in":"query","name":"page_no","schema":{"minimum":0,"type":"number"}},"realtimekit_participantId":{"description":"ID of the participant","in":"path","name":"participant_id","required":true,"schema":{"type":"string"}},"realtimekit_participants":{"examples":{"default":{"value":"1:10"}},"in":"query","name":"participants","schema":{"example":"1:10","type":"string"}},"realtimekit_participantsSortBy":{"in":"query","name":"sort_by","schema":{"enum":["joinedAt","duration"],"type":"string"}},"realtimekit_perPage":{"allowEmptyValue":true,"description":"Number of results per page","in":"query","name":"per_page","schema":{"minimum":0,"type":"number"}},"realtimekit_recordingSortBy":{"in":"query","name":"sort_by","schema":{"enum":["invokedTime"],"type":"string"}},"realtimekit_recordingStatus":{"description":"Filter by one or more recording status","explode":false,"in":"query","name":"status","schema":{"items":{"enum":["INVOKED","RECORDING","UPLOADING","UPLOADED"],"type":"string"},"type":"array"}},"realtimekit_search":{"description":"The search query string. You can search using the meeting ID or title.","in":"query","name":"search","schema":{"type":"string"}},"realtimekit_sessionId":{"description":"ID of the session","in":"path","name":"session_id","required":true,"schema":{"type":"string"}},"realtimekit_sortBy":{"in":"query","name":"sort_by","schema":{"enum":["minutesConsumed","createdAt"],"type":"string"}},"realtimekit_sortOrder":{"in":"query","name":"sort_order","schema":{"enum":["ASC","DESC"],"type":"string"}},"realtimekit_startDate":{"description":"start date in YYYY-MM-DD format","examples":{"default":{"value":"2022-09-01"}},"in":"query","name":"start_date","schema":{"example":"2022-09-01","type":"string"}},"realtimekit_startTime":{"description":"The start time range for which you want to retrieve the meetings. The time must be specified in ISO format.","in":"query","name":"start_time","schema":{"format":"date-time","type":"string"}},"realtimekit_status":{"in":"query","name":"status","schema":{"enum":["LIVE","ENDED"],"type":"string"}},"realtimekit_streamId":{"description":"ID of the livestream","in":"path","name":"stream_id","required":true,"schema":{"type":"number"},"style":"simple"},"resource-sharing_direction":{"description":"Direction to sort objects.","in":"query","name":"direction","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},"resource-sharing_include_recipient_counts":{"description":"Include recipient counts in the response.","in":"query","name":"include_recipient_counts","schema":{"example":true,"type":"boolean"}},"resource-sharing_include_resources":{"description":"Include resources in the response.","in":"query","name":"include_resources","schema":{"example":true,"type":"boolean"}},"resource-sharing_kind":{"description":"Filter shares by kind.","in":"query","name":"kind","schema":{"$ref":"#/components/schemas/resource-sharing_share_kind"}},"resource-sharing_order":{"description":"Order shares by values in the given field.","in":"query","name":"order","schema":{"default":"created","enum":["name","created"],"type":"string"}},"resource-sharing_page":{"description":"Page number.","in":"query","name":"page","schema":{"example":2,"minimum":0,"multipleOf":1,"type":"integer"}},"resource-sharing_per_page":{"description":"Number of objects to return per page.","in":"query","name":"per_page","schema":{"example":20,"maximum":100,"minimum":0,"multipleOf":1,"type":"integer"}},"resource-sharing_resource_status":{"description":"Filter share resources by status.","in":"query","name":"status","schema":{"$ref":"#/components/schemas/resource-sharing_resource_status"}},"resource-sharing_resource_type":{"description":"Filter share resources by resource_type.","in":"query","name":"resource_type","schema":{"$ref":"#/components/schemas/resource-sharing_resource_type"}},"resource-sharing_resource_types":{"description":"Filter share resources by resource_types.","in":"query","name":"resource_types","schema":{"items":{"$ref":"#/components/schemas/resource-sharing_resource_type"},"type":"array"}},"resource-sharing_status":{"description":"Filter shares by status.","in":"query","name":"status","schema":{"$ref":"#/components/schemas/resource-sharing_share_status"}},"resource-sharing_target_type":{"description":"Filter shares by target_type.","in":"query","name":"target_type","schema":{"$ref":"#/components/schemas/resource-sharing_share_target_type"}},"secrets-store_direction":{"description":"Direction to sort objects","in":"query","name":"direction","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},"secrets-store_order":{"description":"Order secrets by values in the given field","in":"query","name":"order","schema":{"default":"created","enum":["name","comment","created","modified","status"],"type":"string"}},"secrets-store_page":{"description":"Page number","in":"query","name":"page","schema":{"example":2,"minimum":0,"multipleOf":1,"type":"integer"}},"secrets-store_per_page":{"description":"Number of objects to return per page","in":"query","name":"per_page","schema":{"example":20,"maximum":100,"minimum":0,"multipleOf":1,"type":"integer"}},"secrets-store_scopes_query":{"description":"Only secrets with the given scopes will be returned","explode":false,"in":"query","name":"scopes","schema":{"items":{"$ref":"#/components/schemas/secrets-store_scopes"},"type":"array"},"style":"form"},"secrets-store_search":{"description":"Search secrets using a filter string, filtering across name and comment","in":"query","name":"search","schema":{"type":"string"}},"smartshield_page":{"description":"Page number of paginated results.","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"number"}},"smartshield_per_page":{"description":"Maximum number of results per page. Must be a multiple of 5.","in":"query","name":"per_page","schema":{"default":25,"maximum":1000,"minimum":5,"type":"number"}},"teams-devices_devices_get_device_param_include":{"description":"Comma-separated list of additional information that should be included in the device response. Supported values are: \"last_seen_registration.policy\".\n","in":"query","name":"include","schema":{"type":"string"}},"teams-devices_devices_get_registration_param_include":{"description":"Comma-separated list of additional information that should be included in the registration response. Supported values are: \"policy\".\n","in":"query","name":"include","schema":{"type":"string"}},"teams-devices_devices_list_devices_param_active_registrations":{"description":"Include or exclude devices with active registrations. The default is \"only\" - return only devices with active registrations.","explode":false,"in":"query","name":"active_registrations","schema":{"enum":["include","only","exclude"],"type":"string"}},"teams-devices_devices_list_devices_param_cursor":{"description":"Opaque token indicating the starting position when requesting the next set of records. A cursor value can be obtained from the result_info.cursor field in the response.","explode":false,"in":"query","name":"cursor","schema":{"type":"string"}},"teams-devices_devices_list_devices_param_id":{"description":"Filter by a one or more device IDs.","explode":true,"in":"query","name":"id","schema":{"items":{"type":"string"},"type":"array"}},"teams-devices_devices_list_devices_param_include":{"description":"Comma-separated list of additional information that should be included in the device response. Supported values are: \"last_seen_registration.policy\".\n","in":"query","name":"include","schema":{"type":"string"}},"teams-devices_devices_list_devices_param_last_seen_user_email":{"description":"Filter by the last seen user's email.","explode":false,"in":"query","name":"last_seen_user.email","schema":{"type":"string"}},"teams-devices_devices_list_devices_param_per_page":{"description":"The maximum number of devices to return in a single response.","explode":false,"in":"query","name":"per_page","schema":{"format":"uint64","type":"integer"}},"teams-devices_devices_list_devices_param_search":{"description":"Search by device details.","explode":false,"in":"query","name":"search","schema":{"type":"string"}},"teams-devices_devices_list_devices_param_seen_after":{"description":"Filter by the last_seen timestamp - returns only devices last seen after this timestamp.","explode":false,"in":"query","name":"seen_after","schema":{"type":"string"}},"teams-devices_devices_list_devices_param_seen_before":{"description":"Filter by the last_seen timestamp - returns only devices last seen before this timestamp.","explode":false,"in":"query","name":"seen_before","schema":{"type":"string"}},"teams-devices_devices_list_devices_param_sort_by":{"description":"The device field to order results by.","explode":false,"in":"query","name":"sort_by","schema":{"enum":["name","id","client_version","last_seen_user.email","last_seen_at","active_registrations","created_at"],"type":"string"}},"teams-devices_devices_list_devices_param_sort_order":{"description":"Sort direction.","explode":false,"in":"query","name":"sort_order","schema":{"enum":["asc","desc"],"type":"string"}},"teams-devices_devices_list_registrations_param_cursor":{"description":"Opaque token indicating the starting position when requesting the next set of records. A cursor value can be obtained from the result_info.cursor field in the response.","explode":false,"in":"query","name":"cursor","schema":{"type":"string"}},"teams-devices_devices_list_registrations_param_device_id":{"description":"Filter by WARP device ID.","explode":false,"in":"query","name":"device.id","schema":{"type":"string"}},"teams-devices_devices_list_registrations_param_id":{"description":"Filter by registration ID.","explode":true,"in":"query","name":"id","schema":{"items":{"type":"string"},"type":"array"}},"teams-devices_devices_list_registrations_param_include":{"description":"Comma-separated list of additional information that should be included in the registration response. Supported values are: \"policy\".\n","in":"query","name":"include","schema":{"type":"string"}},"teams-devices_devices_list_registrations_param_per_page":{"description":"The maximum number of devices to return in a single response.","explode":false,"in":"query","name":"per_page","schema":{"format":"uint64","type":"integer"}},"teams-devices_devices_list_registrations_param_search":{"description":"Filter by registration details.","explode":false,"in":"query","name":"search","schema":{"type":"string"}},"teams-devices_devices_list_registrations_param_seen_after":{"description":"Filter by the last_seen timestamp - returns only registrations last seen after this timestamp.","explode":false,"in":"query","name":"seen_after","schema":{"type":"string"}},"teams-devices_devices_list_registrations_param_seen_before":{"description":"Filter by the last_seen timestamp - returns only registrations last seen before this timestamp.","explode":false,"in":"query","name":"seen_before","schema":{"type":"string"}},"teams-devices_devices_list_registrations_param_sort_by":{"description":"The registration field to order results by.","explode":false,"in":"query","name":"sort_by","schema":{"enum":["id","user.name","user.email","last_seen_at","created_at"],"type":"string"}},"teams-devices_devices_list_registrations_param_sort_order":{"description":"Sort direction.","explode":false,"in":"query","name":"sort_order","schema":{"enum":["asc","desc"],"type":"string"}},"teams-devices_devices_list_registrations_param_status":{"description":"Filter by registration status. Defaults to 'active'.","explode":false,"in":"query","name":"status","schema":{"enum":["active","all","revoked"],"type":"string"}},"teams-devices_devices_list_registrations_param_user_id":{"description":"Filter by user ID.","explode":true,"in":"query","name":"user.id","schema":{"items":{"type":"string"},"type":"array"}},"waitingroom_page":{"description":"Page number of paginated results.","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"number"}},"waitingroom_per_page":{"description":"Maximum number of results per page. Must be a multiple of 5.","in":"query","name":"per_page","schema":{"default":25,"maximum":1000,"minimum":5,"type":"number"}}},"requestBodies":{"api-shield_bulk-create-rules":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/api-shield_create-single-rule-request"},"type":"array"}}},"required":true},"api-shield_bulk-edit-rules":{"content":{"application/json":{"schema":{"items":{"allOf":[{"properties":{"id":{"description":"Rule ID this patch applies to","example":"0d9bf70c-92e1-4bb3-9411-34a3bcc59003","format":"uuid","maxLength":36,"type":"string","x-auditable":true}},"required":["id"],"type":"object"},{"$ref":"#/components/schemas/api-shield_edit-single-rule-request"}]},"type":"array"}}},"required":true},"api-shield_config-update":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_configuration"}}},"required":true},"api-shield_create-config":{"content":{"application/json":{"schema":{"properties":{"credentials":{"$ref":"#/components/schemas/api-shield_credentials"},"description":{"$ref":"#/components/schemas/api-shield_description"},"title":{"$ref":"#/components/schemas/api-shield_title"},"token_sources":{"$ref":"#/components/schemas/api-shield_token_sources"},"token_type":{"$ref":"#/components/schemas/api-shield_token_type"}},"required":["title","description","token_sources","token_type","credentials"],"type":"object"}}},"required":true},"api-shield_create-rule":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_create-single-rule-request"}}},"required":true},"api-shield_edit-config":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/api-shield_description"},"title":{"$ref":"#/components/schemas/api-shield_title"},"token_sources":{"$ref":"#/components/schemas/api-shield_token_sources"}},"type":"object"}}},"required":true},"api-shield_edit-rule":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_edit-single-rule-request"}}},"required":true},"api-shield_global_settings_edit":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_global_setting_change_base"}}},"required":true},"api-shield_global_settings_update":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_global_setting_change_base"},{"required":["validation_default_mitigation_action"],"type":"object"}],"type":"object"}}},"required":true},"api-shield_per_operation_setting_update":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_per_operation_setting_change_base"},{"required":["mitigation_action"],"type":"object"}],"type":"object"}}},"required":true},"api-shield_per_operation_settings_bulk_edit":{"content":{"application/json":{"schema":{"additionalProperties":{"description":"Operation ID to mitigation action mappings","properties":{"mitigation_action":{"description":"Mitigation actions are as follows:\n* `log` - log request when request does not conform to schema * `block` - deny access to the site when request does not conform to schema * `none` - skip running schema validation * null - clears any existing per-operation setting\n","enum":["none","log","block",null],"example":"block","nullable":true,"type":"string"}},"type":"object"},"example":{"3818d821-5901-4147-a474-f5f5aec1d54e":{"mitigation_action":"log"},"b17c8043-99a0-4202-b7d9-8f7cdbee02cd":{"mitigation_action":"block"}},"type":"object"}}},"required":true},"api-shield_preview-rules":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_selector"}}},"required":true},"api-shield_schema_create":{"content":{"application/json":{"schema":{"properties":{"kind":{"description":"The kind of the schema","enum":["openapi_v3"],"example":"openapi_v3","type":"string"},"name":{"description":"A human-readable name for the schema","example":"petstore schema","type":"string"},"source":{"description":"The raw schema, e.g., the OpenAPI schema, either as JSON or YAML","example":"\u003cschema file contents\u003e","type":"string"},"validation_enabled":{"description":"An indicator if this schema is enabled","type":"boolean"}},"required":["name","kind","source","validation_enabled"],"type":"object"}}},"required":true},"api-shield_schema_edit":{"content":{"application/json":{"schema":{"properties":{"validation_enabled":{"description":"Flag whether schema is enabled for validation.","type":"boolean"}},"type":"object"}}},"required":true},"api-shield_update-config-credentials":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_credentials"}}},"required":true},"pay-per-crawl_DaricConfig":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_DaricConfig"}}},"description":"Data for setting flag on zones","required":true,"x-auditable":true},"pay-per-crawl_ZonesCanBeEnabledPayload":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_ZonesCanBeEnabledPayload"}}},"description":"Data for setting flag on zones","required":true,"x-auditable":true},"realtimekit_AddParticipantBody":{"content":{"application/json":{"schema":{"properties":{"custom_participant_id":{"description":"A unique participant ID. You must specify a unique ID for the participant, for example, UUID, email address, and so on. ","type":"string"},"name":{"description":"(Optional) Name of the participant. ","example":"Mary Sue","nullable":true,"type":"string"},"picture":{"description":"(Optional) A URL to a picture to be used for the participant. ","example":"https://i.imgur.com/test.jpg","format":"uri","nullable":true,"type":"string"},"preset_name":{"default":"group_call_host","description":"Name of the preset to apply to this participant.","type":"string"}},"required":["preset_name","custom_participant_id"],"type":"object"}}}},"realtimekit_CreateMeetingBody":{"content":{"application/json":{"schema":{"properties":{"ai_config":{"$ref":"#/components/schemas/realtimekit_AIConfig"},"live_stream_on_start":{"default":false,"description":"Specifies if the meeting should start getting livestreamed on start.","nullable":true,"type":"boolean"},"persist_chat":{"default":false,"description":"If a meeting is set to persist_chat, meeting chat would remain for a week within the meeting space.","type":"boolean"},"preferred_region":{"description":"The region in which this meeting should be created.","enum":["ap-south-1","ap-southeast-1","us-east-1","eu-central-1",null],"nullable":true,"type":"string"},"record_on_start":{"default":false,"description":"Specifies if the meeting should start getting recorded as soon as someone joins the meeting.","nullable":true,"type":"boolean"},"recording_config":{"$ref":"#/components/schemas/realtimekit_RecordingConfig"},"session_keep_alive_time_in_secs":{"default":60,"description":"Time in seconds, for which a session remains active, after the last participant has left the meeting.","maximum":600,"minimum":60,"type":"number"},"summarize_on_end":{"default":false,"description":"Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.","type":"boolean"},"title":{"description":"Title of the meeting","nullable":true,"type":"string"}},"type":"object"}}},"description":"Create meeting body"},"realtimekit_CreatePollBody":{"content":{"application/json":{"schema":{"properties":{"anonymous":{"description":"if voters on a poll are anonymous","type":"boolean"},"hide_votes":{"description":"if votes on an option are visible before a person votes","type":"boolean"},"options":{"description":"Different options for the question","items":{"type":"string"},"type":"array"},"question":{"description":"Question of the poll","type":"string"}},"type":"object"}}},"description":"Request body for creating a new poll"},"realtimekit_CreatePresetBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/realtimekit_Preset"}}}},"realtimekit_EditParticipantBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"(Optional) Name of the participant.","example":"Jane Doe","nullable":true,"type":"string"},"picture":{"description":"(Optional) A URL to a picture to be used for the participant.","format":"uri","nullable":true,"type":"string"},"preset_name":{"description":"(Optional) Name of the preset to apply to this participant.","nullable":true,"type":"string"}},"type":"object"}}}},"realtimekit_KickParticipantsBody":{"content":{"application/json":{"schema":{"properties":{"custom_participant_ids":{"items":{"type":"string"},"type":"array"},"participant_ids":{"items":{"type":"string"},"type":"array"}},"type":"object"}}},"description":"Request body for kicking participants from an active session. Only one of `participant_id` or `custom_participant_id` is required."},"realtimekit_MuteAllParticipantsBody":{"content":{"application/json":{"schema":{"properties":{"allow_unmute":{"description":"if false, participants won't be able to unmute themselves after they are muted","type":"boolean"}},"type":"object"}}},"description":"Request body for muting all participants in an active session."},"realtimekit_StartRecording":{"content":{"application/json":{"examples":{"Example 1":{"value":{"allow_multiple_recordings":false,"audio_config":{"channel":"stereo","codec":"AAC","export_file":true},"file_name_prefix":"string","interactive_config":{"type":"ID3"},"max_seconds":60,"meeting_id":"97440c6a-140b-40a9-9499-b23fd7a3868a","realtimekit_bucket_config":{"enabled":true},"video_config":{"codec":"H264","export_file":true,"height":720,"watermark":{"position":"left top","size":{"height":1,"width":1},"url":"http://example.com"},"width":1280}}}},"schema":{"properties":{"allow_multiple_recordings":{"default":false,"description":"By default, a meeting allows only one recording to run at a time. Enabling the `allow_multiple_recordings` parameter to true allows you to initiate multiple recordings concurrently in the same meeting. This allows you to record separate videos of the same meeting with different configurations, such as portrait mode or landscape mode.","type":"boolean"},"audio_config":{"$ref":"#/components/schemas/realtimekit_AudioConfig"},"file_name_prefix":{"description":"Update the recording file name.","type":"string"},"interactive_config":{"$ref":"#/components/schemas/realtimekit_InteractiveConfig"},"max_seconds":{"description":"Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours.","maximum":86400,"minimum":60,"type":"integer"},"meeting_id":{"description":"ID of the meeting to record.","format":"uuid","type":"string"},"realtimekit_bucket_config":{"$ref":"#/components/schemas/realtimekit_realtimekitBucketConfig"},"rtmp_out_config":{"$ref":"#/components/schemas/realtimekit_LivestreamingConfig"},"storage_config":{"$ref":"#/components/schemas/realtimekit_StorageConfig"},"url":{"description":"Pass a custom url to record arbitary screen","format":"uri","type":"string"},"video_config":{"$ref":"#/components/schemas/realtimekit_VideoConfig"}},"type":"object"}}}},"realtimekit_StartTrackRecordingBody":{"content":{"application/json":{"examples":{"Example 1":{"value":{"layers":{"default":{"file_name_prefix":"string","outputs":[{"type":"REALTIMEKIT_BUCKET"}]},"default-video":{"file_name_prefix":"string","outputs":[{"type":"REALTIMEKIT_BUCKET"}]}},"max_seconds":60,"meeting_id":"string"}}},"schema":{"properties":{"layers":{"additionalProperties":{"$ref":"#/components/schemas/realtimekit_TrackConfigLayer"},"type":"object"},"max_seconds":{"description":"Maximum seconds this recording should be active for (beta)","type":"number"},"meeting_id":{"description":"ID of the meeting to record.","type":"string"}},"required":["layers"],"type":"object"}}},"description":"For now only \"default\" layer key is supported."},"realtimekit_UpdateMeetingBody":{"content":{"application/json":{"schema":{"properties":{"ai_config":{"$ref":"#/components/schemas/realtimekit_AIConfig"},"live_stream_on_start":{"default":false,"description":"Specifies if the meeting should start getting livestreamed on start.","type":"boolean"},"persist_chat":{"default":false,"description":"If a meeting is updated to persist_chat, meeting chat would remain for a week within the meeting space.","type":"boolean"},"preferred_region":{"description":"The region in which this meeting should be created.","enum":["ap-south-1","ap-southeast-1","us-east-1","eu-central-1"],"type":"string"},"record_on_start":{"default":false,"description":"Specifies if the meeting should start getting recorded as soon as someone joins the meeting.","type":"boolean"},"session_keep_alive_time_in_secs":{"default":60,"description":"Time in seconds, for which a session remains active, after the last participant has left the meeting.","maximum":600,"minimum":60,"type":"number"},"status":{"description":"Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.","enum":["ACTIVE","INACTIVE"],"example":"INACTIVE","type":"string"},"summarize_on_end":{"default":false,"description":"Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.","type":"boolean"},"title":{"description":"Title of the meeting","type":"string"}},"type":"object"}}},"description":"Create meeting body"},"realtimekit_UpdatePresetBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/realtimekit_UpdatePreset"}}}},"rulesets_CreateRuleset":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_Ruleset"},{"properties":{"kind":{"$ref":"#/components/schemas/rulesets_RulesetKind"},"phase":{"$ref":"#/components/schemas/rulesets_RulesetPhase"},"rules":{"$ref":"#/components/schemas/rulesets_RequestRules"}},"required":["name","kind","phase"]}]}}},"required":true},"rulesets_ManagedTransforms":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_ManagedTransforms"}}},"required":true},"rulesets_Rule":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_RequestRule"},{"properties":{"position":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/rulesets_RulePosition"},{"properties":{"before":{"description":"The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top.","example":"da5e8e506c8e7877fe06cdf4c41add54","pattern":"^[0-9a-f]{32}$","title":"Before","type":"string"}},"title":"Before Position"}]},{"allOf":[{"$ref":"#/components/schemas/rulesets_RulePosition"},{"properties":{"after":{"description":"The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom.","example":"5bccdbb2a5142cd25cad8591255bd209","pattern":"^[0-9a-f]{32}$","title":"After","type":"string"}},"title":"After Position"}]},{"allOf":[{"$ref":"#/components/schemas/rulesets_RulePosition"},{"properties":{"index":{"description":"An index at which to place the rule, where index 1 is the first rule.","example":1,"minimum":1,"title":"Index","type":"integer"}},"title":"Index Position"}]}]}}}]}}},"required":true},"rulesets_UpdateEntrypointRuleset":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_Ruleset"},{"properties":{"rules":{"$ref":"#/components/schemas/rulesets_RequestRules"}}}]}}},"required":true},"rulesets_UpdateRuleset":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_Ruleset"},{"properties":{"kind":{"$ref":"#/components/schemas/rulesets_RulesetKind"},"phase":{"$ref":"#/components/schemas/rulesets_RulesetPhase"},"rules":{"$ref":"#/components/schemas/rulesets_RequestRules"}}}]}}},"required":true},"rulesets_UrlNormalization":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_UrlNormalization"}}},"required":true},"snippets_Snippet":{"content":{"multipart/form-data":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/snippets_SnippetFiles"},"description":"A snippet object.","properties":{"metadata":{"description":"Metadata about the snippet.","properties":{"main_module":{"$ref":"#/components/schemas/snippets_SnippetMainModule"}},"required":["main_module"],"title":"Metadata","type":"object"}},"required":["metadata","files"],"title":"Snippet","type":"object"}}},"required":true},"snippets_SnippetRules":{"content":{"application/json":{"schema":{"description":"A snippet rules object.","properties":{"rules":{"$ref":"#/components/schemas/snippets_SnippetRules"}},"required":["rules"],"title":"Snippet Rules","type":"object"}}},"required":true},"workers_script_upload":{"content":{"application/javascript":{"schema":{"description":"Raw javascript content comprising a Worker. Must be in service worker syntax.","example":"addEventListener('fetch', (event) =\u003e event.respondWith(new Response('OK')))","type":"string"}},"multipart/form-data":{"encoding":{"files":{"contentType":"application/javascript+module, text/javascript+module, application/javascript, text/javascript, text/x-python, text/x-python-requirement, application/wasm, text/plain, application/octet-stream, application/source-map"},"metadata":{"contentType":"application/json"}},"schema":{"$ref":"#/components/schemas/workers_multipart-script"}},"text/javascript":{"schema":{"description":"Raw javascript content comprising a Worker. Must be in service worker syntax.","example":"addEventListener('fetch', (event) =\u003e event.respondWith(new Response('OK')))","type":"string"}}},"required":true},"workers_version-post":{"content":{"multipart/form-data":{"encoding":{"files":{"contentType":"application/javascript+module, text/javascript+module, application/javascript, text/javascript, `text/x-python`, text/x-python-requirement, application/wasm, text/plain, application/octet-stream, application/source-map"},"metadata":{"contentType":"application/json"}},"schema":{"properties":{"files":{"description":"An array of modules (often JavaScript files) comprising a Worker script. At least one module must be present and referenced in the metadata as `main_module` or `body_part` by filename.\u003cbr/\u003ePossible Content-Type(s) are: `application/javascript+module`, `text/javascript+module`, `application/javascript`, `text/javascript`, `text/x-python`, `text/x-python-requirement`, `application/wasm`, `text/plain`, `application/octet-stream`, `application/source-map`.","items":{"format":"binary","type":"string"},"type":"array","x-stainless-collection-type":"set"},"metadata":{"description":"JSON-encoded metadata about the uploaded parts and Worker configuration.","properties":{"annotations":{"properties":{"workers/alias":{"description":"Associated alias for a version.","example":"staging","maxLength":63,"type":"string"},"workers/message":{"description":"Human-readable message about the version. Truncated to 100 bytes.","example":"Fixed worker code.","maxLength":100,"type":"string"},"workers/tag":{"description":"User-provided identifier for the version.","example":"any-identifier-from-external-system","maxLength":25,"type":"string"}},"type":"object"},"bindings":{"$ref":"#/components/schemas/workers_bindings"},"compatibility_date":{"$ref":"#/components/schemas/workers_compatibility_date"},"compatibility_flags":{"$ref":"#/components/schemas/workers_compatibility_flags"},"keep_bindings":{"description":"List of binding types to keep from previous_upload.","items":{"type":"string"},"type":"array","x-stainless-collection-type":"set"},"main_module":{"description":"Name of the uploaded file that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker, which is required for Version Upload.","example":"worker.js","type":"string"},"usage_model":{"$ref":"#/components/schemas/workers_usage_model"}},"required":["main_module"],"type":"object"}},"required":["metadata"],"type":"object"}}},"required":true}},"responses":{"api-shield_bulk-create-rules-success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/api-shield_Rule"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"OK"},"api-shield_bulk-edit-rules-success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/api-shield_Rule"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"OK"},"api-shield_config-get-success":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_configuration-single-response"}}},"description":"Retrieve information about specific configuration properties response"},"api-shield_config-update-success":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_configuration-single-response"}}},"description":"Set configuration properties response"},"api-shield_create-config-success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_TokenConfiguration"}},"required":["result"],"type":"object"}]}}},"description":"OK"},"api-shield_create-rule-success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_Rule"}},"required":["result"],"type":"object"}]}}},"description":"OK"},"api-shield_delete-config-success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/api-shield_schemas-uuid"}},"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"OK"},"api-shield_delete-rule-success":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-single-obj"}}},"description":"OK"},"api-shield_edit-config-success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"properties":{"description":{"$ref":"#/components/schemas/api-shield_description"},"title":{"$ref":"#/components/schemas/api-shield_title"},"token_sources":{"$ref":"#/components/schemas/api-shield_token_sources"}},"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"OK"},"api-shield_edit-rule-success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_Rule"}},"required":["result"],"type":"object"}]}}},"description":"OK"},"api-shield_generic-failure":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Retrieve information about specific configuration properties response failure"},"api-shield_generic_failure":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Failure"},"api-shield_get-config-success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_TokenConfiguration"}},"required":["result"],"type":"object"}]}}},"description":"OK"},"api-shield_get-rule-success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_Rule"}},"required":["result"],"type":"object"}]}}},"description":"OK"},"api-shield_global_settings_edit_success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_global_settings"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Success"},"api-shield_global_settings_get_success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_global_settings"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Success"},"api-shield_global_settings_update_success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_global_settings"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Success"},"api-shield_list-configs-success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/api-shield_TokenConfiguration"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"OK"},"api-shield_list-rules-success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/api-shield_Rule"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"OK"},"api-shield_per_operation_setting_get_success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_per_operation_setting"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Success"},"api-shield_per_operation_setting_update_success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_per_operation_setting"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Successfully updated"},"api-shield_per_operation_settings_bulk_edit_success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_per_operation_bulk_settings"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Update multiple operation-level schema validation settings response"},"api-shield_per_operation_settings_delete_success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"properties":{"operation_id":{"$ref":"#/components/schemas/api-shield_schemas-uuid"}},"type":"object"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Successfully deleted"},"api-shield_per_operation_settings_list_success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/api-shield_per_operation_setting"},"type":"array"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Success"},"api-shield_preview-rules-success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"properties":{"available_hosts":{"description":"All hostnames on zone used by operations","items":{"$ref":"#/components/schemas/api-shield_host"},"type":"array","uniqueItems":true},"excluded":{"description":"Number of operations with `excluded` `state`","example":40,"type":"integer","x-auditable":true},"ignored":{"description":"Number of operations with `ignored` `state`","example":10,"type":"integer","x-auditable":true},"included":{"description":"Number of operations with `included` `state`","example":50,"type":"integer","x-auditable":true},"operations":{"items":{"properties":{"endpoint":{"$ref":"#/components/schemas/api-shield_endpoint"},"host":{"$ref":"#/components/schemas/api-shield_host"},"last_updated":{"$ref":"#/components/schemas/api-shield_schemas-timestamp"},"method":{"$ref":"#/components/schemas/api-shield_method"},"operation_id":{"$ref":"#/components/schemas/api-shield_schemas-uuid"},"state":{"$ref":"#/components/schemas/api-shield_selector-operation-state"}},"type":"object"},"type":"array"},"selected_hosts":{"description":"Hostnames of `included` operations","items":{"$ref":"#/components/schemas/api-shield_host"},"type":"array","uniqueItems":true},"total":{"description":"Number of operations on zone","example":100,"type":"integer","x-auditable":true}},"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"OK"},"api-shield_schema_create_failure":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common-failure"},{"properties":{"errors":{"description":"Describes errors in the schema that prohibited accepting the schema.","items":{"$ref":"#/components/schemas/api-shield_schema_issue_notification"},"type":"array"},"messages":{"description":"Describes issues in the schema and how they were resolved to accept the schema.","items":{"$ref":"#/components/schemas/api-shield_schema_issue_notification"},"type":"array"}},"required":["errors"],"type":"object"}],"type":"object"}}},"description":"Failed uploaded the schema"},"api-shield_schema_create_success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_public_schema_success_result"},{"properties":{"errors":{"description":"Describes errors in the schema that prohibited accepting the schema.","items":{"$ref":"#/components/schemas/api-shield_schema_issue_notification"},"type":"array"},"messages":{"description":"Describes issues in the schema and how they were resolved to accept the schema.","items":{"$ref":"#/components/schemas/api-shield_schema_issue_notification"},"type":"array"}},"required":["messages"],"type":"object"}],"type":"object"}}},"description":"Successfully uploaded the schema"},"api-shield_schema_delete_success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-single"},{"properties":{"result":{"properties":{"id":{"description":"The ID of the schema that was just deleted","format":"uuid","type":"string","x-auditable":true}},"required":["id"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"Success"},"api-shield_schema_edit_success":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_public_schema_success_result"}}},"description":"Success"},"api-shield_schema_get_success":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_public_schema_success_result"}}},"description":"Success"},"api-shield_schema_hosts_get_success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/api-shield_schema_hosts"},"type":"array"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Success"},"api-shield_schemas_extract_operations_get_success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"items":{"anyOf":[{"$ref":"#/components/schemas/api-shield_operation"},{"$ref":"#/components/schemas/api-shield_basic_operation"}]},"type":"array"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"All operations in the schema"},"api-shield_schemas_list_success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/api-shield_public_schema"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"Success"},"api-shield_update-config-credentials-success":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"$ref":"#/components/schemas/api-shield_credentials"}]}}},"description":"OK"},"brand-protection-api_DEFAULT_ERROR":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand-protection-api_Error"}}},"description":"Default error response"},"brand-protection-api_UNPROCESSABLE_CONTENT":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand-protection-api_Error"}}},"description":"Unprocessable Content"},"builds_BadRequest":{"content":{"application/json":{"example":{"errors":[{"code":12002,"message":"Invalid request body"}],"messages":[],"result":null,"success":false},"schema":{"$ref":"#/components/schemas/builds_ErrorResponse"}}},"description":"Invalid request"},"builds_NotFound":{"content":{"application/json":{"example":{"errors":[{"code":12000,"message":"Not found"}],"messages":[],"result":null,"success":false},"schema":{"$ref":"#/components/schemas/builds_ErrorResponse"}}},"description":"Resource not found"},"builds_SuccessEmpty":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":null,"success":true},"schema":{"$ref":"#/components/schemas/builds_APIResponse"}}},"description":"Operation successful"},"builds_Unauthorized":{"content":{"application/json":{"example":{"errors":[{"code":12005,"message":"Missing token from authorization header"}],"messages":[],"result":null,"success":false},"schema":{"$ref":"#/components/schemas/builds_ErrorResponse"}}},"description":"Authentication required"},"email-security_ClientError":{"content":{"application/json":{"schema":{"properties":{"errors":{"example":[{"code":7003,"message":"No route for the URI"}],"items":{"$ref":"#/components/schemas/email-security_Message"},"type":"array"},"messages":{"example":[],"items":{"$ref":"#/components/schemas/email-security_Message"},"type":"array"},"result":{"nullable":true,"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors","messages"],"type":"object"}}},"description":"Client Error"},"realtimekit_AddParticipant":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/realtimekit_GenericSuccessResponse"},{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/realtimekit_Participant"},{"properties":{"token":{"description":"The participant's auth token that can be used for joining a meeting from the client side.","type":"string"}},"required":["token"],"type":"object"}]}},"type":"object"}]}}},"description":"Success response"},"realtimekit_CreatePoll":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"action":{"type":"string"},"poll":{"$ref":"#/components/schemas/realtimekit_Poll"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"response for creating a poll"},"realtimekit_DeleteParticipant":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/realtimekit_GenericSuccessResponse"},{"properties":{"data":{"properties":{"created_at":{"description":"Timestamp this object was created at. The time is returned in ISO format.","format":"date-time","type":"string"},"custom_participant_id":{"description":"A unique participant ID generated by the client.","type":"string"},"preset_id":{"description":"ID of the preset applied to this participant.","format":"uuid","type":"string"},"updated_at":{"description":"Timestamp this object was updated at. The time is returned in ISO format.","format":"date-time","type":"string"}},"required":["custom_participant_id","preset_id","created_at","updated_at"],"type":"object"}},"type":"object"}]}}},"description":"Success response"},"realtimekit_GenericError":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/realtimekit_GenericErrorResponse"}}},"description":"Failure response"},"realtimekit_GetActiveRecording":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/realtimekit_GenericSuccessResponse"},{"properties":{"data":{"$ref":"#/components/schemas/realtimekit_Recording"}},"required":["data"],"type":"object"}]}}},"description":"Success response"},"realtimekit_GetActiveSession":{"content":{"application/json":{"examples":{"activeSessionSuccess":{"$ref":"#/components/examples/realtimekit_GetActiveSessionSuccessResponse"}},"schema":{"properties":{"data":{"$ref":"#/components/schemas/realtimekit_ActiveSession"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Active Session Success response"},"realtimekit_GetActiveSessionNotFound":{"content":{"application/json":{"examples":{"activeSessionNotFound":{"$ref":"#/components/examples/realtimekit_GetActiveSessionNotFoundResponse"}},"schema":{"$ref":"#/components/schemas/realtimekit_GenericErrorResponse"}}},"description":"Active Session is not found for the given meetingId"},"realtimekit_GetAllMeetings":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/realtimekit_PagingResponse"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/realtimekit_Meeting"},"type":"array"}},"type":"object"}]}}},"description":"Success response"},"realtimekit_GetAllParticipants":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/realtimekit_PagingResponse"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/realtimekit_Participant"},"type":"array"}},"type":"object"}]}}},"description":"Success response"},"realtimekit_GetAllPresets":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/realtimekit_PagingResponse"},{"properties":{"data":{"items":{"$ref":"#/components/schemas/realtimekit_PresetListItem"},"type":"array"}},"type":"object"}]}}},"description":"Example response"},"realtimekit_GetDaywiseStats":{"content":{"application/json":{"examples":{"DaywiseStatsSuccess":{"$ref":"#/components/examples/realtimekit_DaywiseStatsSuccessResponse"}},"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/realtimekit_DaywiseStats"},"type":"array"},"succes":{"type":"boolean"}},"type":"object"}}},"description":"Returns daywise analytics of an App"},"realtimekit_GetMeeting":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/realtimekit_GenericSuccessResponse"},{"allOf":[{"properties":{"data":{"$ref":"#/components/schemas/realtimekit_Meeting"}},"type":"object"},{"properties":{"data":{"properties":{"recording_config":{"$ref":"#/components/schemas/realtimekit_RecordingConfig"}},"type":"object"}},"type":"object"},{"properties":{"data":{"properties":{"ai_config":{"$ref":"#/components/schemas/realtimekit_AIConfig"}},"type":"object"}},"type":"object"}],"type":"object"},{"type":"object"}]}}},"description":"Success Response"},"realtimekit_GetOverallStats":{"content":{"application/json":{"examples":{"OverallStatsSuccess":{"$ref":"#/components/examples/realtimekit_OverallStatsSuccessResponse"}},"schema":{"properties":{"data":{"$ref":"#/components/schemas/realtimekit_OverallStats"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Returns complete analytics of an App"},"realtimekit_GetParticipant":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/realtimekit_GenericSuccessResponse"},{"properties":{"data":{"$ref":"#/components/schemas/realtimekit_Participant"}},"required":["data"],"type":"object"}]}}},"description":"Success response"},"realtimekit_GetParticipantDataFromPeerId":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"participant":{"properties":{"created_at":{"type":"string"},"custom_participant_id":{"type":"string"},"display_name":{"type":"string"},"duration":{"type":"number"},"id":{"type":"string"},"joined_at":{"type":"string"},"left_at":{"type":"string"},"peer_report":{"properties":{"metadata":{"properties":{"audio_devices_updates":{"items":{"type":"object"},"type":"array"},"browser_metadata":{"properties":{"browser":{"type":"string"},"browser_version":{"type":"string"},"engine":{"type":"string"},"user_agent":{"type":"string"},"webgl_support":{"type":"string"}},"type":"object"},"candidate_pairs":{"properties":{"consuming_transport":{"items":{"type":"object"},"type":"array"},"producing_transport":{"items":{"properties":{"available_outgoing_bitrate":{"type":"integer"},"bytes_discarded_on_send":{"type":"integer"},"bytes_received":{"type":"integer"},"bytes_sent":{"type":"integer"},"current_round_trip_time":{"type":"number"},"last_packet_received_timestamp":{"type":"integer"},"last_packet_sent_timestamp":{"type":"integer"},"local_candidate_address":{"type":"string"},"local_candidate_id":{"type":"string"},"local_candidate_network_type":{"type":"string"},"local_candidate_port":{"type":"integer"},"local_candidate_protocol":{"type":"string"},"local_candidate_related_address":{"type":"string"},"local_candidate_related_port":{"type":"integer"},"local_candidate_type":{"type":"string"},"nominated":{"type":"boolean"},"packets_discarded_on_send":{"type":"integer"},"packets_received":{"type":"integer"},"packets_sent":{"type":"integer"},"remote_candidate_address":{"type":"string"},"remote_candidate_id":{"type":"string"},"remote_candidate_port":{"type":"integer"},"remote_candidate_protocol":{"type":"string"},"remote_candidate_type":{"type":"string"},"total_round_trip_time":{"type":"number"}},"type":"object"},"type":"array"}},"type":"object"},"device_info":{"properties":{"cpus":{"type":"integer"},"is_mobile":{"type":"boolean"},"os":{"type":"string"},"os_version":{"type":"string"}},"type":"object"},"events":{"items":{"properties":{"name":{"type":"string"},"timestamp":{"type":"string"}},"type":"object"},"type":"array"},"ip_information":{"properties":{"asn":{"properties":{"asn":{"type":"string"}},"type":"object"},"city":{"type":"string"},"country":{"type":"string"},"ipv4":{"type":"string"},"region":{"type":"string"},"timezone":{"type":"string"}},"type":"object"},"pc_metadata":{"items":{"properties":{"effective_network_type":{"type":"string"},"reflexive_connectivity":{"type":"boolean"},"relay_connectivity":{"type":"boolean"},"timestamp":{"type":"string"},"turn_connectivity":{"type":"boolean"}},"type":"object"},"type":"array"},"room_view_type":{"type":"string"},"sdk_name":{"type":"string"},"sdk_version":{"type":"string"},"selected_device_updates":{"items":{"type":"object"},"type":"array"},"speaker_devices_updates":{"items":{"type":"object"},"type":"array"},"video_devices_updates":{"items":{"type":"object"},"type":"array"}},"type":"object"},"quality":{"properties":{"audio_consumer":{"items":{"type":"object"},"type":"array"},"audio_consumer_cumulative":{"type":"object"},"audio_producer":{"items":{"properties":{"bytes_sent":{"type":"integer"},"jitter":{"type":"integer"},"mid":{"type":"string"},"mos_quality":{"type":"integer"},"packets_lost":{"type":"integer"},"packets_sent":{"type":"integer"},"producer_id":{"type":"string"},"rtt":{"type":"number"},"ssrc":{"type":"integer"},"timestamp":{"type":"string"}},"type":"object"},"type":"array"},"audio_producer_cumulative":{"properties":{"packet_loss":{"properties":{"10_or_greater_event_fraction":{"type":"integer"},"25_or_greater_event_fraction":{"type":"integer"},"50_or_greater_event_fraction":{"type":"integer"},"5_or_greater_event_fraction":{"type":"integer"},"avg":{"type":"integer"}},"type":"object"},"quality_mos":{"properties":{"avg":{"type":"integer"},"p50":{"type":"integer"},"p75":{"type":"integer"},"p90":{"type":"integer"}},"type":"object"},"rtt":{"properties":{"100ms_or_greater_event_fraction":{"type":"number"},"250ms_or_greater_event_fraction":{"type":"number"},"500ms_or_greater_event_fraction":{"type":"number"},"avg":{"type":"number"}},"type":"object"}},"type":"object"},"screenshare_audio_consumer":{"items":{"type":"object"},"type":"array"},"screenshare_audio_consumer_cumulative":{"type":"object"},"screenshare_audio_producer":{"items":{"type":"object"},"type":"array"},"screenshare_audio_producer_cumulative":{"type":"object"},"screenshare_video_consumer":{"items":{"type":"object"},"type":"array"},"screenshare_video_consumer_cumulative":{"type":"object"},"screenshare_video_producer":{"items":{"type":"object"},"type":"array"},"screenshare_video_producer_cumulative":{"type":"object"},"video_consumer":{"items":{"type":"object"},"type":"array"},"video_consumer_cumulative":{"type":"object"},"video_producer":{"items":{"type":"object"},"type":"array"},"video_producer_cumulative":{"type":"object"}},"type":"object"}},"type":"object"},"peer_stats":{"properties":{"device_info":{"properties":{"browser":{"type":"string"},"browser_version":{"type":"string"},"cpus":{"type":"integer"},"engine":{"type":"string"},"is_mobile":{"type":"boolean"},"os":{"type":"string"},"os_version":{"type":"string"},"sdk_name":{"type":"string"},"sdk_version":{"type":"string"},"user_agent":{"type":"string"},"webgl_support":{"type":"string"}},"type":"object"},"events":{"items":{"properties":{"metadata":{"properties":{"connection_info":{"properties":{"backend_r_t_t":{"type":"number"},"connectivity":{"properties":{"host":{"type":"boolean"},"reflexive":{"type":"boolean"},"relay":{"type":"boolean"}},"type":"object"},"effective_network_type":{"type":"string"},"fractional_loss":{"type":"integer"},"ip_details":{"properties":{"asn":{"properties":{"asn":{"type":"string"}},"type":"object"},"city":{"type":"string"},"country":{"type":"string"},"ip":{"type":"string"},"loc":{"type":"string"},"postal":{"type":"string"},"region":{"type":"string"},"timezone":{"type":"string"}},"type":"object"},"jitter":{"type":"integer"},"location":{"properties":{"coords":{"properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"type":"object"}},"type":"object"},"r_t_t":{"type":"number"},"throughput":{"type":"integer"},"turn_connectivity":{"type":"boolean"}},"type":"object"}},"type":"object"},"timestamp":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"ip_information":{"properties":{"asn":{"properties":{"asn":{"type":"string"}},"type":"object"},"city":{"type":"string"},"country":{"type":"string"},"ip_location":{"type":"string"},"ipv4":{"type":"string"},"org":{"type":"string"},"region":{"type":"string"},"timezone":{"type":"string"}},"type":"object"},"precall_network_information":{"properties":{"backend_rtt":{"type":"number"},"effective_networktype":{"type":"string"},"fractional_loss":{"type":"integer"},"jitter":{"type":"integer"},"reflexive_connectivity":{"type":"boolean"},"relay_connectivity":{"type":"boolean"},"rtt":{"type":"number"},"throughput":{"type":"integer"},"turn_connectivity":{"type":"boolean"}},"type":"object"}},"type":"object"},"quality_stats":{"properties":{"audio_bandwidth":{"type":"integer"},"audio_stats":{"items":{"type":"object"},"type":"array"},"average_quality":{"type":"integer"},"end":{"nullable":true,"type":"string"},"first_audio_packet_received":{"type":"string"},"first_video_packet_received":{"type":"string"},"last_audio_packet_received":{"type":"string"},"last_video_packet_received":{"type":"string"},"peer_ids":{"items":{"type":"string"},"type":"array"},"start":{"nullable":true,"type":"string"},"total_audio_packets":{"type":"integer"},"total_audio_packets_lost":{"type":"integer"},"total_video_packets":{"type":"integer"},"total_video_packets_lost":{"type":"integer"},"video_bandwidth":{"type":"integer"},"video_stats":{"items":{"type":"object"},"type":"array"}},"type":"object"},"role":{"type":"string"},"updated_at":{"type":"string"},"user_id":{"type":"string"}},"type":"object"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Returns details of a participant (using peer id) along with callstats data."},"realtimekit_GetParticipantDetails":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"participant":{"allOf":[{"$ref":"#/components/schemas/realtimekit_ParticipantsList"},{"$ref":"#/components/schemas/realtimekit_ParticipantPeerStats"},{"$ref":"#/components/schemas/realtimekit_ParticipantQualityStats"}]}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Returns details of a participant along with callstats data."},"realtimekit_GetPresetBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/realtimekit_GenericSuccessResponse"},{"properties":{"data":{"allOf":[{"properties":{"id":{"description":"ID of the preset","format":"uuid","type":"string"}},"required":["id"],"type":"object"},{"$ref":"#/components/schemas/realtimekit_Preset"}]}},"required":["data"],"type":"object"}]}}},"description":"Success response"},"realtimekit_GetRecording":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/realtimekit_GenericSuccessResponse"},{"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/realtimekit_Recording"},{"properties":{"start_reason":{"$ref":"#/components/schemas/realtimekit_startReason"},"stop_reason":{"$ref":"#/components/schemas/realtimekit_stopReason"},"storage_config":{"$ref":"#/components/schemas/realtimekit_StorageConfig"}},"type":"object"}]}},"type":"object"}]}}},"description":"Success response"},"realtimekit_GetRecordings":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/realtimekit_PagingResponse"},{"properties":{"data":{"items":{"allOf":[{"$ref":"#/components/schemas/realtimekit_Recording"},{"properties":{"storage_config":{"$ref":"#/components/schemas/realtimekit_StorageConfig"}},"type":"object"},{"properties":{"meeting":{"$ref":"#/components/schemas/realtimekit_Meeting"}},"type":"object"}]},"type":"array"}},"type":"object"}]}}},"description":"Success response"},"realtimekit_GetSessionChat":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/realtimekit_ChatMessage"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Returns all chat messages of a session."},"realtimekit_GetSessionDetails":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"session":{"$ref":"#/components/schemas/realtimekit_ActiveSession"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Get details about a particular session"},"realtimekit_GetSessionParticipants":{"content":{"application/json":{"examples":{"ParticipantListSuccess":{"$ref":"#/components/examples/realtimekit_ParticipantListSuccess"},"ParticipantListWithPeerStatsSuccess":{"$ref":"#/components/examples/realtimekit_ParticipantListWithPeerEventSucces"}},"schema":{"properties":{"data":{"properties":{"participants":{"items":{"$ref":"#/components/schemas/realtimekit_ParticipantsList"},"type":"array"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Get participants list of a particular session"},"realtimekit_GetSessionTranscript":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/realtimekit_Transcript"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Returns the complete transcript of a session."},"realtimekit_GetSessionTranscriptSummary":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/realtimekit_TranscriptSummary"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Returns a complete summary of transcripts of a session."},"realtimekit_GetSessions":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"sessions":{"items":{"$ref":"#/components/schemas/realtimekit_ActiveSession"},"type":"array"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Get all sessions success response"},"realtimekit_KickAllParticipants":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"action":{"type":"string"},"kicked_participants_count":{"type":"number"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Kick all participants from a meeting"},"realtimekit_KickParticipants":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"action":{"type":"string"},"participants":{"items":{"$ref":"#/components/schemas/realtimekit_SessionParticipant"},"type":"array"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Kick participants success response"},"realtimekit_MuteAllParticipants":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"action":{"type":"string"},"muted_participants_count":{"type":"number"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Mute all participants of a meeting"},"realtimekit_MuteParticipants":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"action":{"type":"string"},"participants":{"items":{"$ref":"#/components/schemas/realtimekit_SessionParticipant"},"type":"array"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Mute one or more participants of a meeting"},"realtimekit_ParticipantNotFound":{"content":{"application/json":{"examples":{"participantNotFound":{"$ref":"#/components/examples/realtimekit_ParticipantNotFoundResponse"}},"schema":{"$ref":"#/components/schemas/realtimekit_GenericErrorResponse"}}},"description":"No participant found for the given `participant_id` or `custom_participant_id`"},"realtimekit_RegenToken":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/realtimekit_GenericSuccessResponse"},{"properties":{"data":{"properties":{"token":{"description":"Regenerated participant's authentication token.","type":"string"}},"required":["token"],"type":"object"}},"required":["data"],"type":"object"}]}}},"description":"Example response"},"rulesets_Empty":{"description":"An empty response."},"rulesets_Failure":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_Response"},{"properties":{"result":{"enum":[null]},"success":{"enum":[false]}}}]}}},"description":"A failure response."},"rulesets_ManagedTransforms":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_Response"},{"properties":{"errors":{"enum":[[]]},"result":{"$ref":"#/components/schemas/rulesets_ManagedTransforms"},"success":{"enum":[true]}}}]}}},"description":"A Managed Transforms response."},"rulesets_Ruleset":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_Response"},{"properties":{"errors":{"enum":[[]]},"result":{"allOf":[{"$ref":"#/components/schemas/rulesets_Ruleset"},{"properties":{"kind":{"$ref":"#/components/schemas/rulesets_RulesetKind"},"phase":{"$ref":"#/components/schemas/rulesets_RulesetPhase"},"rules":{"$ref":"#/components/schemas/rulesets_ResponseRules"}},"required":["name","kind","phase","rules"]}]},"success":{"enum":[true]}}}]}}},"description":"A ruleset response."},"rulesets_Rulesets":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_Response"},{"properties":{"errors":{"enum":[[]]},"result":{"description":"A list of rulesets. The returned information will not include the rules in each ruleset.","items":{"allOf":[{"$ref":"#/components/schemas/rulesets_Ruleset"},{"properties":{"kind":{"$ref":"#/components/schemas/rulesets_RulesetKind"},"phase":{"$ref":"#/components/schemas/rulesets_RulesetPhase"}},"required":["name","kind","phase"]}]},"title":"Rulesets","type":"array"},"result_info":{"$ref":"#/components/schemas/rulesets_ResultInfo"},"success":{"enum":[true]}}}]}}},"description":"A rulesets response."},"rulesets_UrlNormalization":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_Response"},{"properties":{"errors":{"enum":[[]]},"result":{"$ref":"#/components/schemas/rulesets_UrlNormalization"},"success":{"enum":[true]}}}]}}},"description":"A URL Normalization response."},"snippets_Failure":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snippets_Response"},{"properties":{"result":{"enum":[null],"x-auditable":true},"success":{"enum":[false]}}}]}}},"description":"A failure response."},"snippets_Null":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snippets_Response"},{"properties":{"errors":{"enum":[[]]},"result":{"enum":[null],"x-auditable":true},"success":{"enum":[true]}}}]}}},"description":"A null response."},"snippets_Snippet":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snippets_Response"},{"properties":{"errors":{"enum":[[]]},"result":{"$ref":"#/components/schemas/snippets_Snippet"},"success":{"enum":[true]}}}]}}},"description":"A snippet response."},"snippets_SnippetContent":{"content":{"multipart/form-data":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/snippets_SnippetFiles"},"description":"A snippet content response object.","title":"Snippet Content Response","type":"object"}}},"description":"A snippet content response.","headers":{"cf-entrypoint":{"schema":{"$ref":"#/components/schemas/snippets_SnippetMainModule"}}}},"snippets_SnippetRules":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snippets_Response"},{"properties":{"errors":{"enum":[[]]},"result":{"$ref":"#/components/schemas/snippets_SnippetRules"},"success":{"enum":[true]}}}]}}},"description":"A snippet rules response."},"snippets_Snippets":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snippets_Response"},{"properties":{"errors":{"enum":[[]]},"result":{"description":"A list of snippets.","items":{"$ref":"#/components/schemas/snippets_Snippet"},"title":"Snippets","type":"array"},"result_info":{"$ref":"#/components/schemas/snippets_ResultInfo"},"success":{"enum":[true]}}}]}}},"description":"A snippets response."},"workers_200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_script-response-upload-single"},{"example":{"errors":[],"messages":[],"result":{"created_on":"2022-05-05T05:15:11.602148Z","etag":"777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1","handlers":["fetch"],"id":"this-is_my_script-01","logpush":false,"modified_on":"2022-05-20T19:02:56.446492Z","placement_mode":"smart","startup_time_ms":10,"tail_consumers":[{"environment":"production","service":"my-log-consumer"}],"usage_model":"standard"},"success":true},"type":"object"}]}}},"description":"Upload Worker Module response."},"workers_4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Upload Worker Module response failure."},"workers_ErrorAuth":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"$ref":"#/components/schemas/workers_ErrorAuth"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Authentication required or insufficient permissions."},"workers_ErrorInternalServer":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"$ref":"#/components/schemas/workers_ErrorInternalServer"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Internal Server Error - An unexpected server error occurred."},"workers_ErrorWorkerNotFound":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"$ref":"#/components/schemas/workers_ErrorWorkerNotFound"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Not Found - Worker does not exist."}},"schemas":{"aaa_account-id":{"description":"The account id","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"aaa_alert-types":{"properties":{"description":{"$ref":"#/components/schemas/aaa_description"},"display_name":{"$ref":"#/components/schemas/aaa_display_name"},"filter_options":{"$ref":"#/components/schemas/aaa_filter_options"},"type":{"$ref":"#/components/schemas/aaa_type"}},"type":"object"},"aaa_alert_body":{"description":"Message body included in the notification sent.","example":"SSL certificate has expired","type":"string"},"aaa_alert_interval":{"description":"Optional specification of how often to re-alert from the same incident, not support on all alert types.","example":"30m","type":"string","x-auditable":true},"aaa_alert_type":{"description":"Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values.","enum":["abuse_report_alert","access_custom_certificate_expiration_type","advanced_ddos_attack_l4_alert","advanced_ddos_attack_l7_alert","advanced_http_alert_error","bgp_hijack_notification","billing_usage_alert","block_notification_block_removed","block_notification_new_block","block_notification_review_rejected","bot_traffic_basic_alert","brand_protection_alert","brand_protection_digest","clickhouse_alert_fw_anomaly","clickhouse_alert_fw_ent_anomaly","cloudforce_one_request_notification","custom_analytics","custom_bot_detection_alert","custom_ssl_certificate_event_type","dedicated_ssl_certificate_event_type","device_connectivity_anomaly_alert","dos_attack_l4","dos_attack_l7","expiring_service_token_alert","failing_logpush_job_disabled_alert","fbm_auto_advertisement","fbm_dosd_attack","fbm_volumetric_attack","health_check_status_notification","hostname_aop_custom_certificate_expiration_type","http_alert_edge_error","http_alert_origin_error","image_notification","image_resizing_notification","incident_alert","load_balancing_health_alert","load_balancing_pool_enablement_alert","logo_match_alert","magic_tunnel_health_check_event","magic_wan_tunnel_health","maintenance_event_notification","mtls_certificate_store_certificate_expiration_type","pages_event_alert","radar_notification","real_origin_monitoring","scriptmonitor_alert_new_code_change_detections","scriptmonitor_alert_new_hosts","scriptmonitor_alert_new_malicious_hosts","scriptmonitor_alert_new_malicious_scripts","scriptmonitor_alert_new_malicious_url","scriptmonitor_alert_new_max_length_resource_url","scriptmonitor_alert_new_resources","secondary_dns_all_primaries_failing","secondary_dns_primaries_failing","secondary_dns_warning","secondary_dns_zone_successfully_updated","secondary_dns_zone_validation_warning","security_insights_alert","sentinel_alert","stream_live_notifications","synthetic_test_latency_alert","synthetic_test_low_availability_alert","traffic_anomalies_alert","tunnel_health_event","tunnel_update_event","universal_ssl_event_type","web_analytics_metrics_update","zone_aop_custom_certificate_expiration_type"],"example":"universal_ssl_event_type","type":"string","x-auditable":true},"aaa_alerts-response_collection":{"allOf":[{"$ref":"#/components/schemas/aaa_schemas-api-response-common"},{"properties":{"result":{"additionalProperties":{"items":{"$ref":"#/components/schemas/aaa_alert-types"},"type":"array"},"example":{"Origin Monitoring":[{"description":"High levels of 5xx HTTP errors at your origin.","display_name":"Origin Error Rate Alert","filter_options":[{"AvailableValues":null,"ComparisonOperator":"==","Key":"zones","Range":"1-n"},{"AvailableValues":[{"Description":"Service-Level Objective of 99.7","ID":"99.7"},{"Description":"Service-Level Objective of 99.8","ID":"99.8"}],"ComparisonOperator":"\u003e=","Key":"slo","Range":"0-1"}],"type":"http_alert_origin_error"}]},"type":"object"}}}]},"aaa_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/aaa_schemas-api-response-common"},{"properties":{"result_info":{"$ref":"#/components/schemas/aaa_schemas-result_info"}}}],"type":"object"},"aaa_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/aaa_messages"},"messages":{"$ref":"#/components/schemas/aaa_messages"},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"aaa_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/aaa_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"$ref":"#/components/schemas/aaa_messages"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"aaa_api-response-single":{"allOf":[{"$ref":"#/components/schemas/aaa_schemas-api-response-common"}],"type":"object"},"aaa_audit-logs":{"properties":{"action":{"properties":{"result":{"description":"A boolean that indicates if the action attempted was successful.","example":true,"type":"boolean"},"type":{"description":"A short string that describes the action that was performed.","example":"change_setting","type":"string"}},"type":"object"},"actor":{"properties":{"email":{"description":"The email of the user that performed the action.","example":"michelle@example.com","format":"email","type":"string"},"id":{"description":"The ID of the actor that performed the action. If a user performed the action, this will be their User ID.","example":"f6b5de0326bb5182b8a4840ee01ec774","type":"string"},"ip":{"description":"The IP address of the request that performed the action.","example":"198.41.129.166","type":"string"},"type":{"description":"The type of actor, whether a User, Cloudflare Admin, or an Automated System.","enum":["user","admin","Cloudflare"],"example":"user","type":"string"}},"type":"object"},"id":{"description":"A string that uniquely identifies the audit log.","example":"d5b0f326-1232-4452-8858-1089bd7168ef","type":"string"},"interface":{"description":"The source of the event.","example":"API","type":"string"},"metadata":{"description":"An object which can lend more context to the action being logged. This is a flexible value and varies between different actions.","example":{"name":"security_level","type":"firewall","value":"high","zone_name":"example.com"},"type":"object"},"newValue":{"description":"The new value of the resource that was modified.","example":"low","type":"string"},"oldValue":{"description":"The value of the resource before it was modified.","example":"high","type":"string"},"owner":{"properties":{"id":{"$ref":"#/components/schemas/aaa_identifier"}},"type":"object"},"resource":{"properties":{"id":{"description":"An identifier for the resource that was affected by the action.","example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string"},"type":{"description":"A short string that describes the resource that was affected by the action.","example":"zone","type":"string"}},"type":"object"},"when":{"description":"A UTC RFC3339 timestamp that specifies when the action being logged occured.","example":"2017-04-26T17:31:07Z","format":"date-time","type":"string"}},"type":"object"},"aaa_audit-logs-v2":{"properties":{"account":{"description":"Contains account related information.","properties":{"id":{"description":"A unique identifier for the account.","example":"4bb334f7c94c4a29a045f03944f072e5","type":"string"},"name":{"description":"A string that identifies the account name.","example":"Example Account","type":"string"}},"type":"object"},"action":{"description":"Provides information about the action performed.","properties":{"description":{"description":"A short description of the action performed.","example":"Add Member","type":"string"},"result":{"description":"The result of the action, indicating success or failure.","example":"success","type":"string"},"time":{"description":"A timestamp indicating when the action was logged.","example":"2024-04-26T17:31:07Z","format":"date-time","type":"string"},"type":{"description":"A short string that describes the action that was performed.","example":"create","type":"string"}},"type":"object"},"actor":{"description":"Provides details about the actor who performed the action.","properties":{"context":{"enum":["api_key","api_token","dash","oauth","origin_ca_key"],"example":"dash","type":"string"},"email":{"description":"The email of the actor who performed the action.","example":"alice@example.com","format":"email","type":"string"},"id":{"description":"The ID of the actor who performed the action. If a user performed the action, this will be their User ID.","example":"f6b5de0326bb5182b8a4840ee01ec774","type":"string"},"ip_address":{"description":"The IP address of the request that performed the action.","example":"198.41.129.166","format":"ipv4 | ipv6","type":"string"},"token_id":{"description":"Filters by the API token ID when the actor context is an api_token.","type":"string"},"token_name":{"description":"Filters by the API token name when the actor context is an api_token.","type":"string"},"type":{"description":"The type of actor.","enum":["account","cloudflare_admin","system","user"],"example":"user","type":"string"}},"type":"object"},"id":{"$ref":"#/components/schemas/aaa_schemas-identifier"},"raw":{"description":"Provides raw information about the request and response.","properties":{"cf_ray_id":{"description":"The Cloudflare Ray ID for the request.","example":"8e9b1c60ef9e1c9a","type":"string"},"method":{"description":"The HTTP method of the request.","example":"POST","type":"string"},"status_code":{"description":"The HTTP response status code returned by the API.","example":200,"type":"integer"},"uri":{"description":"The URI of the request.","example":"/accounts/4bb334f7c94c4a29a045f03944f072e5/members","type":"string"},"user_agent":{"description":"The client's user agent string sent with the request.","example":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) Safari/605.1.15","type":"string"}},"type":"object"},"resource":{"description":"Provides details about the affected resource.","properties":{"id":{"description":"The unique identifier for the affected resource.","type":"string"},"product":{"description":"The Cloudflare product associated with the resource.","example":"members","type":"string"},"request":{"type":"object"},"response":{"type":"object"},"scope":{"description":"The scope of the resource.","example":"accounts","type":"object"},"type":{"description":"The type of the resource.","type":"string"}},"type":"object"},"zone":{"description":"Provides details about the zone affected by the action.","properties":{"id":{"description":"A string that identifies the zone id.","type":"string"},"name":{"description":"A string that identifies the zone name.","example":"example.com","type":"string"}},"type":"object"}},"type":"object"},"aaa_audit-logs-v2-response-collection":{"properties":{"errors":{"$ref":"#/components/schemas/aaa_schemas-messages"},"result":{"items":{"$ref":"#/components/schemas/aaa_audit-logs-v2"},"type":"array"},"result_info":{"$ref":"#/components/schemas/aaa_result_info"},"success":{"description":"Indicates whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"type":"object"},"aaa_audit_logs_response_collection":{"oneOf":[{"properties":{"errors":{"$ref":"#/components/schemas/aaa_messages"},"messages":{"$ref":"#/components/schemas/aaa_messages"},"result":{"items":{"$ref":"#/components/schemas/aaa_audit-logs"},"type":"array"},"success":{"example":true,"type":"boolean"}}},{"$ref":"#/components/schemas/aaa_api-response-common"}]},"aaa_before":{"description":"Limit the returned results to history records older than the specified date. This must be a timestamp that conforms to RFC3339.","example":"2022-05-20T20:29:58.679897Z","format":"date-time","type":"string"},"aaa_components-schemas-api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/aaa_components-schemas-messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/aaa_components-schemas-messages"}],"example":[]},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"aaa_components-schemas-description":{"description":"Description of the notification policy (if present).","example":"Universal Certificate validation status, issuance, renewal, and expiration notices","type":"string"},"aaa_components-schemas-messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["message"],"type":"object","uniqueItems":true},"type":"array"},"aaa_components-schemas-name":{"description":"The name of the webhook destination. This will be included in the request body when you receive a webhook notification.","example":"Slack Webhook","type":"string","x-auditable":true},"aaa_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/aaa_schemas-api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/aaa_pagerduty"},"type":"array"}}}]},"aaa_components-schemas-type":{"description":"Type of webhook endpoint.","enum":["datadog","discord","feishu","gchat","generic","opsgenie","slack","splunk"],"example":"slack","type":"string","x-auditable":true},"aaa_created_at":{"description":"Timestamp of when the webhook destination was created.","example":"2020-10-26T18:25:04.532316Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"aaa_description":{"description":"Describes the alert type.","example":"High levels of 5xx HTTP errors at your origin","type":"string","x-auditable":true},"aaa_display_name":{"description":"Alert type name.","example":"Origin Error Rate Alert","type":"string","x-auditable":true},"aaa_eligibility":{"properties":{"eligible":{"$ref":"#/components/schemas/aaa_eligible"},"ready":{"$ref":"#/components/schemas/aaa_ready"},"type":{"$ref":"#/components/schemas/aaa_schemas-type"}},"type":"object"},"aaa_eligible":{"description":"Determines whether or not the account is eligible for the delivery mechanism.","example":true,"type":"boolean","x-auditable":true},"aaa_enabled":{"default":true,"description":"Whether or not the Notification policy is enabled.","example":true,"type":"boolean","x-auditable":true},"aaa_filter_options":{"description":"Format of additional configuration options (filters) for the alert type. Data type of filters during policy creation: Array of strings.","example":[{"AvailableValues":null,"ComparisonOperator":"==","Key":"zones","Range":"1-n"},{"AvailableValues":[{"Description":"Service-Level Objective of 99.7","ID":"99.7"},{"Description":"Service-Level Objective of 99.8","ID":"99.8"}],"ComparisonOperator":"\u003e=","Key":"slo","Range":"0-1"}],"items":{},"type":"array"},"aaa_filters":{"description":"Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.","example":{"slo":["99.9"]},"properties":{"actions":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"},"affected_asns":{"description":"Used for configuring radar_notification","items":{"type":"string","x-auditable":true},"type":"array"},"affected_components":{"description":"Used for configuring incident_alert","example":"4c231tkdlpcl","items":{"type":"string","x-auditable":true},"type":"array"},"affected_locations":{"description":"Used for configuring radar_notification","items":{"type":"string","x-auditable":true},"type":"array"},"airport_code":{"description":"Used for configuring maintenance_event_notification","items":{"type":"string","x-auditable":true},"type":"array"},"alert_trigger_preferences":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"},"alert_trigger_preferences_value":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"},"enabled":{"description":"Used for configuring load_balancing_pool_enablement_alert","items":{"minItems":1,"type":"string","x-auditable":true},"type":"array"},"environment":{"description":"Used for configuring pages_event_alert","items":{"minItems":1,"type":"string","x-auditable":true},"type":"array"},"event":{"description":"Used for configuring pages_event_alert","items":{"minItems":1,"type":"string","x-auditable":true},"type":"array"},"event_source":{"description":"Used for configuring load_balancing_health_alert","items":{"type":"string","x-auditable":true},"type":"array"},"event_type":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"},"group_by":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"},"health_check_id":{"description":"Used for configuring health_check_status_notification","items":{"type":"string","x-auditable":true},"type":"array"},"incident_impact":{"description":"Used for configuring incident_alert","items":{"enum":["INCIDENT_IMPACT_NONE","INCIDENT_IMPACT_MINOR","INCIDENT_IMPACT_MAJOR","INCIDENT_IMPACT_CRITICAL"],"type":"string","x-auditable":true},"type":"array"},"input_id":{"description":"Used for configuring stream_live_notifications","items":{"type":"string","x-auditable":true},"type":"array"},"insight_class":{"description":"Used for configuring security_insights_alert","items":{"type":"string","x-auditable":true},"type":"array"},"limit":{"description":"Used for configuring billing_usage_alert","items":{"minItems":1,"type":"string","x-auditable":true},"type":"array"},"logo_tag":{"description":"Used for configuring logo_match_alert","items":{"type":"string","x-auditable":true},"type":"array"},"megabits_per_second":{"description":"Used for configuring advanced_ddos_attack_l4_alert","items":{"type":"string","x-auditable":true},"type":"array"},"new_health":{"description":"Used for configuring load_balancing_health_alert","items":{"type":"string","x-auditable":true},"type":"array"},"new_status":{"description":"Used for configuring tunnel_health_event","items":{"type":"string","x-auditable":true},"type":"array"},"packets_per_second":{"description":"Used for configuring advanced_ddos_attack_l4_alert","items":{"type":"string","x-auditable":true},"type":"array"},"pool_id":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"},"pop_names":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"},"product":{"description":"Used for configuring billing_usage_alert","items":{"minItems":1,"type":"string","x-auditable":true},"type":"array"},"project_id":{"description":"Used for configuring pages_event_alert","items":{"minItems":1,"type":"string","x-auditable":true},"type":"array"},"protocol":{"description":"Used for configuring advanced_ddos_attack_l4_alert","items":{"type":"string","x-auditable":true},"type":"array"},"query_tag":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"},"requests_per_second":{"description":"Used for configuring advanced_ddos_attack_l7_alert","items":{"type":"string","x-auditable":true},"type":"array"},"selectors":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"},"services":{"description":"Used for configuring clickhouse_alert_fw_ent_anomaly","items":{"minItems":1,"type":"string","x-auditable":true},"type":"array"},"slo":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"},"status":{"description":"Used for configuring health_check_status_notification","items":{"minItems":1,"type":"string","x-auditable":true},"type":"array"},"target_hostname":{"description":"Used for configuring advanced_ddos_attack_l7_alert","items":{"type":"string","x-auditable":true},"type":"array"},"target_ip":{"description":"Used for configuring advanced_ddos_attack_l4_alert","items":{"type":"string","x-auditable":true},"type":"array"},"target_zone_name":{"description":"Used for configuring advanced_ddos_attack_l7_alert","items":{"type":"string","x-auditable":true},"type":"array"},"traffic_exclusions":{"description":"Used for configuring traffic_anomalies_alert","items":{"enum":["security_events"],"maxItems":1,"type":"string","x-auditable":true},"type":"array"},"tunnel_id":{"description":"Used for configuring tunnel_health_event","items":{"type":"string","x-auditable":true},"type":"array"},"tunnel_name":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"},"type":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"},"where":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"},"zones":{"description":"Usage depends on specific alert type","items":{"type":"string","x-auditable":true},"type":"array"}},"type":"object"},"aaa_history":{"properties":{"alert_body":{"$ref":"#/components/schemas/aaa_alert_body"},"alert_type":{"$ref":"#/components/schemas/aaa_schemas-alert_type"},"description":{"$ref":"#/components/schemas/aaa_components-schemas-description"},"id":{"$ref":"#/components/schemas/aaa_uuid"},"mechanism":{"$ref":"#/components/schemas/aaa_mechanism"},"mechanism_type":{"$ref":"#/components/schemas/aaa_mechanism_type"},"name":{"$ref":"#/components/schemas/aaa_schemas-name"},"policy_id":{"$ref":"#/components/schemas/aaa_policy-id"},"sent":{"$ref":"#/components/schemas/aaa_sent"}},"type":"object"},"aaa_history_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/aaa_api-response-collection"},{"properties":{"result":{"example":[{"alert_body":{"data":{"custom_csr_id":"","expires_on":null,"hosts":[],"id":"11111111111","issuer":"","method":"txt","serial_number":"","settings":null,"signature":"","status":"","type":"","uploaded_on":null,"validation_errors":[],"validation_records":[{"cname":"","cname_target":"","emails":[],"http_body":"","http_url":"","txt_name":"_acme-challenge.example.com","txt_value":"11111111111"}]},"metadata":{"account":null,"event":{"created_at":null,"id":"","type":"ssl.certificate.validation.failed"},"zone":{"id":"11111111111"}}},"alert_type":"universal_ssl_event_type","description":"Universal Certificate validation status, issuance, renewal, and expiration notices.","id":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","mechanism":"test@example.com","mechanism_type":"email","name":"SSL Notification Event Policy","policy_id":"35040955-3102-4710-938c-0f4eaf736e25","sent":"2021-10-08T17:52:17.571336Z"}],"items":{"$ref":"#/components/schemas/aaa_history"},"type":"array"},"result_info":{"example":{"count":1,"page":1,"per_page":20},"type":"object"}}}]},"aaa_id_response":{"allOf":[{"$ref":"#/components/schemas/aaa_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/aaa_uuid"}},"type":"object"}}}]},"aaa_identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"aaa_integration-token":{"description":"The token integration key","example":"8c71e667571b4f61b94d9e4b12158038","maxLength":32,"readOnly":true,"type":"string"},"aaa_last_failure":{"description":"Timestamp of the last time an attempt to dispatch a notification to this webhook failed.","example":"2020-10-26T18:25:04.532316Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"aaa_last_success":{"description":"Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook.","example":"2020-10-26T18:25:04.532316Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"aaa_mechanism":{"description":"The mechanism to which the notification has been dispatched.","example":"test@example.com","type":"string","x-auditable":true},"aaa_mechanism_type":{"description":"The type of mechanism to which the notification has been dispatched. This can be email/pagerduty/webhook based on the mechanism configured.","enum":["email","pagerduty","webhook"],"example":"email","type":"string"},"aaa_mechanisms":{"description":"List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.","example":{"email":[{"id":"test@example.com"}],"pagerduty":[{"id":"e8133a15-00a4-4d69-aec1-32f70c51f6e5"}],"webhooks":[{"id":"14cc1190-5d2b-4b98-a696-c424cb2ad05f"}]},"properties":{"email":{"items":{"properties":{"id":{"description":"The email address","type":"string","x-auditable":true}},"type":"object"},"type":"array"},"pagerduty":{"items":{"properties":{"id":{"$ref":"#/components/schemas/aaa_uuid"}},"type":"object"},"type":"array"},"webhooks":{"items":{"properties":{"id":{"$ref":"#/components/schemas/aaa_uuid"}},"type":"object"},"type":"array"}},"type":"object"},"aaa_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"aaa_name":{"description":"The name of the pagerduty service.","example":"My PagerDuty Service","type":"string","x-auditable":true},"aaa_pagerduty":{"properties":{"id":{"$ref":"#/components/schemas/aaa_uuid"},"name":{"$ref":"#/components/schemas/aaa_name"}},"type":"object"},"aaa_per_page":{"default":25,"description":"Number of items per page.","maximum":1000,"minimum":5,"type":"number"},"aaa_policies":{"properties":{"alert_interval":{"$ref":"#/components/schemas/aaa_alert_interval"},"alert_type":{"$ref":"#/components/schemas/aaa_alert_type"},"created":{"$ref":"#/components/schemas/aaa_timestamp"},"description":{"$ref":"#/components/schemas/aaa_schemas-description"},"enabled":{"$ref":"#/components/schemas/aaa_enabled"},"filters":{"$ref":"#/components/schemas/aaa_filters"},"id":{"$ref":"#/components/schemas/aaa_policy-id"},"mechanisms":{"$ref":"#/components/schemas/aaa_mechanisms"},"modified":{"$ref":"#/components/schemas/aaa_timestamp"},"name":{"$ref":"#/components/schemas/aaa_schemas-name"}},"type":"object"},"aaa_policies_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/aaa_schemas-api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/aaa_policies"},"type":"array"}}}]},"aaa_policy-id":{"description":"The unique identifier of a notification policy","example":"0da2b59ef118439d8097bdfb215203c9","maxLength":32,"type":"string","x-auditable":true},"aaa_ready":{"description":"Beta flag. Users can create a policy with a mechanism that is not ready, but we cannot guarantee successful delivery of notifications.","example":true,"type":"boolean","x-auditable":true},"aaa_result_info":{"description":"Provides information about the result of the request, including count and cursor.","properties":{"count":{"description":"The number of records returned in the response.","example":1,"type":"string"},"cursor":{"description":"The cursor token used for pagination.","example":"ASqdKd7dKgxh-aZ8bm0mZos1BtW4BdEqifCzNkEeGRzi_5SN_-362Y8sF-C1TRn60_6rd3z2dIajf9EAPyQ_NmIeAMkacmaJPXipqvP7PLU4t72wyqBeJfjmjdE=","type":"string"}},"type":"object"},"aaa_schemas-alert_type":{"description":"Type of notification that has been dispatched.","example":"universal_ssl_event_type","type":"string"},"aaa_schemas-api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/aaa_components-schemas-messages"},"messages":{"$ref":"#/components/schemas/aaa_components-schemas-messages"},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"aaa_schemas-api-response-common-failure":{"properties":{"errors":{"description":"A list of error messages.","items":{"properties":{"message":{"description":"A text description of this message.","example":"No route for the URI","type":"string"}},"required":["message"],"type":"object","uniqueItems":true},"type":"array"},"messages":{"example":[],"items":{"properties":{"message":{"type":"string"}},"type":"object","uniqueItems":true},"type":"array"},"success":{"description":"Indicates whether the API call was failed","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors"],"type":"object"},"aaa_schemas-description":{"description":"Optional description for the Notification policy.","example":"Something describing the policy.","type":"string","x-auditable":true},"aaa_schemas-identifier":{"description":"A unique identifier for the audit log entry.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"aaa_schemas-messages":{"example":[],"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object","uniqueItems":true},"type":"array"},"aaa_schemas-name":{"description":"Name of the policy.","example":"SSL Notification Event Policy","type":"string","x-auditable":true},"aaa_schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/aaa_schemas-api-response-common"},{"properties":{"result":{"additionalProperties":{"items":{"$ref":"#/components/schemas/aaa_eligibility"},"type":"array"},"example":{"email":{"eligible":true,"ready":true,"type":"email"}},"type":"object"}}}]},"aaa_schemas-result_info":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters","example":2000,"type":"number"}},"type":"object"},"aaa_schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/aaa_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/aaa_webhooks"}}}]},"aaa_schemas-type":{"description":"Determines type of delivery mechanism.","enum":["email","pagerduty","webhook"],"example":"email","type":"string","x-auditable":true},"aaa_secret":{"description":"Optional secret that will be passed in the `cf-webhook-auth` header when dispatching generic webhook notifications or formatted for supported destinations. Secrets are not returned in any API response body.","type":"string","writeOnly":true,"x-sensitive":true},"aaa_sensitive_id_response":{"allOf":[{"$ref":"#/components/schemas/aaa_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/aaa_token"}},"type":"object"}}}]},"aaa_sent":{"description":"Timestamp of when the notification was dispatched in ISO 8601 format.","example":"2021-10-08T17:52:17.571336Z","format":"date-time","type":"string"},"aaa_silence":{"properties":{"created_at":{"description":"When the silence was created.","example":"2022-01-01T00:00:00Z","type":"string","x-auditable":true},"end_time":{"description":"When the silence ends.","example":"2022-01-01T00:00:00Z","type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/aaa_silence-id"},"policy_id":{"$ref":"#/components/schemas/aaa_policy-id"},"start_time":{"description":"When the silence starts.","example":"2022-01-01T00:00:00Z","type":"string","x-auditable":true},"updated_at":{"description":"When the silence was modified.","example":"2022-01-01T00:00:00Z","type":"string","x-auditable":true}},"type":"object"},"aaa_silence-id":{"description":"Silence ID","example":"f878e90c23f44126ae3cfc399f646977","maxLength":32,"type":"string","x-auditable":true},"aaa_silence_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/aaa_schemas-api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/aaa_silence"}}}]},"aaa_silence_create_request":{"properties":{"end_time":{"description":"When the silence ends.","example":"2022-01-01T00:00:00Z","type":"string","x-auditable":true},"policy_id":{"$ref":"#/components/schemas/aaa_policy-id"},"start_time":{"description":"When the silence starts.","example":"2022-01-01T00:00:00Z","type":"string","x-auditable":true}},"type":"object"},"aaa_silence_update_request":{"properties":{"end_time":{"description":"When the silence ends.","example":"2022-01-01T00:00:00Z","type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/aaa_silence-id"},"start_time":{"description":"When the silence starts.","example":"2022-01-01T00:00:00Z","type":"string","x-auditable":true}},"type":"object"},"aaa_silences_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/aaa_schemas-api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/aaa_silence"},"type":"array"}}}]},"aaa_single_response":{"allOf":[{"$ref":"#/components/schemas/aaa_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/aaa_policies"}}}]},"aaa_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"aaa_token":{"description":"token in form of UUID","example":"a313ba7d3e464c0ea40808fafbc3816a","maxLength":32,"type":"string","x-sensitive":true},"aaa_type":{"description":"Use this value when creating and updating a notification policy.","example":"http_alert_origin_error","type":"string","x-auditable":true},"aaa_url":{"description":"The POST endpoint to call when dispatching a notification.","example":"https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd","type":"string"},"aaa_uuid":{"description":"UUID","example":"f174e90afafe4643bbbc4a0ed4fc8415","maxLength":32,"type":"string","x-auditable":true},"aaa_webhook-id":{"description":"The unique identifier of a webhook","example":"b115d5ec15c641ee8b7692c449b5227b","maxLength":32,"type":"string","x-auditable":true},"aaa_webhooks":{"properties":{"created_at":{"$ref":"#/components/schemas/aaa_created_at"},"id":{"$ref":"#/components/schemas/aaa_webhook-id"},"last_failure":{"$ref":"#/components/schemas/aaa_last_failure"},"last_success":{"$ref":"#/components/schemas/aaa_last_success"},"name":{"$ref":"#/components/schemas/aaa_components-schemas-name"},"secret":{"$ref":"#/components/schemas/aaa_secret"},"type":{"$ref":"#/components/schemas/aaa_components-schemas-type"},"url":{"$ref":"#/components/schemas/aaa_url"}},"type":"object"},"aaa_webhooks_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/aaa_schemas-api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/aaa_webhooks"},"type":"array"}}}]},"abuse-reports_AbuseReport":{"properties":{"cdate":{"description":"Creation date of report. Time in RFC 3339 format (https://www.rfc-editor.org/rfc/rfc3339.html)","example":"2009-11-10T23:00:00Z","type":"string"},"domain":{"description":"Domain that relates to the report.","type":"string"},"id":{"description":"Public facing ID of abuse report, aka abuse_rand.","type":"string"},"justification":{"description":"Justification for the report.","type":"string"},"mitigation_summary":{"$ref":"#/components/schemas/abuse-reports_MitigationSummary"},"original_work":{"description":"Original work / Targeted brand in the alleged abuse.","type":"string"},"status":{"$ref":"#/components/schemas/abuse-reports_ReportStatus"},"submitter":{"$ref":"#/components/schemas/abuse-reports_SubmitterDetails"},"type":{"$ref":"#/components/schemas/abuse-reports_ReportType"},"urls":{"items":{"type":"string"},"type":"array"}},"required":["id","cdate","domain","type","status","mitigation_summary"],"type":"object"},"abuse-reports_AppealReason":{"description":"Reason why the customer is appealing.","enum":["removed","misclassified"],"example":"misclassified","type":"string"},"abuse-reports_BadActError":{"description":"Report has invalid type","type":"string"},"abuse-reports_BadAddressError":{"description":"Provided value has invalid size","type":"string"},"abuse-reports_BadAgentNameError":{"description":"Provided value has invalid size","type":"string"},"abuse-reports_BadCityError":{"description":"Provided value has invalid size","type":"string"},"abuse-reports_BadCommentsError":{"description":"Comment maximum length of 2000 characters exceeded","type":"string"},"abuse-reports_BadCountryError":{"description":"Provided value has invalid size","type":"string"},"abuse-reports_BadEmailError":{"description":"Provided email was invalid","type":"string"},"abuse-reports_BadIPError":{"description":"Invalid IP passed to api","type":"string"},"abuse-reports_BadJustError":{"description":"Please provide a more detailed description of the infringement between 1 and 5000 characters","type":"string"},"abuse-reports_BadNameError":{"description":"Missing a required field","type":"string"},"abuse-reports_BadPortsProtocolError":{"description":"Invalid Port and Protocol passed to api","type":"string"},"abuse-reports_BadStateError":{"description":"Provided value has invalid size","type":"string"},"abuse-reports_BadUrlsError":{"description":"Invalid URL (http://example.com/) Invalid URL Scheme (http or https) Missing hostname in url Missing a required field Could not determine encoding of field\n","type":"string"},"abuse-reports_BaseReportFields":{"properties":{"act":{"$ref":"#/components/schemas/abuse-reports_SubmissionReportType"},"comments":{"description":"Any additional comments about the infringement not exceeding 2000 characters","maxLength":2000,"minLength":1,"type":"string"},"company":{"description":"Text not exceeding 100 characters. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).","maxLength":100,"minLength":1,"type":"string"},"email":{"description":"A valid email of the abuse reporter. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).","type":"string"},"email2":{"description":"Should match the value provided in `email`","type":"string"},"name":{"description":"Text not exceeding 255 characters. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).","maxLength":255,"minLength":1,"type":"string"},"reported_country":{"description":"Text containing 2 characters","maxLength":2,"minLength":2,"type":"string"},"reported_user_agent":{"description":"Text not exceeding 255 characters","maxLength":255,"minLength":1,"type":"string"},"tele":{"description":"Text not exceeding 20 characters. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).","maxLength":20,"minLength":1,"type":"string"},"title":{"description":"Text not exceeding 255 characters","maxLength":255,"minLength":1,"type":"string"},"urls":{"description":"A list of valid URLs separated by ‘\\n’ (new line character). The list of the URLs should not exceed 250 URLs. All URLs should have the same hostname. Each URL should be unique. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).","type":"string"}},"required":["act","email","email2","name","urls"],"type":"object"},"abuse-reports_CSAMReport":{"allOf":[{"$ref":"#/components/schemas/abuse-reports_BaseReportFields"},{"properties":{"act":{"enum":["abuse_children"]},"country":{"description":"Text not exceeding 255 characters. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).\n","maxLength":255,"minLength":1,"type":"string"},"host_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send","send-anon"],"type":"string"},"justification":{"description":"A detailed description of the infringement, including any necessary access details and the exact steps needed to view the content, not exceeding 5000 characters.\n","maxLength":5000,"minLength":1,"type":"string"},"ncmec_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send","send-anon"],"type":"string"},"owner_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send","send-anon","none"],"type":"string"}},"required":["host_notification","justification","ncmec_notification","owner_notification"],"title":"Children Abuse Report"}],"type":"object"},"abuse-reports_DBError":{"description":"Failed while reading from database Failed while writing to the database This service error will trigger an alert for Cloudflare engineers to investigate the cause resolve it.\n","type":"string"},"abuse-reports_DMCAReport":{"allOf":[{"$ref":"#/components/schemas/abuse-reports_BaseReportFields"},{"properties":{"act":{"enum":["abuse_dmca"]},"address1":{"description":"Text not exceeding 100 characters. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).","maxLength":100,"minLength":1,"type":"string"},"agent_name":{"description":"The name of the copyright holder. Text not exceeding 60 characters. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).","maxLength":60,"minLength":1,"type":"string"},"agree":{"description":"Can be `0` for false or `1` for true. Must be value: 1 for DMCA reports","enum":[1],"type":"integer"},"city":{"description":"Text not exceeding 255 characters. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).","maxLength":255,"minLength":1,"type":"string"},"country":{"description":"Text not exceeding 255 characters. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).\n","maxLength":255,"minLength":1,"type":"string"},"host_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send"],"type":"string"},"original_work":{"description":"Text not exceeding 255 characters. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).\n","maxLength":255,"minLength":1,"type":"string"},"owner_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send"],"type":"string"},"signature":{"description":"Required for DMCA reports, should be same as Name. An affirmation that all information in the report is true and accurate while agreeing to the policies of Cloudflare's abuse reports","type":"string"},"state":{"description":"Text not exceeding 255 characters. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).","maxLength":255,"minLength":1,"type":"string"}},"required":["address1","agent_name","agree","city","country","host_notification","original_work","owner_notification","signature","state"],"title":"DMCA Report"}],"type":"object"},"abuse-reports_DedupeError":{"description":"You have already submitted this URL in the last 7 days","type":"string"},"abuse-reports_DiffEmailError":{"description":"Provided emails did not match","type":"string"},"abuse-reports_EmailError":{"description":"Failed to send confirmation email","type":"string"},"abuse-reports_ErrorCode":{"oneOf":[{"$ref":"#/components/schemas/abuse-reports_BadActError"},{"$ref":"#/components/schemas/abuse-reports_BadAddressError"},{"$ref":"#/components/schemas/abuse-reports_BadAgentNameError"},{"$ref":"#/components/schemas/abuse-reports_BadCityError"},{"$ref":"#/components/schemas/abuse-reports_BadCountryError"},{"$ref":"#/components/schemas/abuse-reports_BadPortsProtocolError"},{"$ref":"#/components/schemas/abuse-reports_BadStateError"},{"$ref":"#/components/schemas/abuse-reports_MaxIPsError"},{"$ref":"#/components/schemas/abuse-reports_PortsProtocolError"},{"$ref":"#/components/schemas/abuse-reports_BadCommentsError"},{"$ref":"#/components/schemas/abuse-reports_BadEmailError"},{"$ref":"#/components/schemas/abuse-reports_BadIPError"},{"$ref":"#/components/schemas/abuse-reports_BadJustError"},{"$ref":"#/components/schemas/abuse-reports_BadNameError"},{"$ref":"#/components/schemas/abuse-reports_BadUrlsError"},{"$ref":"#/components/schemas/abuse-reports_DBError"},{"$ref":"#/components/schemas/abuse-reports_DedupeError"},{"$ref":"#/components/schemas/abuse-reports_DiffEmailError"},{"$ref":"#/components/schemas/abuse-reports_EmailError"},{"$ref":"#/components/schemas/abuse-reports_InternalError"},{"$ref":"#/components/schemas/abuse-reports_InvalidNotifyError"},{"$ref":"#/components/schemas/abuse-reports_MustNotifyError"},{"$ref":"#/components/schemas/abuse-reports_NoAgreeError"},{"$ref":"#/components/schemas/abuse-reports_NoOriginalWorkError"},{"$ref":"#/components/schemas/abuse-reports_NoSigError"},{"$ref":"#/components/schemas/abuse-reports_UnexpectedActError"},{"$ref":"#/components/schemas/abuse-reports_UnknownError"},{"$ref":"#/components/schemas/abuse-reports_UrlNotOrangeError"},{"$ref":"#/components/schemas/abuse-reports_UrlNotvalidError"}],"type":"string"},"abuse-reports_ErrorMessage":{"properties":{"code":{"oneOf":[{"type":"string"},{"type":"number"}]},"message":{"type":"string"}},"required":["message"],"type":"object"},"abuse-reports_GeneralReport":{"allOf":[{"$ref":"#/components/schemas/abuse-reports_BaseReportFields"},{"properties":{"act":{"enum":["abuse_general"]},"destination_ips":{"description":"A list of IP addresses separated by ‘\\n’ (new line character). The list of destination IPs should not exceed 30 IP addresses. Each one of the IP addresses ought to be unique.","type":"string"},"host_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send","send-anon"],"type":"string"},"justification":{"description":"A detailed description of the infringement, including any necessary access details and the exact steps needed to view the content, not exceeding 5000 characters.\n","maxLength":5000,"minLength":1,"type":"string"},"owner_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send","send-anon","none"],"type":"string"},"ports_protocols":{"description":"A comma separated list of ports and protocols e.g. 80/TCP, 22/UDP. The total size of the field should not exceed 2000 characters. Each individual port/protocol should not exceed 100 characters. The list should not have more than 30 unique ports and protocols.","type":"string"},"source_ips":{"description":"A list of IP addresses separated by ‘\\n’ (new line character). The list of source IPs should not exceed 30 IP addresses. Each one of the IP addresses ought to be unique.","type":"string"}},"required":["host_notification","justification","owner_notification"],"title":"General Report"}],"type":"object"},"abuse-reports_InternalError":{"description":"Failed to translate email","type":"string"},"abuse-reports_InvalidNotifyError":{"description":"Invalid value for notification preference","type":"string"},"abuse-reports_MaxIPsError":{"description":"Provided value has invalid size","type":"string"},"abuse-reports_Message":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"abuse-reports_MitigatedEntityType":{"enum":["url_pattern","account","zone"],"type":"string"},"abuse-reports_MitigationAppeal":{"properties":{"id":{"description":"ID of the mitigation to appeal.","type":"string"},"reason":{"$ref":"#/components/schemas/abuse-reports_AppealReason"}},"required":["id","reason"],"type":"object"},"abuse-reports_MitigationAppealRequest":{"properties":{"appeals":{"description":"List of mitigations to appeal.","items":{"$ref":"#/components/schemas/abuse-reports_MitigationAppeal"},"type":"array"}},"required":["appeals"],"type":"object"},"abuse-reports_MitigationAppealResult":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"result":{"items":{"$ref":"#/components/schemas/abuse-reports_MitigationListItem"},"type":"array"},"result_info":{"properties":{"count":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"},"total_pages":{"type":"number"}},"required":["page","per_page","count","total_count","total_pages"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result_info"],"type":"object"},"abuse-reports_MitigationListItem":{"properties":{"effective_date":{"description":"Date when the mitigation will become active. Time in RFC 3339 format (https://www.rfc-editor.org/rfc/rfc3339.html)","example":"2009-11-10T23:00:00Z","type":"string"},"entity_id":{"type":"string"},"entity_type":{"$ref":"#/components/schemas/abuse-reports_MitigatedEntityType"},"id":{"description":"ID of remediation.","type":"string"},"status":{"$ref":"#/components/schemas/abuse-reports_MitigationStatus"},"type":{"$ref":"#/components/schemas/abuse-reports_MitigationType"}},"required":["id","type","effective_date","status","entity_type","entity_id"],"type":"object"},"abuse-reports_MitigationStatus":{"description":"The status of a mitigation","enum":["pending","active","in_review","cancelled","removed"],"type":"string"},"abuse-reports_MitigationSummary":{"description":"A summary of the mitigations related to this report.","properties":{"accepted_url_count":{"description":"How many of the reported URLs were confirmed as abusive.","type":"integer"},"active_count":{"description":"How many mitigations are active.","type":"integer"},"external_host_notified":{"description":"Whether the report has been forwarded to an external hosting provider.","type":"boolean"},"in_review_count":{"description":"How many mitigations are under review.","type":"integer"},"pending_count":{"description":"How many mitigations are pending their effective date.","type":"integer"}},"required":["accepted_url_count","pending_count","active_count","in_review_count","external_host_notified"],"type":"object"},"abuse-reports_MitigationType":{"description":"The type of mitigation","enum":["legal_block","phishing_interstitial","network_block","rate_limit_cache","account_suspend","redirect_video_stream"],"type":"string"},"abuse-reports_MustNotifyError":{"description":"Please pick one party to notify about this report","type":"string"},"abuse-reports_NCSEIReport":{"allOf":[{"$ref":"#/components/schemas/abuse-reports_BaseReportFields"},{"properties":{"act":{"enum":["abuse_ncsei"]},"country":{"description":"Text not exceeding 255 characters. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).\n","maxLength":255,"minLength":1,"type":"string"},"host_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send","send-anon"],"type":"string"},"ncsei_subject_representation":{"description":"If the submitter is the target of NCSEI in the URLs of the abuse report.","type":"boolean"},"owner_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send","send-anon","none"],"type":"string"}},"required":["host_notification","ncsei_subject_representation","owner_notification"],"title":"NCSEI Report"}],"type":"object"},"abuse-reports_NoAgreeError":{"description":"Must acknowledge that you are bound by 512(f), that you have a good faith belief about the material, and that you have the authority to act","type":"string"},"abuse-reports_NoOriginalWorkError":{"description":"Original Work section must be between 1 and 2000 characters","type":"string"},"abuse-reports_NoSigError":{"description":"Signature must match your name","type":"string"},"abuse-reports_PhishingReport":{"allOf":[{"$ref":"#/components/schemas/abuse-reports_BaseReportFields"},{"properties":{"act":{"enum":["abuse_phishing"]},"host_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send","send-anon"],"type":"string"},"justification":{"description":"A detailed description of the infringement, including any necessary access details and the exact steps needed to view the content, not exceeding 5000 characters.\n","maxLength":5000,"minLength":20,"type":"string"},"original_work":{"description":"Text not exceeding 255 characters. This field may be released by Cloudflare to third parties such as the Lumen Database (https://lumendatabase.org/).\n","maxLength":255,"minLength":1,"type":"string"},"owner_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send","send-anon"],"type":"string"}},"required":["host_notification","justification","owner_notification"],"title":"Phishing Report"}],"type":"object"},"abuse-reports_PortsProtocolError":{"description":"Provided value has invalid size","type":"string"},"abuse-reports_RegistrarWhoisReport":{"allOf":[{"$ref":"#/components/schemas/abuse-reports_BaseReportFields"},{"properties":{"act":{"enum":["abuse_registrar_whois"]},"owner_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send","send-anon","none"],"type":"string"}},"required":["owner_notification"],"title":"Registrar Whois Report"}],"type":"object"},"abuse-reports_ReportStatus":{"description":"An enum value that represents the status of an abuse record","enum":["accepted","in_review"],"type":"string"},"abuse-reports_ReportType":{"description":"The abuse report type","enum":["PHISH","GEN","THREAT","DMCA","EMER","TM","REG_WHO","NCSEI","NETWORK"],"type":"string"},"abuse-reports_SubmissionReportType":{"description":"The report type for submitted reports.","type":"string"},"abuse-reports_SubmitErrorResponse":{"properties":{"error_code":{"$ref":"#/components/schemas/abuse-reports_ErrorCode"},"msg":{"description":"The error message for the error","type":"string"},"request":{"properties":{"act":{"$ref":"#/components/schemas/abuse-reports_SubmissionReportType"}},"required":["act"],"type":"object"},"result":{"description":"The result should be 'error' for successful response","type":"string"}},"required":["request","result","msg","error_code"],"type":"object"},"abuse-reports_SubmitReportRequest":{"discriminator":{"mapping":{"abuse_children":"#/components/schemas/abuse-reports_CSAMReport","abuse_dmca":"#/components/schemas/abuse-reports_DMCAReport","abuse_general":"#/components/schemas/abuse-reports_GeneralReport","abuse_ncsei":"#/components/schemas/abuse-reports_NCSEIReport","abuse_phishing":"#/components/schemas/abuse-reports_PhishingReport","abuse_registrar_whois":"#/components/schemas/abuse-reports_RegistrarWhoisReport","abuse_threat":"#/components/schemas/abuse-reports_ThreatReport","abuse_trademark":"#/components/schemas/abuse-reports_TrademarkReport"},"propertyName":"act"},"oneOf":[{"$ref":"#/components/schemas/abuse-reports_DMCAReport"},{"$ref":"#/components/schemas/abuse-reports_TrademarkReport"},{"$ref":"#/components/schemas/abuse-reports_GeneralReport"},{"$ref":"#/components/schemas/abuse-reports_PhishingReport"},{"$ref":"#/components/schemas/abuse-reports_CSAMReport"},{"$ref":"#/components/schemas/abuse-reports_ThreatReport"},{"$ref":"#/components/schemas/abuse-reports_RegistrarWhoisReport"},{"$ref":"#/components/schemas/abuse-reports_NCSEIReport"}]},"abuse-reports_SubmitReportResponse":{"properties":{"abuse_rand":{"description":"The identifier for the submitted abuse report.","type":"string"},"request":{"properties":{"act":{"$ref":"#/components/schemas/abuse-reports_SubmissionReportType"}},"required":["act"],"type":"object"},"result":{"description":"The result should be 'success' for successful response","type":"string"}},"required":["request","result","abuse_rand"],"type":"object"},"abuse-reports_SubmitterDetails":{"description":"Information about the submitter of the report.","properties":{"company":{"type":"string"},"email":{"type":"string"},"name":{"type":"string"},"telephone":{"type":"string"}},"type":"object"},"abuse-reports_ThreatReport":{"allOf":[{"$ref":"#/components/schemas/abuse-reports_BaseReportFields"},{"properties":{"act":{"enum":["abuse_threat"]},"host_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send","send-anon"],"type":"string"},"justification":{"description":"A detailed description of the infringement, including any necessary access details and the exact steps needed to view the content, not exceeding 5000 characters.\n","maxLength":5000,"minLength":1,"type":"string"},"owner_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send","send-anon"],"type":"string"}},"required":["host_notification","justification","owner_notification"],"title":"Threat Report"}],"type":"object"},"abuse-reports_TrademarkReport":{"allOf":[{"$ref":"#/components/schemas/abuse-reports_BaseReportFields"},{"properties":{"act":{"enum":["abuse_trademark"]},"host_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send"],"type":"string"},"justification":{"description":"A detailed description of the infringement, including any necessary access details and the exact steps needed to view the content, not exceeding 5000 characters.\n","maxLength":5000,"minLength":1,"type":"string"},"owner_notification":{"description":"Notification type based on the abuse type. NOTE: Copyright (DMCA) and Trademark reports cannot be anonymous.\n","enum":["send"],"type":"string"},"trademark_number":{"description":"Text not exceeding 1000 characters","maxLength":1000,"minLength":1,"type":"string"},"trademark_office":{"description":"Text not exceeding 1000 characters","maxLength":1000,"minLength":1,"type":"string"},"trademark_symbol":{"description":"Text not exceeding 1000 characters","maxLength":1000,"minLength":1,"type":"string"}},"required":["host_notification","justification","owner_notification","trademark_number","trademark_office","trademark_symbol"],"title":"Trademark Report"}],"type":"object"},"abuse-reports_UnexpectedActError":{"description":"Report has the wrong type","type":"string"},"abuse-reports_UnknownError":{"description":"An unexpected error occurred","type":"string"},"abuse-reports_UrlNotOrangeError":{"description":"A URL contains a domain that is not active on Cloudflare","type":"string"},"abuse-reports_UrlNotvalidError":{"description":"You have entered URLs that contain more than 1 unique hostname. A single report may only include 1 unique hostname (i.e, www.example.com). To report URLs related to another hostname (i.e. other.example.com) you'll need to file a separate report.","type":"string"},"access_access-requests":{"properties":{"action":{"$ref":"#/components/schemas/access_action"},"allowed":{"$ref":"#/components/schemas/access_allowed"},"app_domain":{"$ref":"#/components/schemas/access_app_domain"},"app_uid":{"$ref":"#/components/schemas/access_app_uid"},"connection":{"$ref":"#/components/schemas/access_connection"},"created_at":{"$ref":"#/components/schemas/access_timestamp"},"ip_address":{"$ref":"#/components/schemas/access_ip"},"ray_id":{"$ref":"#/components/schemas/access_ray_id"},"user_email":{"$ref":"#/components/schemas/access_components-schemas-email"}},"type":"object"},"access_access-requests_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_access-requests"},"type":"array"}}}]},"access_access_group_rule":{"description":"Matches an Access group.","properties":{"group":{"properties":{"id":{"description":"The ID of a previously created Access group.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f","type":"string"}},"required":["id"],"type":"object"}},"required":["group"],"title":"Access groups","type":"object"},"access_access_seat":{"description":"True if the seat is part of Access.","example":false,"type":"boolean","x-auditable":true},"access_action":{"description":"The event that occurred, such as a login attempt.","example":"login","type":"string"},"access_active_device_count":{"description":"The number of active devices registered to the user.","example":2,"type":"number"},"access_active_session_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/access_identity"},{"properties":{"isActive":{"example":true,"type":"boolean"}},"type":"object"}],"type":"object"}}}],"type":"object"},"access_active_sessions_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"properties":{"expiration":{"example":1694813506,"type":"integer"},"metadata":{"properties":{"apps":{"additionalProperties":{"properties":{"hostname":{"example":"test.example.com","type":"string"},"name":{"example":"app name","type":"string"},"type":{"example":"self_hosted","type":"string"},"uid":{"example":"cc2a8145-0128-4429-87f3-872c4d380c4e","type":"string"}},"type":"object"},"type":"object"},"expires":{"example":1694813506,"type":"integer"},"iat":{"example":1694791905,"type":"integer"},"nonce":{"example":"X1aXj1lFVcqqyoXF","type":"string"},"ttl":{"example":21600,"type":"integer"}},"type":"object"},"name":{"type":"string"}},"type":"object"},"type":"array"}}}],"type":"object"},"access_allow_all_headers":{"description":"Allows all HTTP request headers.","example":true,"type":"boolean"},"access_allow_all_methods":{"description":"Allows all HTTP request methods.","type":"boolean"},"access_allow_all_origins":{"description":"Allows all origins.","type":"boolean"},"access_allow_authenticate_via_warp":{"default":false,"description":"When set to true, users can authenticate via WARP for any application in your organization. Application settings will take precedence over this value.","example":"false","type":"boolean","x-auditable":true},"access_allow_credentials":{"description":"When set to `true`, includes credentials (cookies, authorization headers, or TLS client certificates) with requests.","type":"boolean"},"access_allow_email_alias":{"description":"Enables using Identity Provider email alias as SSH username.","type":"boolean","x-auditable":true},"access_allow_iframe":{"description":"Enables loading application content in an iFrame.","example":true,"type":"boolean"},"access_allowed":{"default":false,"description":"The result of the authentication event.","type":"boolean"},"access_allowed_headers":{"description":"Allowed HTTP request headers.","items":{"type":"string"},"type":"array"},"access_allowed_idps":{"description":"The identity providers your users can select when connecting to this application. Defaults to all IdPs configured in your account.","items":{"description":"The identity providers selected for application.","example":"699d98642c564d2e855e9661899b7252","type":"string"},"type":"array"},"access_allowed_methods":{"description":"Allowed HTTP request methods.","example":["GET"],"items":{"enum":["GET","POST","HEAD","PUT","DELETE","CONNECT","OPTIONS","TRACE","PATCH"],"type":"string"},"type":"array"},"access_allowed_origins":{"description":"Allowed origins.","example":["https://example.com"],"items":{"type":"string"},"type":"array"},"access_any_valid_service_token_rule":{"description":"Matches any valid Access Service Token","properties":{"any_valid_service_token":{"description":"An empty object which matches on all service tokens.","example":{},"type":"object","x-stainless-empty-object":true}},"required":["any_valid_service_token"],"title":"Any Valid Service Token","type":"object"},"access_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"access_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/access_messages"},"messages":{"$ref":"#/components/schemas/access_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"access_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/access_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/access_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"access_api-response-single":{"allOf":[{"$ref":"#/components/schemas/access_api-response-common"}],"type":"object"},"access_app-policies_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/access_uuid"}},"type":"object"}},"type":"object"}],"type":"object"},"access_app-policies_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_app_policy_response"},"type":"array"}},"type":"object"}],"type":"object"},"access_app-policies_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_app_policy_response"}},"type":"object"}],"type":"object"},"access_app_count":{"description":"Number of access applications currently using this policy.","example":2,"type":"integer","x-auditable":true},"access_app_domain":{"description":"The URL of the Access application.","example":"test.example.com/admin","type":"string"},"access_app_id":{"oneOf":[{"$ref":"#/components/schemas/access_identifier"},{"$ref":"#/components/schemas/access_uuid"}]},"access_app_launcher_logo_url":{"description":"The image URL of the logo shown in the App Launcher header.","example":"https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg","type":"string"},"access_app_launcher_props":{"allOf":[{"$ref":"#/components/schemas/access_feature_app_props"},{"properties":{"app_launcher_logo_url":{"$ref":"#/components/schemas/access_app_launcher_logo_url"},"bg_color":{"$ref":"#/components/schemas/access_bg_color"},"domain":{"example":"authdomain.cloudflareaccess.com","readOnly":true},"footer_links":{"$ref":"#/components/schemas/access_footer_links"},"header_bg_color":{"$ref":"#/components/schemas/access_header_bg_color"},"landing_page_design":{"$ref":"#/components/schemas/access_landing_page_design"},"name":{"default":"App Launcher","example":"App Launcher","readOnly":true},"skip_app_launcher_login_page":{"$ref":"#/components/schemas/access_skip_app_launcher_login_page"},"type":{"allOf":[{"$ref":"#/components/schemas/access_type"},{"example":"app_launcher"}]}}}]},"access_app_launcher_visible":{"default":true,"description":"Displays the application in the App Launcher.","example":true,"type":"boolean"},"access_app_policy_link":{"description":"A JSON that links a reusable policy to an application.","properties":{"id":{"$ref":"#/components/schemas/access_schemas-uuid"},"precedence":{"$ref":"#/components/schemas/access_precedence"}},"type":"object"},"access_app_policy_request":{"allOf":[{"properties":{"precedence":{"$ref":"#/components/schemas/access_precedence"}},"type":"object"},{"$ref":"#/components/schemas/access_policy_req"}],"type":"object"},"access_app_policy_response":{"allOf":[{"$ref":"#/components/schemas/access_policy_resp"},{"properties":{"precedence":{"$ref":"#/components/schemas/access_precedence"}},"type":"object"}],"type":"object"},"access_app_req_embedded_policies":{"properties":{"policies":{"description":"The policies that Access applies to the application, in ascending order of precedence. Items can reference existing policies or create new policies exclusive to the application.","items":{"oneOf":[{"$ref":"#/components/schemas/access_app_policy_link"},{"allOf":[{"description":"A policy UID to link to this application."},{"$ref":"#/components/schemas/access_schemas-uuid"}]},{"allOf":[{"type":"object"},{"description":"An application-scoped policy JSON. If the policy does not yet exist, it will be created.","properties":{"id":{"$ref":"#/components/schemas/access_schemas-uuid"}}},{"$ref":"#/components/schemas/access_app_policy_request"}]}]},"type":"array"}},"type":"object"},"access_app_req_embedded_scim_config":{"properties":{"scim_config":{"$ref":"#/components/schemas/access_scim_config"}},"type":"object"},"access_app_request":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/access_self_hosted_props"},{"$ref":"#/components/schemas/access_app_req_embedded_policies"},{"$ref":"#/components/schemas/access_app_req_embedded_scim_config"}],"title":"Self Hosted Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_saas_props"},{"$ref":"#/components/schemas/access_app_req_embedded_policies"},{"$ref":"#/components/schemas/access_app_req_embedded_scim_config"}],"title":"SaaS Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_ssh_props"},{"$ref":"#/components/schemas/access_app_req_embedded_policies"},{"$ref":"#/components/schemas/access_app_req_embedded_scim_config"}],"title":"Browser SSH Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_vnc_props"},{"$ref":"#/components/schemas/access_app_req_embedded_policies"},{"$ref":"#/components/schemas/access_app_req_embedded_scim_config"}],"title":"Browser VNC Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_app_launcher_props"},{"$ref":"#/components/schemas/access_app_req_embedded_policies"}],"title":"App Launcher Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_warp_props"},{"$ref":"#/components/schemas/access_app_req_embedded_policies"}],"title":"Device Enrollment Permissions Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_biso_props"},{"$ref":"#/components/schemas/access_app_req_embedded_policies"}],"title":"Browser Isolation Permissions Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_proxy_endpoint_props"},{"$ref":"#/components/schemas/access_app_req_embedded_policies"}],"title":"Gateway Identity Proxy Endpoint Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_bookmark_props"}],"title":"Bookmark application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_infra_props"},{"$ref":"#/components/schemas/access_infra_app_req_embedded_policies"}],"title":"Infrastructure application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_rdp_props"},{"$ref":"#/components/schemas/access_app_req_embedded_policies"}],"title":"Browser RDP Application","type":"object"}]},"access_app_resp_embedded_policies":{"description":"The policies that Access applies to the application.","properties":{"policies":{"items":{"$ref":"#/components/schemas/access_app_policy_response"},"type":"array"}},"type":"object"},"access_app_resp_embedded_target_criteria_infra":{"description":"Contains the targets secured by the application.","properties":{"target_criteria":{"items":{"$ref":"#/components/schemas/access_target_criteria_infra_app"},"type":"array"}},"type":"object"},"access_app_resp_embedded_target_criteria_self_hosted":{"description":"Contains the targets secured by the application.","properties":{"target_criteria":{"items":{"$ref":"#/components/schemas/access_target_criteria_self_hosted_app"},"type":"array"}},"type":"object"},"access_app_response":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/access_basic_app_response_props"},{"$ref":"#/components/schemas/access_self_hosted_props"},{"$ref":"#/components/schemas/access_app_resp_embedded_policies"}],"title":"Self Hosted Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_basic_app_response_props"},{"$ref":"#/components/schemas/access_saas_props"},{"$ref":"#/components/schemas/access_app_resp_embedded_policies"}],"title":"SaaS Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_basic_app_response_props"},{"$ref":"#/components/schemas/access_ssh_props"},{"$ref":"#/components/schemas/access_app_resp_embedded_policies"}],"title":"Browser SSH Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_basic_app_response_props"},{"$ref":"#/components/schemas/access_vnc_props"},{"$ref":"#/components/schemas/access_app_resp_embedded_policies"}],"title":"Browser VNC Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_basic_app_response_props"},{"$ref":"#/components/schemas/access_app_launcher_props"},{"$ref":"#/components/schemas/access_app_resp_embedded_policies"}],"title":"App Launcher Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_basic_app_response_props"},{"$ref":"#/components/schemas/access_warp_props"},{"$ref":"#/components/schemas/access_app_resp_embedded_policies"}],"title":"Device Enrollment Permissions Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_basic_app_response_props"},{"$ref":"#/components/schemas/access_biso_props"},{"$ref":"#/components/schemas/access_app_resp_embedded_policies"}],"title":"Browser Isolation Permissions Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_basic_app_response_props"},{"$ref":"#/components/schemas/access_proxy_endpoint_props"},{"$ref":"#/components/schemas/access_app_resp_embedded_policies"}],"title":"Gateway Identity Proxy Endpoint Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_basic_app_response_props"},{"$ref":"#/components/schemas/access_bookmark_props"}],"title":"Bookmark application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_basic_app_response_props"},{"$ref":"#/components/schemas/access_infra_props"},{"$ref":"#/components/schemas/access_infra_app_resp_embedded_policies"}],"title":"Infrastructure application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_basic_app_response_props"},{"$ref":"#/components/schemas/access_rdp_props"},{"$ref":"#/components/schemas/access_app_resp_embedded_policies"}],"title":"Browser RDP Application","type":"object"}]},"access_app_settings_request":{"properties":{"allow_iframe":{"$ref":"#/components/schemas/access_allow_iframe"},"skip_interstitial":{"$ref":"#/components/schemas/access_skip_interstitial"}},"type":"object"},"access_app_settings_response":{"properties":{"allow_iframe":{"$ref":"#/components/schemas/access_allow_iframe"},"skip_interstitial":{"$ref":"#/components/schemas/access_skip_interstitial"}},"type":"object"},"access_app_uid":{"description":"The unique identifier for the Access application.","example":"df7e2w5f-02b7-4d9d-af26-8d1988fca630","type":"string"},"access_approval_group":{"description":"A group of email addresses that can approve a temporary authentication request.","properties":{"approvals_needed":{"description":"The number of approvals needed to obtain access.","example":1,"minimum":0,"type":"number"},"email_addresses":{"description":"A list of emails that can approve the access request.","example":["test@cloudflare.com","test2@cloudflare.com"],"items":{"type":"string"},"type":"array"},"email_list_uuid":{"description":"The UUID of an re-usable email list.","type":"string"}},"required":["approvals_needed"],"type":"object"},"access_approval_groups":{"description":"Administrators who can approve a temporary authentication request.","example":[{"approvals_needed":1,"email_addresses":["test1@cloudflare.com","test2@cloudflare.com"]},{"approvals_needed":3,"email_list_uuid":"597147a1-976b-4ef2-9af0-81d5d007fc34"}],"items":{"$ref":"#/components/schemas/access_approval_group"},"type":"array","x-stainless-collection-type":"set"},"access_approval_required":{"description":"Requires the user to request access from an administrator at the start of each session.","example":true,"type":"boolean"},"access_apps":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/access_schemas-basic_app_response_props"},{"$ref":"#/components/schemas/access_schemas-self_hosted_props"}],"title":"Self Hosted Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_schemas-basic_app_response_props"},{"$ref":"#/components/schemas/access_schemas-saas_props"}],"title":"SaaS Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_schemas-basic_app_response_props"},{"$ref":"#/components/schemas/access_schemas-ssh_props"}],"title":"Browser SSH Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_schemas-basic_app_response_props"},{"$ref":"#/components/schemas/access_schemas-vnc_props"}],"title":"Browser VNC Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_schemas-basic_app_response_props"},{"$ref":"#/components/schemas/access_schemas-app_launcher_props"}],"title":"App Launcher Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_schemas-basic_app_response_props"},{"$ref":"#/components/schemas/access_schemas-warp_props"}],"title":"Device Enrollment Permissions Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_schemas-basic_app_response_props"},{"$ref":"#/components/schemas/access_schemas-biso_props"}],"title":"Browser Isolation Permissions Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/access_schemas-basic_app_response_props"},{"$ref":"#/components/schemas/access_schemas-bookmark_props"}],"title":"Bookmark application","type":"object"}],"type":"object"},"access_apps_components-schemas-name":{"description":"The name of the application.","example":"Admin Site","type":"string"},"access_apps_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_app_response"},"type":"array"}}}],"type":"object"},"access_apps_components-schemas-response_collection-2":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_apps"},"type":"array"}}}],"type":"object"},"access_apps_components-schemas-session_duration":{"default":"24h","description":"The amount of time that tokens issued for this application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.","example":"24h","type":"string"},"access_apps_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_app_response"}}}],"type":"object"},"access_apps_components-schemas-single_response-2":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_apps"}}}],"type":"object"},"access_associated_hostnames":{"description":"The hostnames of the applications that will use this certificate.","items":{"description":"A fully-qualified domain name (FQDN).","example":"admin.example.com","type":"string","x-auditable":true},"type":"array"},"access_aud":{"description":"The Application Audience (AUD) tag. Identifies the application associated with the CA.","example":"737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893","maxLength":64,"readOnly":true,"type":"string","x-auditable":true},"access_auth_context_rule":{"description":"Matches an Azure Authentication Context.\nRequires an Azure identity provider.","properties":{"auth_context":{"properties":{"ac_id":{"description":"The ACID of an Authentication context.","example":"ea85612a-29c8-46c2-bacb-669d65136971","type":"string"},"id":{"description":"The ID of an Authentication context.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f","type":"string"},"identity_provider_id":{"description":"The ID of your Azure identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971","type":"string"}},"required":["id","identity_provider_id","ac_id"],"type":"object"}},"required":["auth_context"],"title":"Authentication Context","type":"object"},"access_auth_domain":{"description":"The unique subdomain assigned to your Zero Trust organization.","example":"test.cloudflareaccess.com","type":"string","x-auditable":true},"access_authentication_method_rule":{"description":"Enforce different MFA options","properties":{"auth_method":{"properties":{"auth_method":{"description":"The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176#section-2.","example":"mfa","type":"string"}},"required":["auth_method"],"type":"object"}},"required":["auth_method"],"title":"Authentication method","type":"object"},"access_auto_redirect_to_identity":{"default":false,"description":"When set to `true`, users skip the identity provider selection step during login.","type":"boolean","x-auditable":true},"access_azureAD":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_generic-oauth-config"},{"$ref":"#/components/schemas/access_custom-claims-support"},{"properties":{"conditional_access_enabled":{"description":"Should Cloudflare try to load authentication contexts from your account","type":"boolean","x-auditable":true},"directory_id":{"description":"Your Azure directory uuid","example":"\u003cyour azure directory uuid\u003e","type":"string","x-auditable":true},"prompt":{"description":"Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether.","enum":["login","select_account","none"],"type":"string","x-auditable":true},"support_groups":{"description":"Should Cloudflare try to load groups from your account","type":"boolean","x-auditable":true}},"type":"object"}],"type":"object"}},"type":"object"}],"title":"Azure AD","type":"object"},"access_azure_group_rule":{"description":"Matches an Azure group.\nRequires an Azure identity provider.","properties":{"azureAD":{"properties":{"id":{"description":"The ID of an Azure group.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f","type":"string"},"identity_provider_id":{"description":"The ID of your Azure identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971","type":"string"}},"required":["id","identity_provider_id"],"type":"object"}},"required":["azureAD"],"title":"Azure group","type":"object"},"access_base_policy_req":{"properties":{"decision":{"$ref":"#/components/schemas/access_decision"},"exclude":{"$ref":"#/components/schemas/access_schemas-exclude"},"include":{"$ref":"#/components/schemas/access_schemas-include"},"name":{"$ref":"#/components/schemas/access_policy_components-schemas-name"},"require":{"$ref":"#/components/schemas/access_schemas-require"}},"required":["name","decision","include"],"type":"object"},"access_base_policy_resp":{"properties":{"created_at":{"$ref":"#/components/schemas/access_timestamp"},"decision":{"$ref":"#/components/schemas/access_decision"},"exclude":{"$ref":"#/components/schemas/access_schemas-exclude"},"id":{"$ref":"#/components/schemas/access_schemas-uuid"},"include":{"$ref":"#/components/schemas/access_schemas-include"},"name":{"$ref":"#/components/schemas/access_policy_components-schemas-name"},"require":{"$ref":"#/components/schemas/access_schemas-require"},"updated_at":{"$ref":"#/components/schemas/access_timestamp"}},"type":"object"},"access_basic_app_response_props":{"properties":{"aud":{"$ref":"#/components/schemas/access_schemas-aud"},"created_at":{"$ref":"#/components/schemas/access_created_at"},"id":{"$ref":"#/components/schemas/access_uuid"},"updated_at":{"$ref":"#/components/schemas/access_updated_at"}},"type":"object"},"access_bg_color":{"description":"The background color of the App Launcher page.","example":"#ff0000","type":"string"},"access_biso_props":{"allOf":[{"$ref":"#/components/schemas/access_feature_app_props"},{"properties":{"domain":{"example":"authdomain.cloudflareaccess.com/browser","readOnly":true},"name":{"default":"Clientless Web Isolation","example":"Clientless Web Isolation","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/access_type"},{"example":"biso"}]}}}]},"access_bookmark_props":{"properties":{"app_launcher_visible":{"$ref":"#/components/schemas/access_app_launcher_visible"},"domain":{"description":"The URL or domain of the bookmark.","example":"https://mybookmark.com","type":"string"},"logo_url":{"$ref":"#/components/schemas/access_logo_url"},"name":{"$ref":"#/components/schemas/access_apps_components-schemas-name"},"tags":{"$ref":"#/components/schemas/access_tags"},"type":{"allOf":[{"$ref":"#/components/schemas/access_type"},{"example":"bookmark"}]}},"title":"Bookmark application","type":"object"},"access_bookmarks":{"properties":{"app_launcher_visible":{"$ref":"#/components/schemas/access_schemas-app_launcher_visible"},"created_at":{"$ref":"#/components/schemas/access_created_at"},"domain":{"$ref":"#/components/schemas/access_schemas-domain"},"id":{"description":"The unique identifier for the Bookmark application.","type":"string"},"logo_url":{"$ref":"#/components/schemas/access_schemas-logo_url"},"name":{"$ref":"#/components/schemas/access_bookmarks_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/access_updated_at"}},"type":"object"},"access_bookmarks_components-schemas-name":{"description":"The name of the Bookmark application.","example":"My Website","type":"string","x-auditable":true},"access_bookmarks_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_bookmarks"},"type":"array"}}}],"type":"object"},"access_bookmarks_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_bookmarks"}}}],"type":"object"},"access_button_color":{"description":"The background color of the log in button on the landing page.","example":"#ff0000","type":"string"},"access_button_text_color":{"description":"The color of the text in the log in button on the landing page.","example":"#ff0000","type":"string"},"access_ca":{"properties":{"aud":{"$ref":"#/components/schemas/access_aud"},"id":{"$ref":"#/components/schemas/access_schemas-id"},"public_key":{"$ref":"#/components/schemas/access_public_key"}},"type":"object"},"access_ca_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/access_components-schemas-id"}},"type":"object"}}}],"type":"object"},"access_ca_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_ca"},"type":"array"}}}],"type":"object"},"access_ca_components-schemas-response_collection-2":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_schemas-ca"},"type":"array"}}}],"type":"object"},"access_ca_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_ca"}}}],"type":"object"},"access_ca_components-schemas-single_response-2":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_schemas-ca"}}}],"type":"object"},"access_centrify":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_generic-oauth-config"},{"$ref":"#/components/schemas/access_custom-claims-support"},{"properties":{"centrify_account":{"description":"Your centrify account url","example":"https://abc123.my.centrify.com/","type":"string","x-auditable":true},"centrify_app_id":{"description":"Your centrify app id","example":"exampleapp","type":"string","x-auditable":true}},"type":"object"}]}},"type":"object"}],"title":"Centrify","type":"object"},"access_certificate_rule":{"description":"Matches any valid client certificate.","example":{"certificate":{}},"properties":{"certificate":{"example":{},"type":"object","x-stainless-empty-object":true}},"required":["certificate"],"title":"Valid certificate","type":"object"},"access_certificates":{"properties":{"associated_hostnames":{"$ref":"#/components/schemas/access_associated_hostnames"},"created_at":{"$ref":"#/components/schemas/access_created_at"},"expires_on":{"$ref":"#/components/schemas/access_timestamp"},"fingerprint":{"$ref":"#/components/schemas/access_fingerprint"},"id":{"description":"The ID of the application that will use this certificate.","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/access_certificates_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/access_updated_at"}},"type":"object"},"access_certificates_components-schemas-name":{"description":"The name of the certificate.","example":"Allow devs","type":"string","x-auditable":true},"access_certificates_components-schemas-name-2":{"description":"The name of the certificate.","example":"Allow devs","type":"string"},"access_certificates_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_certificates"},"type":"array"}}}],"type":"object"},"access_certificates_components-schemas-response_collection-2":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_components-schemas-certificates"},"type":"array"}}}],"type":"object"},"access_certificates_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_certificates"}}}],"type":"object"},"access_certificates_components-schemas-single_response-2":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_components-schemas-certificates"}}}],"type":"object"},"access_cf_resource_id":{"description":"The unique Cloudflare-generated Id of the SCIM Group resource; also known as the \"Id\".","example":"a2abeb50-59c9-4c01-8c5c-963d3bf5700f","type":"string"},"access_client_id":{"description":"The Client ID for the service token. Access will check for this value in the `CF-Access-Client-ID` request header.","example":"88bf3b6d86161464f6509f7219099e57.access.example.com","type":"string"},"access_client_secret":{"description":"The Client Secret for the service token. Access will check for this value in the `CF-Access-Client-Secret` request header.","example":"bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5","type":"string","x-sensitive":true},"access_client_secret_version":{"default":1,"description":"A version number identifying the current `client_secret` associated with the service token. Incrementing it triggers a rotation; the previous secret will still be accepted until the time indicated by `previous_client_secret_expires_at`.","type":"number","x-auditable":true},"access_common_name_rule":{"description":"Matches a specific common name.","properties":{"common_name":{"properties":{"common_name":{"description":"The common name to match.","example":"james@example.com","type":"string"}},"required":["common_name"],"type":"object"}},"required":["common_name"],"title":"Common Name","type":"object"},"access_components-schemas-aud":{"description":"The Application Audience (AUD) tag. Identifies the application associated with the CA.","example":"737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893","maxLength":64,"readOnly":true,"type":"string"},"access_components-schemas-certificates":{"properties":{"associated_hostnames":{"$ref":"#/components/schemas/access_schemas-associated_hostnames"},"created_at":{"$ref":"#/components/schemas/access_timestamp"},"expires_on":{"$ref":"#/components/schemas/access_timestamp"},"fingerprint":{"$ref":"#/components/schemas/access_fingerprint"},"id":{"description":"The ID of the application that will use this certificate."},"name":{"$ref":"#/components/schemas/access_certificates_components-schemas-name-2"},"updated_at":{"$ref":"#/components/schemas/access_timestamp"}},"type":"object"},"access_components-schemas-domain":{"description":"The domain and path that Access will secure.","example":"test.example.com/admin","type":"string"},"access_components-schemas-email":{"description":"The email address of the authenticating user.","example":"user@example.com","format":"email","type":"string"},"access_components-schemas-exclude":{"description":"Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.","items":{"$ref":"#/components/schemas/access_rule"},"type":"array"},"access_components-schemas-groups":{"properties":{"created_at":{"$ref":"#/components/schemas/access_timestamp"},"exclude":{"$ref":"#/components/schemas/access_exclude"},"id":{"$ref":"#/components/schemas/access_uuid"},"include":{"$ref":"#/components/schemas/access_include"},"name":{"$ref":"#/components/schemas/access_groups_components-schemas-name-2"},"require":{"$ref":"#/components/schemas/access_require"},"updated_at":{"$ref":"#/components/schemas/access_timestamp"}},"type":"object"},"access_components-schemas-id":{"description":"The ID of the CA.","example":"7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9","maxLength":48,"readOnly":true,"type":"string"},"access_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-common"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/access_uuid"}},"type":"object"}}}],"type":"object"},"access_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252","type":"string","x-auditable":true},"access_components-schemas-name":{"description":"The name of the identity provider, shown to users on the login page.","example":"Widget Corps IDP","type":"string"},"access_components-schemas-require":{"description":"Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.","items":{"$ref":"#/components/schemas/access_rule"},"type":"array"},"access_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_service-tokens"},"type":"array"}}}],"type":"object"},"access_components-schemas-session_duration":{"default":"24h","description":"The amount of time that tokens issued for the application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.","example":"24h","type":"string"},"access_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_identity-providers"}}}],"type":"object"},"access_components-schemas-type":{"description":"The application type.","enum":["self_hosted","saas","ssh","vnc","app_launcher","warp","biso","bookmark","dash_sso"],"example":"self_hosted","type":"string"},"access_connection":{"description":"The IdP used to authenticate.","example":"saml","type":"string"},"access_connection_rules":{"description":"The rules that define how users may connect to the targets secured by your application.","properties":{"ssh":{"$ref":"#/components/schemas/access_connection_rules_ssh"}},"title":"Connection Rules","type":"object"},"access_connection_rules_ssh":{"description":"The SSH-specific rules that define how users may connect to the targets secured by your application.","properties":{"allow_email_alias":{"$ref":"#/components/schemas/access_allow_email_alias"},"usernames":{"$ref":"#/components/schemas/access_usernames"}},"required":["usernames"],"title":"SSH Connection Rules","type":"object"},"access_cors_headers":{"properties":{"allow_all_headers":{"$ref":"#/components/schemas/access_allow_all_headers"},"allow_all_methods":{"$ref":"#/components/schemas/access_allow_all_methods"},"allow_all_origins":{"$ref":"#/components/schemas/access_allow_all_origins"},"allow_credentials":{"$ref":"#/components/schemas/access_allow_credentials"},"allowed_headers":{"$ref":"#/components/schemas/access_allowed_headers"},"allowed_methods":{"$ref":"#/components/schemas/access_allowed_methods"},"allowed_origins":{"$ref":"#/components/schemas/access_allowed_origins"},"max_age":{"$ref":"#/components/schemas/access_max_age"}},"type":"object"},"access_country_rule":{"description":"Matches a specific country","properties":{"geo":{"properties":{"country_code":{"description":"The country code that should be matched.","example":"US","type":"string"}},"required":["country_code"],"type":"object"}},"required":["geo"],"title":"Country","type":"object"},"access_create_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"properties":{"client_id":{"$ref":"#/components/schemas/access_client_id"},"client_secret":{"$ref":"#/components/schemas/access_client_secret"},"created_at":{"$ref":"#/components/schemas/access_created_at"},"duration":{"$ref":"#/components/schemas/access_duration"},"id":{"description":"The ID of the service token.","type":"string"},"name":{"$ref":"#/components/schemas/access_schemas-name"},"updated_at":{"$ref":"#/components/schemas/access_updated_at"}},"type":"object"}}}],"type":"object"},"access_created_at":{"allOf":[{"x-stainless-skip":true},{"$ref":"#/components/schemas/access_timestamp"}]},"access_custom-claims-support":{"properties":{"claims":{"description":"Custom claims","example":["email_verified","preferred_username","custom_claim_name"],"items":{"type":"string"},"type":"array","x-auditable":true},"email_claim_name":{"description":"The claim name for email in the id_token response.","example":"custom_claim_name","type":"string","x-auditable":true}},"type":"object"},"access_custom-pages_components-schemas-name":{"description":"Custom page name.","type":"string","x-auditable":true},"access_custom-pages_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_custom_page_without_html"},"type":"array"}}}],"type":"object"},"access_custom-pages_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_custom_page"}}}],"type":"object"},"access_custom_deny_message":{"description":"The custom error message shown to a user when they are denied access to the application.","type":"string"},"access_custom_deny_url":{"description":"The custom URL a user is redirected to when they are denied access to the application when failing identity-based rules.","type":"string"},"access_custom_non_identity_deny_url":{"description":"The custom URL a user is redirected to when they are denied access to the application when failing non-identity rules.","type":"string"},"access_custom_page":{"properties":{"app_count":{"$ref":"#/components/schemas/access_schemas-app_count"},"created_at":{"$ref":"#/components/schemas/access_created_at"},"custom_html":{"description":"Custom page HTML.","example":"\u003chtml\u003e\u003cbody\u003e\u003ch1\u003eAccess Denied\u003c/h1\u003e\u003c/body\u003e\u003c/html\u003e","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/access_custom-pages_components-schemas-name"},"type":{"$ref":"#/components/schemas/access_schemas-type"},"uid":{"$ref":"#/components/schemas/access_uuid"},"updated_at":{"$ref":"#/components/schemas/access_updated_at"}},"required":["name","custom_html","type"],"type":"object"},"access_custom_page_without_html":{"properties":{"app_count":{"$ref":"#/components/schemas/access_schemas-app_count"},"created_at":{"$ref":"#/components/schemas/access_created_at"},"name":{"$ref":"#/components/schemas/access_custom-pages_components-schemas-name"},"type":{"$ref":"#/components/schemas/access_schemas-type"},"uid":{"$ref":"#/components/schemas/access_uuid"},"updated_at":{"$ref":"#/components/schemas/access_updated_at"}},"required":["name","type"],"type":"object"},"access_custom_pages":{"properties":{"forbidden":{"description":"The uid of the custom page to use when a user is denied access after failing a non-identity rule.","example":"699d98642c564d2e855e9661899b7252","type":"string"},"identity_denied":{"description":"The uid of the custom page to use when a user is denied access.","example":"699d98642c564d2e855e9661899b7252","type":"string"}},"type":"object"},"access_days_until_next_rotation":{"description":"The number of days until the next key rotation.","example":1,"readOnly":true,"type":"number","x-auditable":true},"access_decision":{"description":"The action Access will take if a user matches this policy. Infrastructure application policies can only use the Allow action.","enum":["allow","deny","non_identity","bypass"],"example":"allow","type":"string"},"access_destinations":{"default":[],"description":"List of destinations secured by Access. This supersedes `self_hosted_domains` to allow for more flexibility in defining different types of domains. If `destinations` are provided, then `self_hosted_domains` will be ignored.\n","example":[{"type":"public","uri":"test.example.com/admin"},{"type":"public","uri":"test.anotherexample.com/staff"},{"cidr":"10.5.0.0/24","port_range":"80-90","type":"private"},{"cidr":"10.5.0.3/32","port_range":"80","type":"private"},{"hostname":"private-sni.example.com","type":"private"},{"mcp_server_id":"mcp-server-1","type":"via_mcp_server_portal"}],"items":{"oneOf":[{"description":"A public hostname that Access will secure. Public destinations support sub-domain and path. Wildcard '*' can be used in the definition.\n","properties":{"type":{"enum":["public"],"type":"string"},"uri":{"description":"The URI of the destination. Public destinations' URIs can include a domain and path with [wildcards](https://developers.cloudflare.com/cloudflare-one/policies/access/app-paths/).\n","type":"string"}},"title":"Public destination","type":"object"},{"properties":{"cidr":{"description":"The CIDR range of the destination. Single IPs will be computed as /32.","type":"string"},"hostname":{"description":"The hostname of the destination. Matches a valid SNI served by an HTTPS origin.","type":"string"},"l4_protocol":{"description":"The L4 protocol of the destination. When omitted, both UDP and TCP traffic will match.","enum":["tcp","udp"],"type":"string"},"port_range":{"description":"The port range of the destination. Can be a single port or a range of ports. When omitted, all ports will match.\n","type":"string"},"type":{"enum":["private"],"type":"string"},"vnet_id":{"description":"The VNET ID to match the destination. When omitted, all VNETs will match.","type":"string"}},"title":"Private destination","type":"object"},{"description":"A MCP server id configured in ai-controls. Access will secure the MCP server if accessed through a MCP portal.\n","properties":{"mcp_server_id":{"description":"The MCP server id configured in ai-controls.","type":"string"},"type":{"enum":["via_mcp_server_portal"],"type":"string"}},"title":"Via MCP Server Portal destination","type":"object"}]},"type":"array"},"access_device_posture_check":{"properties":{"exists":{"type":"boolean","x-auditable":true},"path":{"type":"string","x-auditable":true}},"type":"object"},"access_device_posture_rule":{"description":"Enforces a device posture rule has run successfully","properties":{"device_posture":{"properties":{"integration_uid":{"description":"The ID of a device posture integration.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f","type":"string"}},"required":["integration_uid"],"type":"object"}},"required":["device_posture"],"title":"Device Posture","type":"object"},"access_device_session":{"example":{"last_authenticated":1638832687},"properties":{"last_authenticated":{"type":"number","x-auditable":true}},"type":"object"},"access_direction":{"default":"desc","description":"The chronological order used to sort the logs.","enum":["desc","asc"],"example":"desc","type":"string"},"access_doh_jwt_duration":{"description":"The duration the DoH JWT is valid for. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.  Note that the maximum duration for this setting is the same as the key rotation period on the account. Default expiration is 24h","example":"800h","type":"string","x-auditable":true},"access_domain":{"description":"The primary hostname and path secured by Access. This domain will be displayed if the app is visible in the App Launcher.","example":"test.example.com/admin","type":"string"},"access_domain_rule":{"description":"Match an entire email domain.","properties":{"email_domain":{"properties":{"domain":{"description":"The email domain to match.","example":"example.com","type":"string"}},"required":["domain"],"type":"object"}},"required":["email_domain"],"title":"Email domain","type":"object"},"access_duration":{"default":"8760h","description":"The duration for how long the service token will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The default is 1 year in hours (8760h).","example":"60m","type":"string","x-auditable":true},"access_email":{"description":"The email address of the SCIM User resource.","example":"john.smith@example.com","type":"string"},"access_email_list_rule":{"description":"Matches an email address from a list.","properties":{"email_list":{"properties":{"id":{"description":"The ID of a previously created email list.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f","type":"string"}},"required":["id"],"type":"object"}},"required":["email_list"],"title":"Email list","type":"object"},"access_email_rule":{"description":"Matches a specific email.","properties":{"email":{"properties":{"email":{"description":"The email of the user.","example":"test@example.com","format":"email","type":"string"}},"required":["email"],"type":"object"}},"required":["email"],"title":"Email","type":"object"},"access_empty_response":{"allOf":[{"properties":{"result":{"enum":[true,false],"example":true,"type":"boolean"},"success":{"enum":[true,false],"example":true,"type":"boolean"}}}],"type":"object"},"access_enable_binding_cookie":{"default":false,"description":"Enables the binding cookie, which increases security against compromised authorization tokens and CSRF attacks.","type":"boolean"},"access_everyone_rule":{"description":"Matches everyone.","properties":{"everyone":{"description":"An empty object which matches on all users.","example":{},"type":"object","x-stainless-empty-object":true}},"required":["everyone"],"title":"Everyone","type":"object"},"access_exclude":{"description":"Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.","items":{"$ref":"#/components/schemas/access_rule"},"type":"array"},"access_externalId":{"description":"The IdP-generated Id of the SCIM resource.","example":"all_employees","type":"string"},"access_external_evaluation_rule":{"description":"Create Allow or Block policies which evaluate the user based on custom criteria.","properties":{"external_evaluation":{"properties":{"evaluate_url":{"description":"The API endpoint containing your business logic.","example":"https://eval.example.com","type":"string"},"keys_url":{"description":"The API endpoint containing the key that Access uses to verify that the response came from your API.","example":"https://eval.example.com/keys","type":"string"}},"required":["evaluate_url","keys_url"],"type":"object"}},"required":["external_evaluation"],"title":"External Evaluation","type":"object"},"access_facebook":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/access_generic-oauth-config"}},"type":"object"}],"title":"Facebook","type":"object"},"access_failed_login_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"properties":{"expiration":{"type":"integer"},"metadata":{"example":{"app_name":"Test App","aud":"39691c1480a2352a18ece567debc2b32552686cbd38eec0887aa18d5d3f00c04","datetime":"2022-02-02T21:54:34.914Z","ray_id":"6d76a8a42ead4133","user_email":"test@cloudflare.com","user_uuid":"57171132-e453-4ee8-b2a5-8cbaad333207"},"type":"object"}},"type":"object"},"type":"array"}}}],"type":"object"},"access_feature_app_props":{"properties":{"allowed_idps":{"$ref":"#/components/schemas/access_allowed_idps"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/access_schemas-auto_redirect_to_identity"},"custom_deny_url":{"$ref":"#/components/schemas/access_custom_deny_url"},"custom_non_identity_deny_url":{"$ref":"#/components/schemas/access_custom_non_identity_deny_url"},"custom_pages":{"$ref":"#/components/schemas/access_schemas-custom_pages"},"domain":{"$ref":"#/components/schemas/access_domain"},"name":{"$ref":"#/components/schemas/access_apps_components-schemas-name"},"session_duration":{"$ref":"#/components/schemas/access_schemas-session_duration"},"type":{"$ref":"#/components/schemas/access_type"}},"required":["type"],"type":"object"},"access_fingerprint":{"description":"The MD5 fingerprint of the certificate.","example":"MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91","type":"string"},"access_footer_links":{"description":"The links in the App Launcher footer.","example":[{"name":"Cloudflare's Privacy Policy","url":"https://www.cloudflare.com/privacypolicy/"}],"items":{"properties":{"name":{"description":"The hypertext in the footer link.","example":"Cloudflare's Privacy Policy","type":"string"},"url":{"description":"the hyperlink in the footer link.","example":"https://www.cloudflare.com/privacypolicy/","type":"string"}},"required":["name","url"],"type":"object"},"type":"array"},"access_gateway_ca_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_schemas-certificates"},"type":"array"}}}],"type":"object"},"access_gateway_ca_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_schemas-certificates"}}}],"type":"object"},"access_gateway_seat":{"description":"True if the seat is part of Gateway.","example":false,"type":"boolean","x-auditable":true},"access_generic-oauth-config":{"properties":{"client_id":{"description":"Your OAuth Client ID","example":"\u003cyour client id\u003e","type":"string"},"client_secret":{"description":"Your OAuth Client Secret","example":"\u003cyour client secret\u003e","type":"string","x-sensitive":true}},"type":"object"},"access_geo":{"example":{"country":"US"},"properties":{"country":{"type":"string","x-auditable":true}},"type":"object"},"access_github":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/access_generic-oauth-config"}},"type":"object"}],"title":"GitHub","type":"object"},"access_github_organization_rule":{"description":"Matches a Github organization.\nRequires a Github identity provider.","properties":{"github-organization":{"properties":{"identity_provider_id":{"description":"The ID of your Github identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971","type":"string"},"name":{"description":"The name of the organization.","example":"cloudflare","type":"string"},"team":{"description":"The name of the team","example":"api-team","type":"string"}},"required":["name","identity_provider_id"],"type":"object"}},"required":["github-organization"],"title":"Github organization","type":"object"},"access_google":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_generic-oauth-config"},{"$ref":"#/components/schemas/access_custom-claims-support"}]}},"type":"object"}],"title":"Google","type":"object"},"access_google-apps":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_generic-oauth-config"},{"$ref":"#/components/schemas/access_custom-claims-support"},{"properties":{"apps_domain":{"description":"Your companies TLD","example":"mycompany.com","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Google Workspace","type":"object"},"access_groups":{"properties":{"displayName":{"description":"The display name of the SCIM Group resource.","example":"ALL EMPLOYEES","type":"string"},"externalId":{"$ref":"#/components/schemas/access_externalId"},"id":{"$ref":"#/components/schemas/access_id"},"meta":{"$ref":"#/components/schemas/access_meta"},"schemas":{"description":"The list of URIs which indicate the attributes contained within a SCIM resource.","example":["urn:ietf:params:scim:schemas:core:2.0:Group"],"items":{"type":"string"},"type":"array"}},"type":"object"},"access_groups-name":{"description":"The display name of the SCIM Group resource.","example":"ALL_EMPLOYEES","type":"string"},"access_groups_components-schemas-name":{"description":"The name of the Access group.","example":"Allow devs","type":"string","x-auditable":true},"access_groups_components-schemas-name-2":{"description":"The name of the Access group.","example":"Allow devs","type":"string"},"access_groups_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_components-schemas-groups"},"type":"array"}}}],"type":"object"},"access_groups_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_schemas-groups"}}}],"type":"object"},"access_groups_components-schemas-single_response-2":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_components-schemas-groups"}}}],"type":"object"},"access_gsuite_group_rule":{"description":"Matches a group in Google Workspace.\nRequires a Google Workspace identity provider.","properties":{"gsuite":{"properties":{"email":{"description":"The email of the Google Workspace group.","example":"devs@cloudflare.com","type":"string"},"identity_provider_id":{"description":"The ID of your Google Workspace identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971","type":"string"}},"required":["email","identity_provider_id"],"type":"object"}},"required":["gsuite"],"title":"Google Workspace group","type":"object"},"access_header_bg_color":{"description":"The background color of the App Launcher header.","example":"#ff0000","type":"string"},"access_http_only_cookie_attribute":{"default":true,"description":"Enables the HttpOnly cookie attribute, which increases security against XSS attacks.","example":true,"type":"boolean"},"access_id":{"description":"The unique Cloudflare-generated Id of the SCIM resource.","example":"bd97ef8d-7986-43e3-9ee0-c25dda33e4b0","type":"string"},"access_id_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/access_uuid"}},"type":"object"}}}],"type":"object"},"access_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"access_identity":{"properties":{"account_id":{"example":"1234567890","type":"string","x-auditable":true},"auth_status":{"example":"NONE","type":"string","x-auditable":true},"common_name":{"example":"","type":"string"},"devicePosture":{"additionalProperties":{"$ref":"#/components/schemas/access_schemas-device_posture_rule"},"type":"object"},"device_id":{"example":"","type":"string"},"device_sessions":{"$ref":"#/components/schemas/access_string_key_map_device_session"},"email":{"example":"test@cloudflare.com","type":"string"},"geo":{"$ref":"#/components/schemas/access_geo"},"iat":{"example":1694791905,"type":"number"},"idp":{"properties":{"id":{"type":"string"},"type":{"type":"string"}},"type":"object"},"ip":{"example":"127.0.0.0","type":"string"},"is_gateway":{"example":false,"type":"boolean"},"is_warp":{"example":false,"type":"boolean"},"mtls_auth":{"properties":{"auth_status":{"type":"string"},"cert_issuer_dn":{"type":"string"},"cert_issuer_ski":{"type":"string"},"cert_presented":{"type":"boolean"},"cert_serial":{"type":"string"}},"type":"object"},"service_token_id":{"example":"","type":"string"},"service_token_status":{"example":false,"type":"boolean"},"user_uuid":{"example":"57cf8cf2-f55a-4588-9ac9-f5e41e9f09b4","type":"string"},"version":{"example":2,"type":"number"}},"type":"object"},"access_identity-provider":{"properties":{"config":{"description":"The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).","type":"object"},"id":{"$ref":"#/components/schemas/access_uuid"},"name":{"$ref":"#/components/schemas/access_components-schemas-name"},"scim_config":{"description":"The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.","properties":{"enabled":{"default":false,"description":"A flag to enable or disable SCIM for the identity provider.","type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"identity_update_behavior":{"default":"no_action","description":"Indicates how a SCIM event updates a user identity used for policy evaluation. Use \"automatic\" to automatically update a user's identity and augment it with fields from the SCIM user resource. Use \"reauth\" to force re-authentication on group membership updates, user identity update will only occur after successful re-authentication. With \"reauth\" identities will not contain fields from the SCIM user resource. With \"no_action\" identities will not be changed by SCIM updates in any way and users will not be prompted to reauthenticate.","enum":["automatic","reauth","no_action"],"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"scim_base_url":{"description":"The base URL of Cloudflare's SCIM V2.0 API endpoint.","readOnly":true,"type":"string","x-auditable":true},"seat_deprovision":{"default":false,"description":"A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider.  This cannot be enabled unless user_deprovision is also enabled.","type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"secret":{"description":"A read-only token generated when the SCIM integration is enabled for the first time.  It is redacted on subsequent requests.  If you lose this you will need to refresh it at /access/identity_providers/:idpID/refresh_scim_secret.","readOnly":true,"type":"string","x-sensitive":true},"user_deprovision":{"default":false,"description":"A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider.","type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"}},"type":"object"},"type":{"description":"The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).","enum":["onetimepin","azureAD","saml","centrify","facebook","github","google-apps","google","linkedin","oidc","okta","onelogin","pingone","yandex"],"example":"onetimepin","type":"string"}},"required":["name","type","config"],"type":"object"},"access_identity-providers":{"anyOf":[{"$ref":"#/components/schemas/access_azureAD"},{"$ref":"#/components/schemas/access_centrify"},{"$ref":"#/components/schemas/access_facebook"},{"$ref":"#/components/schemas/access_github"},{"$ref":"#/components/schemas/access_google"},{"$ref":"#/components/schemas/access_google-apps"},{"$ref":"#/components/schemas/access_linkedin"},{"$ref":"#/components/schemas/access_oidc"},{"$ref":"#/components/schemas/access_okta"},{"$ref":"#/components/schemas/access_onelogin"},{"$ref":"#/components/schemas/access_pingone"},{"$ref":"#/components/schemas/access_saml"},{"$ref":"#/components/schemas/access_yandex"},{"$ref":"#/components/schemas/access_onetimepin"}],"type":"object"},"access_identity-providers_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"anyOf":[{"$ref":"#/components/schemas/access_schemas-azureAD"},{"$ref":"#/components/schemas/access_schemas-centrify"},{"$ref":"#/components/schemas/access_schemas-facebook"},{"$ref":"#/components/schemas/access_schemas-github"},{"$ref":"#/components/schemas/access_schemas-google"},{"$ref":"#/components/schemas/access_schemas-google-apps"},{"$ref":"#/components/schemas/access_schemas-linkedin"},{"$ref":"#/components/schemas/access_schemas-oidc"},{"$ref":"#/components/schemas/access_schemas-okta"},{"$ref":"#/components/schemas/access_schemas-onelogin"},{"$ref":"#/components/schemas/access_schemas-pingone"},{"$ref":"#/components/schemas/access_schemas-saml"},{"$ref":"#/components/schemas/access_schemas-yandex"},{"$ref":"#/components/schemas/access_schemas-onetimepin"}]},"type":"array"}},"type":"object"}],"type":"object"},"access_identity-providers_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_schemas-identity-providers"}}}],"type":"object"},"access_idp_id":{"description":"The unique Id of the IdP that has SCIM enabled.","example":["df7e2w5f-02b7-4d9d-af26-8d1988fca630","0194ae2c-efcf-7cfb-8884-055f1a161fa5"],"items":{"type":"string"},"type":"array"},"access_idp_resource_id":{"description":"The IdP-generated Id of the SCIM Group resource; also known as the \"external Id\".","example":"all_employees","type":"string"},"access_image_url":{"description":"The URL of the image shown on the landing page.","example":"https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg","type":"string"},"access_include":{"description":"Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.","items":{"$ref":"#/components/schemas/access_rule"},"type":"array"},"access_infra_app_req_embedded_policies":{"properties":{"policies":{"description":"The policies that Access applies to the application.","items":{"$ref":"#/components/schemas/access_infra_policy_req"},"type":"array"}},"type":"object"},"access_infra_app_resp_embedded_policies":{"description":"The policies that Access applies to the application.","properties":{"policies":{"items":{"$ref":"#/components/schemas/access_infra_policy_resp"},"type":"array"}},"type":"object"},"access_infra_policy_req":{"allOf":[{"$ref":"#/components/schemas/access_base_policy_req"}],"properties":{"connection_rules":{"$ref":"#/components/schemas/access_connection_rules"}},"type":"object"},"access_infra_policy_resp":{"allOf":[{"$ref":"#/components/schemas/access_base_policy_resp"}],"properties":{"connection_rules":{"$ref":"#/components/schemas/access_connection_rules"}},"type":"object"},"access_infra_props":{"allOf":[{"properties":{"name":{"$ref":"#/components/schemas/access_apps_components-schemas-name"},"type":{"allOf":[{"$ref":"#/components/schemas/access_type"},{"example":"infrastructure"}]}}},{"$ref":"#/components/schemas/access_app_resp_embedded_target_criteria_infra"}],"required":["type","target_criteria"],"title":"Infrastructure Application","type":"object"},"access_ip":{"description":"The IP address of the authenticating user.","example":"198.41.129.166","type":"string"},"access_ip_list_rule":{"description":"Matches an IP address from a list.","properties":{"ip_list":{"properties":{"id":{"description":"The ID of a previously created IP list.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f","type":"string"}},"required":["id"],"type":"object"}},"required":["ip_list"],"title":"IP list","type":"object"},"access_ip_rule":{"description":"Matches an IP address block.","properties":{"ip":{"properties":{"ip":{"description":"An IPv4 or IPv6 CIDR block.","example":"2400:cb00:21:10a::/64","type":"string"}},"required":["ip"],"type":"object"}},"required":["ip"],"title":"IP ranges","type":"object"},"access_is_default":{"description":"Whether this is the default group","type":"boolean","x-auditable":true},"access_is_ui_read_only":{"default":false,"description":"Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled.","example":"false","type":"boolean","x-auditable":true},"access_isolation_required":{"description":"Require this application to be served in an isolated browser for users matching this policy. 'Client Web Isolation' must be on for the account in order to use this feature.","example":false,"type":"boolean"},"access_key_config":{"properties":{"days_until_next_rotation":{"$ref":"#/components/schemas/access_days_until_next_rotation"},"key_rotation_interval_days":{"$ref":"#/components/schemas/access_key_rotation_interval_days"},"last_key_rotation_at":{"$ref":"#/components/schemas/access_last_key_rotation_at"}},"type":"object"},"access_key_rotation_interval_days":{"description":"The number of days between key rotations.","example":30,"maximum":365,"minimum":21,"type":"number","x-auditable":true},"access_keys_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_key_config"}}}],"type":"object"},"access_landing_page_design":{"description":"The design of the App Launcher landing page shown to users when they log in.","properties":{"button_color":{"$ref":"#/components/schemas/access_button_color"},"button_text_color":{"$ref":"#/components/schemas/access_button_text_color"},"image_url":{"$ref":"#/components/schemas/access_image_url"},"message":{"$ref":"#/components/schemas/access_message"},"title":{"$ref":"#/components/schemas/access_title"}},"type":"object"},"access_last_key_rotation_at":{"description":"The timestamp of the previous key rotation.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true},"access_last_seen_identity_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/access_identity"}],"type":"object"}}}],"type":"object"},"access_last_successful_login":{"description":"The time at which the user last successfully logged in.","example":"2020-07-01T05:20:00Z","format":"date-time","type":"string"},"access_limit":{"default":20,"description":"The maximum number of update logs to retrieve.","example":10,"type":"integer"},"access_linked_app_token_rule":{"description":"Matches OAuth 2.0 access tokens issued by the specified Access OIDC SaaS application. Only compatible with non_identity and bypass decisions.","properties":{"linked_app_token":{"properties":{"app_uid":{"description":"The ID of an Access OIDC SaaS application","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f","type":"string"}},"required":["app_uid"],"type":"object"}},"required":["linked_app_token"],"title":"Linked App Token","type":"object"},"access_linkedin":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/access_generic-oauth-config"}},"type":"object"}],"title":"LinkedIn","type":"object"},"access_login_design":{"properties":{"background_color":{"description":"The background color on your login page.","example":"#c5ed1b","type":"string"},"footer_text":{"description":"The text at the bottom of your login page.","example":"This is an example description.","type":"string"},"header_text":{"description":"The text at the top of your login page.","example":"This is an example description.","type":"string"},"logo_path":{"description":"The URL of the logo on your login page.","example":"https://example.com/logo.png","type":"string"},"text_color":{"description":"The text color on your login page.","example":"#c5ed1b","type":"string"}},"type":"object"},"access_login_method_rule":{"description":"Matches a specific identity provider id.","properties":{"login_method":{"properties":{"id":{"description":"The ID of an identity provider.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f","type":"string"}},"required":["id"],"type":"object"}},"required":["login_method"],"title":"Login Method","type":"object"},"access_logo_url":{"description":"The image URL for the logo shown in the App Launcher dashboard.","example":"https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg","type":"string"},"access_max_age":{"description":"The maximum number of seconds the results of a preflight request can be cached.","example":-1,"maximum":86400,"minimum":-1,"type":"number"},"access_message":{"description":"The message shown on the landing page.","example":"Log in below to reach your applications behind Access.","type":"string"},"access_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"access_meta":{"description":"The metadata of the SCIM resource.","properties":{"created":{"description":"The timestamp of when the SCIM resource was created.","example":"2025-01-01T00:00:00Z","format":"date-time","type":"string"},"lastModified":{"description":"The timestamp of when the SCIM resource was last modified.","example":"2025-01-02T00:00:00Z","format":"date-time","type":"string"}},"type":"object"},"access_name":{"description":"The name of your Zero Trust organization.","example":"Widget Corps Internal Applications","type":"string","x-auditable":true},"access_name_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"properties":{"name":{"$ref":"#/components/schemas/access_tags_components-schemas-name"}},"type":"object"}},"type":"object"}],"type":"object"},"access_nonce":{"example":"X1aXj1lFVcqqyoXF","type":"string"},"access_oidc":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_generic-oauth-config"},{"$ref":"#/components/schemas/access_custom-claims-support"},{"properties":{"auth_url":{"description":"The authorization_endpoint URL of your IdP","example":"https://accounts.google.com/o/oauth2/auth","type":"string"},"certs_url":{"description":"The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens","example":"https://www.googleapis.com/oauth2/v3/certs","type":"string"},"pkce_enabled":{"description":"Enable Proof Key for Code Exchange (PKCE)","type":"boolean"},"scopes":{"description":"OAuth scopes","example":["openid","email","profile"],"items":{"type":"string"},"type":"array"},"token_url":{"description":"The token_endpoint URL of your IdP","example":"https://accounts.google.com/o/oauth2/token","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Generic OAuth","type":"object"},"access_oidc_claim_rule":{"description":"Matches an OIDC claim.\nRequires an OIDC identity provider.","properties":{"oidc":{"properties":{"claim_name":{"description":"The name of the OIDC claim.","example":"group","type":"string"},"claim_value":{"description":"The OIDC claim value to look for.","example":"devs@cloudflare.com","type":"string"},"identity_provider_id":{"description":"The ID of your OIDC identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971","type":"string"}},"required":["claim_name","claim_value","identity_provider_id"],"type":"object"}},"required":["oidc"],"title":"OIDC claim","type":"object"},"access_oidc_saas_app":{"properties":{"access_token_lifetime":{"description":"The lifetime of the OIDC Access Token after creation. Valid units are m,h. Must be greater than or equal to 1m and less than or equal to 24h.","example":"5m","type":"string"},"allow_pkce_without_client_secret":{"description":"If client secret should be required on the token endpoint when authorization_code_with_pkce grant is used.","example":true,"type":"boolean"},"app_launcher_url":{"description":"The URL where this applications tile redirects users","example":"https://example.com/login","type":"string"},"auth_type":{"description":"Identifier of the authentication protocol used for the saas app. Required for OIDC.","enum":["saml","oidc"],"example":"oidc","type":"string"},"client_id":{"description":"The application client id","example":"oidc client id","type":"string"},"client_secret":{"description":"The application client secret, only returned on POST request.","example":"oidc client secret","type":"string","x-sensitive":true},"created_at":{"$ref":"#/components/schemas/access_created_at"},"custom_claims":{"items":{"properties":{"name":{"description":"The name of the claim.","example":"family_name","type":"string"},"required":{"description":"If the claim is required when building an OIDC token.","example":true,"type":"boolean"},"scope":{"description":"The scope of the claim.","enum":["groups","profile","email","openid"],"example":"profile","type":"string"},"source":{"properties":{"name":{"description":"The name of the IdP claim.","example":"last_name","type":"string"},"name_by_idp":{"additionalProperties":{"type":"string"},"description":"A mapping from IdP ID to claim name.","example":{"exampleIdPID1":"ClaimName1","exampleIdPID2":"ClaimName2"},"type":"object"}},"type":"object"}},"type":"object"},"type":"array"},"grant_types":{"description":"The OIDC flows supported by this application","example":["authorization_code"],"items":{"enum":["authorization_code","authorization_code_with_pkce","refresh_tokens","hybrid","implicit"],"type":"string"},"type":"array"},"group_filter_regex":{"description":"A regex to filter Cloudflare groups returned in ID token and userinfo endpoint","example":"^GROUP_FILTER-*$","type":"string"},"hybrid_and_implicit_options":{"properties":{"return_access_token_from_authorization_endpoint":{"description":"If an Access Token should be returned from the OIDC Authorization endpoint","type":"boolean"},"return_id_token_from_authorization_endpoint":{"description":"If an ID Token should be returned from the OIDC Authorization endpoint","type":"boolean"}},"type":"object"},"public_key":{"description":"The Access public certificate that will be used to verify your identity.","example":"example unique name","type":"string"},"redirect_uris":{"description":"The permitted URL's for Cloudflare to return Authorization codes and Access/ID tokens","example":["https://example.com"],"items":{"type":"string"},"type":"array"},"refresh_token_options":{"properties":{"lifetime":{"description":"How long a refresh token will be valid for after creation. Valid units are m,h,d. Must be longer than 1m.","example":"30d","type":"string"}},"type":"object"},"scopes":{"description":"Define the user information shared with access, \"offline_access\" scope will be automatically enabled if refresh tokens are enabled","example":["openid","groups","email","profile"],"items":{"enum":["openid","groups","email","profile"],"type":"string"},"type":"array"},"updated_at":{"$ref":"#/components/schemas/access_updated_at"}},"title":"OIDC SaaS App","type":"object"},"access_okta":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_generic-oauth-config"},{"$ref":"#/components/schemas/access_custom-claims-support"},{"properties":{"authorization_server_id":{"description":"Your okta authorization server id","example":"aus9o8wzkhckw9TLa0h7z","type":"string"},"okta_account":{"description":"Your okta account url","example":"https://dev-abc123.oktapreview.com","type":"string","x-auditable":true}},"type":"object"}]}},"type":"object"}],"title":"Okta","type":"object"},"access_okta_group_rule":{"description":"Matches an Okta group.\nRequires an Okta identity provider.","properties":{"okta":{"properties":{"identity_provider_id":{"description":"The ID of your Okta identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971","type":"string"},"name":{"description":"The name of the Okta group.","example":"devs","type":"string"}},"required":["name","identity_provider_id"],"type":"object"}},"required":["okta"],"title":"Okta group","type":"object"},"access_onelogin":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_generic-oauth-config"},{"$ref":"#/components/schemas/access_custom-claims-support"},{"properties":{"onelogin_account":{"description":"Your OneLogin account url","example":"https://mycompany.onelogin.com","type":"string","x-auditable":true}},"type":"object"}]}},"type":"object"}],"title":"OneLogin","type":"object"},"access_onetimepin":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"properties":{"redirect_url":{"readOnly":true,"type":"string"}},"type":"object"},"type":{"enum":["onetimepin"],"type":"string"}}}],"title":"One Time Pin","type":"object"},"access_options_preflight_bypass":{"description":"Allows options preflight requests to bypass Access authentication and go directly to the origin. Cannot turn on if cors_headers is set.","example":true,"type":"boolean"},"access_organizations":{"properties":{"allow_authenticate_via_warp":{"$ref":"#/components/schemas/access_allow_authenticate_via_warp"},"auth_domain":{"$ref":"#/components/schemas/access_auth_domain"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/access_auto_redirect_to_identity"},"created_at":{"$ref":"#/components/schemas/access_created_at"},"custom_pages":{"$ref":"#/components/schemas/access_custom_pages"},"is_ui_read_only":{"$ref":"#/components/schemas/access_is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/access_login_design"},"name":{"$ref":"#/components/schemas/access_name"},"session_duration":{"$ref":"#/components/schemas/access_session_duration"},"ui_read_only_toggle_reason":{"$ref":"#/components/schemas/access_ui_read_only_toggle_reason"},"updated_at":{"$ref":"#/components/schemas/access_updated_at"},"user_seat_expiration_inactive_time":{"$ref":"#/components/schemas/access_user_seat_expiration_inactive_time"},"warp_auth_session_duration":{"$ref":"#/components/schemas/access_warp_auth_session_duration"}},"type":"object"},"access_organizations_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"access_organizations_components-schemas-name":{"description":"The name of your Zero Trust organization.","example":"Widget Corps Internal Applications","type":"string"},"access_organizations_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_schemas-organizations"}}}],"type":"object"},"access_path_cookie_attribute":{"default":false,"description":"Enables cookie paths to scope an application's JWT to the application path. If disabled, the JWT will scope to the hostname by default","example":true,"type":"boolean"},"access_percent_approved":{"description":"The percentage of (processed) users approved based on policy evaluation results.","example":25,"type":"integer","x-auditable":true},"access_percent_blocked":{"description":"The percentage of (processed) users blocked based on policy evaluation results.","example":25,"type":"integer","x-auditable":true},"access_percent_errored":{"description":"The percentage of (processed) users errored based on policy evaluation results.","example":25,"type":"integer","x-auditable":true},"access_percent_users_processed":{"description":"The percentage of users processed so far (of the entire user base).","example":50,"type":"integer"},"access_pingone":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_generic-oauth-config"},{"$ref":"#/components/schemas/access_custom-claims-support"},{"properties":{"ping_env_id":{"description":"Your PingOne environment identifier","example":"342b5660-0c32-4936-a5a4-ce21fae57b0a","type":"string","x-auditable":true}},"type":"object"}]}},"type":"object"}],"title":"PingOne","type":"object"},"access_policies":{"properties":{"approval_groups":{"$ref":"#/components/schemas/access_schemas-approval_groups"},"approval_required":{"$ref":"#/components/schemas/access_schemas-approval_required"},"created_at":{"$ref":"#/components/schemas/access_timestamp"},"decision":{"$ref":"#/components/schemas/access_schemas-decision"},"exclude":{"$ref":"#/components/schemas/access_components-schemas-exclude"},"id":{"$ref":"#/components/schemas/access_uuid"},"include":{"$ref":"#/components/schemas/access_include"},"isolation_required":{"$ref":"#/components/schemas/access_schemas-isolation_required"},"name":{"$ref":"#/components/schemas/access_policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/access_schemas-precedence"},"purpose_justification_prompt":{"$ref":"#/components/schemas/access_purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/access_schemas-purpose_justification_required"},"require":{"$ref":"#/components/schemas/access_components-schemas-require"},"updated_at":{"$ref":"#/components/schemas/access_timestamp"}},"type":"object"},"access_policies_components-schemas-name":{"description":"The name of the Access policy.","example":"Allow devs","type":"string"},"access_policies_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_policies"},"type":"array"}}}],"type":"object"},"access_policies_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_policies"}}}],"type":"object"},"access_policy_check_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"properties":{"app_state":{"properties":{"app_uid":{"$ref":"#/components/schemas/access_uuid"},"aud":{"example":"737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389","type":"string"},"hostname":{"example":"test.com","type":"string"},"name":{"example":"Test App","type":"string"},"policies":{"example":[{"decision":"allow","exclude":[],"include":[{"_type":"email","email":"testuser@gmail.com"}],"precedence":1,"require":[],"status":"Success"}],"items":{"type":"object"},"type":"array"},"status":{"example":"Success","type":"string"}},"type":"object"},"user_identity":{"properties":{"account_id":{"example":"41ecfbb341f033e52b46742756aabb8b","type":"string"},"device_sessions":{"example":{},"type":"object"},"email":{"example":"testuser@gmail.com","type":"string"},"geo":{"properties":{"country":{"example":"US","type":"string"}},"type":"object"},"iat":{"type":"integer"},"id":{"example":"1164449231815010287495","type":"string"},"is_gateway":{"example":false,"type":"boolean"},"is_warp":{"example":false,"type":"boolean"},"name":{"example":"Test User","type":"string"},"user_uuid":{"$ref":"#/components/schemas/access_uuid"},"version":{"type":"integer"}},"type":"object"}},"type":"object"}}}],"type":"object"},"access_policy_components-schemas-name":{"description":"The name of the Access policy.","example":"Allow devs","type":"string"},"access_policy_init_req":{"properties":{"policies":{"items":{"oneOf":[{"$ref":"#/components/schemas/access_policy_req"},{"description":"The UUID of the reusable policy you wish to test","example":"f1a8b3c9d4e5f6789a0b1c2d3e4f5678a9b0c1d2e3f4a5b67890c1d2e3f4b5a6","type":"string"}]},"type":"array"}},"type":"object"},"access_policy_init_resp":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/access_policy_test_id"},"status":{"$ref":"#/components/schemas/access_status"}},"type":"object"}}}],"type":"object"},"access_policy_req":{"allOf":[{"$ref":"#/components/schemas/access_base_policy_req"}],"properties":{"approval_groups":{"$ref":"#/components/schemas/access_approval_groups"},"approval_required":{"$ref":"#/components/schemas/access_approval_required"},"isolation_required":{"$ref":"#/components/schemas/access_isolation_required"},"purpose_justification_prompt":{"$ref":"#/components/schemas/access_purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/access_purpose_justification_required"},"session_duration":{"$ref":"#/components/schemas/access_components-schemas-session_duration"}},"type":"object"},"access_policy_resp":{"allOf":[{"$ref":"#/components/schemas/access_base_policy_resp"}],"properties":{"approval_groups":{"$ref":"#/components/schemas/access_approval_groups"},"approval_required":{"$ref":"#/components/schemas/access_approval_required"},"isolation_required":{"$ref":"#/components/schemas/access_isolation_required"},"purpose_justification_prompt":{"$ref":"#/components/schemas/access_purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/access_purpose_justification_required"},"session_duration":{"$ref":"#/components/schemas/access_components-schemas-session_duration"}},"type":"object"},"access_policy_test_id":{"description":"The UUID of the policy test.","example":"f1a8b3c9d4e5f6789a0b1c2d3e4f5678a9b0c1d2e3f4a5b67890c1d2e3f4b5a6","maxLength":64,"type":"string","x-auditable":true},"access_policy_update_resp":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/access_policy_test_id"},"percent_approved":{"$ref":"#/components/schemas/access_percent_approved"},"percent_blocked":{"$ref":"#/components/schemas/access_percent_blocked"},"percent_errored":{"$ref":"#/components/schemas/access_percent_errored"},"percent_users_processed":{"$ref":"#/components/schemas/access_percent_users_processed"},"status":{"$ref":"#/components/schemas/access_update_status"},"total_users":{"$ref":"#/components/schemas/access_total_users"},"users_approved":{"$ref":"#/components/schemas/access_users_approved"},"users_blocked":{"$ref":"#/components/schemas/access_users_blocked"},"users_errored":{"$ref":"#/components/schemas/access_users_errored"}},"type":"object"}}}],"type":"object"},"access_policy_users":{"properties":{"email":{"$ref":"#/components/schemas/access_schemas-email"},"id":{"$ref":"#/components/schemas/access_uuid"},"name":{"$ref":"#/components/schemas/access_users_components-schemas-name"},"status":{"$ref":"#/components/schemas/access_user_result"}},"type":"object"},"access_policy_users_resp":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"description":"Page of processed users.","items":{"$ref":"#/components/schemas/access_policy_users"},"type":"array"}}}],"type":"object"},"access_port":{"description":"The port that the targets use for the chosen communication protocol. A port cannot be assigned to multiple protocols.","example":22,"type":"integer"},"access_precedence":{"description":"The order of execution for this policy. Must be unique for each policy within an app.\n","type":"integer"},"access_previous_client_secret_expires_at":{"description":"The expiration of the previous `client_secret`. This can be modified at any point after a rotation. For example, you may extend it further into the future if you need more time to update services with the new secret; or move it into the past to immediately invalidate the previous token in case of compromise.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true},"access_protocol_infra_app":{"description":"The communication protocol your application secures.","enum":["SSH"],"example":"SSH","type":"string","x-auditable":true},"access_protocol_self_hosted_app":{"description":"The communication protocol your application secures.","enum":["RDP"],"example":"RDP","type":"string","x-auditable":true},"access_proxy_endpoint_props":{"allOf":[{"$ref":"#/components/schemas/access_feature_app_props"},{"properties":{"domain":{"description":"The proxy endpoint domain in the format: 10 alphanumeric characters followed by .proxy.cloudflare-gateway.com","example":"abcd123456.proxy.cloudflare-gateway.com","pattern":"^[A-Za-z0-9]{10}\\.proxy\\.cloudflare-gateway\\.com$"},"name":{"default":"Gateway Proxy","example":"Gateway Proxy"},"type":{"allOf":[{"$ref":"#/components/schemas/access_type"},{"example":"proxy_endpoint"}]}}}]},"access_public_key":{"description":"The public key to add to your SSH server configuration.","example":"ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org","readOnly":true,"type":"string"},"access_purpose_justification_prompt":{"description":"A custom message that will appear on the purpose justification screen.","example":"Please enter a justification for entering this protected domain.","type":"string"},"access_purpose_justification_required":{"description":"Require users to enter a justification when they log in to the application.","example":true,"type":"boolean"},"access_ray_id":{"description":"The unique identifier for the request to Cloudflare.","example":"187d944c61940c77","maxLength":16,"type":"string"},"access_rdp_props":{"allOf":[{"$ref":"#/components/schemas/access_app_resp_embedded_target_criteria_self_hosted"},{"$ref":"#/components/schemas/access_self_hosted_props"},{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/access_type"},{"example":"rdp"}]}}}],"required":["target_criteria"]},"access_read_service_tokens_from_header":{"description":"Allows matching Access Service Tokens passed HTTP in a single header with this name.\nThis works as an alternative to the (CF-Access-Client-Id, CF-Access-Client-Secret) pair of headers.\nThe header value will be interpreted as a json object similar to: \n  {\n    \"cf-access-client-id\": \"88bf3b6d86161464f6509f7219099e57.access.example.com\",\n    \"cf-access-client-secret\": \"bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5\"\n  }\n","example":"Authorization","type":"string"},"access_request_method":{"description":"The request method of the SCIM request.","example":["DELETE","PATCH"],"items":{"enum":["DELETE","PATCH","POST","PUT"],"type":"string"},"type":"array"},"access_requests-cf_resource_id":{"description":"The unique Cloudflare-generated Id of the SCIM resource.","example":"bd97ef8d-7986-43e3-9ee0-c25dda33e4b0","type":"string"},"access_requests-idp_resource_id":{"description":"The IdP-generated Id of the SCIM resource.","type":"string"},"access_requests-status":{"description":"The status of the SCIM request.","example":["FAILURE","SUCCESS"],"items":{"enum":["FAILURE","SUCCESS"],"type":"string"},"type":"array"},"access_require":{"description":"Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.","items":{"$ref":"#/components/schemas/access_rule"},"type":"array"},"access_resource_group_name":{"description":"The display name of the SCIM Group resource.","example":"ALL_EMPLOYEES","type":"string"},"access_resource_type":{"description":"The resource type of the SCIM request.","example":["USER","GROUP"],"items":{"enum":["USER","GROUP"],"type":"string"},"type":"array"},"access_resource_user_email":{"description":"The email address of the SCIM User resource.","example":"john.smith@example.com","format":"email","type":"string"},"access_response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"anyOf":[{"$ref":"#/components/schemas/access_azureAD"},{"$ref":"#/components/schemas/access_centrify"},{"$ref":"#/components/schemas/access_facebook"},{"$ref":"#/components/schemas/access_github"},{"$ref":"#/components/schemas/access_google"},{"$ref":"#/components/schemas/access_google-apps"},{"$ref":"#/components/schemas/access_linkedin"},{"$ref":"#/components/schemas/access_oidc"},{"$ref":"#/components/schemas/access_okta"},{"$ref":"#/components/schemas/access_onelogin"},{"$ref":"#/components/schemas/access_pingone"},{"$ref":"#/components/schemas/access_saml"},{"$ref":"#/components/schemas/access_yandex"}]},"type":"array"}},"type":"object"}],"type":"object"},"access_response_collection_hostnames":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_settings"},"type":"array"}}}],"type":"object"},"access_responses":{"properties":{"cf_resource_id":{"description":"The unique Cloudflare-generated Id of the SCIM resource.","example":"bd97ef8d-7986-43e3-9ee0-c25dda33e4b0","type":"string"},"error_description":{"description":"The error message which is generated when the status of the SCIM request is 'FAILURE'.","example":"Invalid JSON body","type":"string"},"idp_id":{"description":"The unique Id of the IdP that has SCIM enabled.","example":"df7e2w5f-02b7-4d9d-af26-8d1988fca630","type":"string"},"idp_resource_id":{"description":"The IdP-generated Id of the SCIM resource.","example":"all_employees","type":"string"},"logged_at":{"$ref":"#/components/schemas/access_timestamp"},"request_body":{"description":"The JSON-encoded string body of the SCIM request.","example":"{}}","type":"string"},"request_method":{"description":"The request method of the SCIM request.","example":"DELETE","type":"string"},"resource_group_name":{"description":"The display name of the SCIM Group resource if it exists.","example":"ALL_EMPLOYEES","type":"string"},"resource_type":{"description":"The resource type of the SCIM request.","example":"GROUP","type":"string"},"resource_user_email":{"description":"The email address of the SCIM User resource if it exists.","example":"john.smith@example.com","format":"email","type":"string"},"status":{"description":"The status of the SCIM request.","example":"FAILURE","type":"string"}},"type":"object"},"access_reusable-policies_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/access_schemas-uuid"}},"type":"object"}}}],"type":"object"},"access_reusable-policies_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_reusable_policy_resp"},"type":"array"}}}],"type":"object"},"access_reusable-policies_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_reusable_policy_resp"}}}],"type":"object"},"access_reusable_policy_resp":{"allOf":[{"$ref":"#/components/schemas/access_policy_resp"},{"properties":{"app_count":{"$ref":"#/components/schemas/access_app_count"},"reusable":{"enum":[true],"type":"boolean"}}}],"type":"object"},"access_rule":{"oneOf":[{"$ref":"#/components/schemas/access_access_group_rule"},{"$ref":"#/components/schemas/access_any_valid_service_token_rule"},{"$ref":"#/components/schemas/access_auth_context_rule"},{"$ref":"#/components/schemas/access_authentication_method_rule"},{"$ref":"#/components/schemas/access_azure_group_rule"},{"$ref":"#/components/schemas/access_certificate_rule"},{"$ref":"#/components/schemas/access_common_name_rule"},{"$ref":"#/components/schemas/access_country_rule"},{"$ref":"#/components/schemas/access_device_posture_rule"},{"$ref":"#/components/schemas/access_domain_rule"},{"$ref":"#/components/schemas/access_email_list_rule"},{"$ref":"#/components/schemas/access_email_rule"},{"$ref":"#/components/schemas/access_everyone_rule"},{"$ref":"#/components/schemas/access_external_evaluation_rule"},{"$ref":"#/components/schemas/access_github_organization_rule"},{"$ref":"#/components/schemas/access_gsuite_group_rule"},{"$ref":"#/components/schemas/access_login_method_rule"},{"$ref":"#/components/schemas/access_ip_list_rule"},{"$ref":"#/components/schemas/access_ip_rule"},{"$ref":"#/components/schemas/access_okta_group_rule"},{"$ref":"#/components/schemas/access_saml_group_rule"},{"$ref":"#/components/schemas/access_oidc_claim_rule"},{"$ref":"#/components/schemas/access_service_token_rule"},{"$ref":"#/components/schemas/access_linked_app_token_rule"}],"type":"object"},"access_saas_props":{"properties":{"allowed_idps":{"$ref":"#/components/schemas/access_allowed_idps"},"app_launcher_visible":{"$ref":"#/components/schemas/access_app_launcher_visible"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/access_schemas-auto_redirect_to_identity"},"custom_pages":{"$ref":"#/components/schemas/access_schemas-custom_pages"},"logo_url":{"$ref":"#/components/schemas/access_logo_url"},"name":{"$ref":"#/components/schemas/access_apps_components-schemas-name"},"saas_app":{"oneOf":[{"$ref":"#/components/schemas/access_saml_saas_app"},{"$ref":"#/components/schemas/access_oidc_saas_app"}],"type":"object"},"scim_config":{"$ref":"#/components/schemas/access_scim_config"},"tags":{"$ref":"#/components/schemas/access_tags"},"type":{"allOf":[{"$ref":"#/components/schemas/access_type"},{"example":"saas"}]}},"title":"SaaS Application","type":"object"},"access_same_site_cookie_attribute":{"description":"Sets the SameSite cookie setting, which provides increased security against CSRF attacks.","example":"strict","type":"string"},"access_saml":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"properties":{"attributes":{"description":"A list of SAML attribute names that will be added to your signed JWT token and can be used in SAML policy rules.","example":["group","department_code","divison"],"items":{"type":"string"},"type":"array"},"email_attribute_name":{"description":"The attribute name for email in the SAML response.","example":"Email","type":"string","x-auditable":true},"header_attributes":{"description":"Add a list of attribute names that will be returned in the response header from the Access callback.","items":{"properties":{"attribute_name":{"description":"attribute name from the IDP","type":"string"},"header_name":{"description":"header that will be added on the request to the origin","type":"string"}},"type":"object"},"type":"array"},"idp_public_certs":{"description":"X509 certificate to verify the signature in the SAML authentication response","items":{"type":"string"},"type":"array"},"issuer_url":{"description":"IdP Entity ID or Issuer URL","example":"https://whoami.com","type":"string","x-auditable":true},"sign_request":{"default":false,"description":"Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints.","type":"boolean"},"sso_target_url":{"description":"URL to send the SAML authentication requests to","example":"https://edgeaccess.org/idp/saml/login","type":"string","x-auditable":true}},"type":"object"}},"type":"object"}],"title":"Generic SAML","type":"object"},"access_saml_group_rule":{"description":"Matches a SAML group.\nRequires a SAML identity provider.","properties":{"saml":{"properties":{"attribute_name":{"description":"The name of the SAML attribute.","example":"group","type":"string"},"attribute_value":{"description":"The SAML attribute value to look for.","example":"devs@cloudflare.com","type":"string"},"identity_provider_id":{"description":"The ID of your SAML identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971","type":"string"}},"required":["attribute_name","attribute_value","identity_provider_id"],"type":"object"}},"required":["saml"],"title":"SAML group","type":"object"},"access_saml_saas_app":{"properties":{"auth_type":{"description":"Optional identifier indicating the authentication protocol used for the saas app. Required for OIDC. Default if unset is \"saml\"","enum":["saml","oidc"],"example":"saml","type":"string"},"consumer_service_url":{"description":"The service provider's endpoint that is responsible for receiving and parsing a SAML assertion.","example":"https://example.com","type":"string"},"created_at":{"$ref":"#/components/schemas/access_created_at"},"custom_attributes":{"items":{"properties":{"friendly_name":{"description":"The SAML FriendlyName of the attribute.","example":"Last Name","type":"string"},"name":{"description":"The name of the attribute.","example":"family_name","type":"string"},"name_format":{"description":"A globally unique name for an identity or service provider.","enum":["urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified","urn:oasis:names:tc:SAML:2.0:attrname-format:basic","urn:oasis:names:tc:SAML:2.0:attrname-format:uri"],"example":"urn:oasis:names:tc:SAML:2.0:attrname-format:basic","type":"string"},"required":{"description":"If the attribute is required when building a SAML assertion.","example":true,"type":"boolean"},"source":{"properties":{"name":{"description":"The name of the IdP attribute.","example":"last_name","type":"string"},"name_by_idp":{"description":"A mapping from IdP ID to attribute name.","items":{"properties":{"idp_id":{"description":"The UID of the IdP.","example":"exampleIdPID1","type":"string"},"source_name":{"description":"The name of the IdP provided attribute.","example":"AttributeName1","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"type":"array"},"default_relay_state":{"description":"The URL that the user will be redirected to after a successful login for IDP initiated logins.","example":"https://example.com","type":"string"},"idp_entity_id":{"description":"The unique identifier for your SaaS application.","example":"https://example.cloudflareaccess.com","type":"string","x-stainless-configurability":"computed_optional"},"name_id_format":{"description":"The format of the name identifier sent to the SaaS application.","enum":["id","email"],"example":"id","type":"string"},"name_id_transform_jsonata":{"description":"A [JSONata](https://jsonata.org/) expression that transforms an application's user identities into a NameID value for its SAML assertion. This expression should evaluate to a singular string. The output of this expression can override the `name_id_format` setting.\n","example":"$substringBefore(email, '@') \u0026 '+sandbox@' \u0026 $substringAfter(email, '@')","type":"string"},"public_key":{"description":"The Access public certificate that will be used to verify your identity.","example":"example unique name","type":"string","x-stainless-configurability":"computed_optional"},"saml_attribute_transform_jsonata":{"description":"A [JSONata] (https://jsonata.org/) expression that transforms an application's user identities into attribute assertions in the SAML response. The expression can transform id, email, name, and groups values. It can also transform fields listed in the saml_attributes or oidc_fields of the identity provider used to authenticate. The output of this expression must be a JSON object.\n","example":"$ ~\u003e| groups | {'group_name': name} |","type":"string"},"sp_entity_id":{"description":"A globally unique name for an identity or service provider.","example":"example unique name","type":"string"},"sso_endpoint":{"description":"The endpoint where your SaaS application will send login requests.","example":"https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd","type":"string","x-stainless-configurability":"computed_optional"},"updated_at":{"$ref":"#/components/schemas/access_updated_at"}},"title":"SAML SaaS App","type":"object"},"access_schemas-access_seat":{"description":"True if the user has authenticated with Cloudflare Access.","example":false,"type":"boolean"},"access_schemas-allow_authenticate_via_warp":{"description":"When set to true, users can authenticate to this application using their WARP session.  When set to false this application will always require direct IdP authentication. This setting always overrides the organization setting for WARP authentication.","example":true,"type":"boolean"},"access_schemas-allowed_headers":{"description":"Allowed HTTP request headers.","items":{},"type":"array"},"access_schemas-allowed_origins":{"description":"Allowed origins.","example":["https://example.com"],"items":{},"type":"array"},"access_schemas-app_count":{"description":"Number of apps the custom page is assigned to.","type":"integer","x-auditable":true,"x-stainless-skip":true},"access_schemas-app_launcher_props":{"allOf":[{"$ref":"#/components/schemas/access_schemas-feature_app_props"},{"properties":{"domain":{"example":"authdomain.cloudflareaccess.com","readOnly":true},"name":{"default":"App Launcher","example":"App Launcher","readOnly":true},"type":{"description":"The application type.","example":"app_launcher","type":"string"}}}]},"access_schemas-app_launcher_visible":{"description":"Displays the application in the App Launcher.","example":true,"type":"boolean","x-auditable":true},"access_schemas-approval_group":{"description":"A group of email addresses that can approve a temporary authentication request.","properties":{"approvals_needed":{"description":"The number of approvals needed to obtain access.","example":1,"minimum":0,"type":"number"},"email_addresses":{"description":"A list of emails that can approve the access request.","example":["test@cloudflare.com","test2@cloudflare.com"],"items":{},"type":"array"},"email_list_uuid":{"description":"The UUID of an re-usable email list.","type":"string"}},"required":["approvals_needed"],"type":"object"},"access_schemas-approval_groups":{"description":"Administrators who can approve a temporary authentication request.","example":[{"approvals_needed":1,"email_addresses":["test1@cloudflare.com","test2@cloudflare.com"]},{"approvals_needed":3,"email_list_uuid":"597147a1-976b-4ef2-9af0-81d5d007fc34"}],"items":{"$ref":"#/components/schemas/access_schemas-approval_group"},"type":"array"},"access_schemas-approval_required":{"default":false,"description":"Requires the user to request access from an administrator at the start of each session.","example":true,"type":"boolean"},"access_schemas-associated_hostnames":{"description":"The hostnames of the applications that will use this certificate.","items":{"description":"A fully-qualified domain name (FQDN).","example":"admin.example.com","type":"string"},"type":"array"},"access_schemas-aud":{"description":"Audience tag.","example":"737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893","maxLength":64,"readOnly":true,"type":"string"},"access_schemas-auth_domain":{"description":"The unique subdomain assigned to your Zero Trust organization.","example":"test.cloudflareaccess.com","type":"string"},"access_schemas-auto_redirect_to_identity":{"default":false,"description":"When set to `true`, users skip the identity provider selection step during login. You must specify only one identity provider in allowed_idps.","type":"boolean"},"access_schemas-azureAD":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_schemas-generic-oauth-config"},{"properties":{"conditional_access_enabled":{"description":"Should Cloudflare try to load authentication contexts from your account","type":"boolean"},"directory_id":{"description":"Your Azure directory uuid","example":"\u003cyour azure directory uuid\u003e","type":"string"},"prompt":{"description":"Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether.","enum":["login","select_account","none"],"type":"string"},"support_groups":{"description":"Should Cloudflare try to load groups from your account","type":"boolean"}},"type":"object"}]}},"type":"object"}],"title":"Azure AD","type":"object"},"access_schemas-basic_app_response_props":{"properties":{"aud":{"$ref":"#/components/schemas/access_schemas-aud"},"created_at":{"$ref":"#/components/schemas/access_timestamp"},"id":{"$ref":"#/components/schemas/access_uuid"},"scim_config":{"$ref":"#/components/schemas/access_schemas-scim_config"},"updated_at":{"$ref":"#/components/schemas/access_timestamp"}},"type":"object"},"access_schemas-biso_props":{"allOf":[{"$ref":"#/components/schemas/access_schemas-feature_app_props"},{"properties":{"domain":{"example":"authdomain.cloudflareaccess.com/browser","readOnly":true},"name":{"default":"Clientless Web Isolation","example":"Clientless Web Isolation","readOnly":true},"type":{"description":"The application type.","example":"biso","type":"string"}}}]},"access_schemas-bookmark_props":{"properties":{"app_launcher_visible":{"default":true},"domain":{"description":"The URL or domain of the bookmark.","example":"https://mybookmark.com"},"logo_url":{"$ref":"#/components/schemas/access_logo_url"},"name":{"$ref":"#/components/schemas/access_apps_components-schemas-name"},"type":{"description":"The application type.","example":"bookmark","type":"string"}},"required":["type","domain"],"title":"Bookmark Application","type":"object"},"access_schemas-ca":{"properties":{"aud":{"$ref":"#/components/schemas/access_components-schemas-aud"},"id":{"$ref":"#/components/schemas/access_components-schemas-id"},"public_key":{"$ref":"#/components/schemas/access_public_key"}},"type":"object"},"access_schemas-centrify":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_schemas-generic-oauth-config"},{"properties":{"centrify_account":{"description":"Your centrify account url","example":"https://abc123.my.centrify.com/","type":"string"},"centrify_app_id":{"description":"Your centrify app id","example":"exampleapp","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Centrify","type":"object"},"access_schemas-certificates":{"properties":{"id":{"description":"The key ID of this certificate.","type":"string","x-auditable":true},"public_key":{"description":"The public key of this certificate.","type":"string"}},"type":"object"},"access_schemas-cors_headers":{"properties":{"allow_all_headers":{"$ref":"#/components/schemas/access_allow_all_headers"},"allow_all_methods":{"$ref":"#/components/schemas/access_allow_all_methods"},"allow_all_origins":{"$ref":"#/components/schemas/access_allow_all_origins"},"allow_credentials":{"$ref":"#/components/schemas/access_allow_credentials"},"allowed_headers":{"$ref":"#/components/schemas/access_schemas-allowed_headers"},"allowed_methods":{"$ref":"#/components/schemas/access_allowed_methods"},"allowed_origins":{"$ref":"#/components/schemas/access_schemas-allowed_origins"},"max_age":{"$ref":"#/components/schemas/access_max_age"}},"type":"object"},"access_schemas-create_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"properties":{"client_id":{"$ref":"#/components/schemas/access_client_id"},"client_secret":{"$ref":"#/components/schemas/access_client_secret"},"created_at":{"$ref":"#/components/schemas/access_timestamp"},"duration":{"$ref":"#/components/schemas/access_schemas-duration"},"id":{"description":"The ID of the service token.","type":"string"},"name":{"$ref":"#/components/schemas/access_service-tokens_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/access_timestamp"}}}}}],"type":"object"},"access_schemas-custom_deny_url":{"description":"The custom URL a user is redirected to when they are denied access to the application.","type":"string"},"access_schemas-custom_pages":{"description":"The custom pages that will be displayed when applicable for this application","items":{"description":"The custom pages selected for application.","example":"699d98642c564d2e855e9661899b7252","type":"string"},"type":"array"},"access_schemas-decision":{"description":"The action Access will take if a user matches this policy.","enum":["allow","deny","non_identity","bypass"],"example":"allow","type":"string"},"access_schemas-device_posture_rule":{"properties":{"check":{"$ref":"#/components/schemas/access_device_posture_check"},"data":{"type":"object"},"description":{"type":"string","x-auditable":true},"error":{"type":"string"},"id":{"type":"string","x-auditable":true},"rule_name":{"type":"string","x-auditable":true},"success":{"type":"boolean","x-auditable":true},"timestamp":{"type":"string","x-auditable":true},"type":{"type":"string","x-auditable":true}},"type":"object"},"access_schemas-domain":{"description":"The domain of the Bookmark application.","example":"example.com","type":"string","x-auditable":true},"access_schemas-duration":{"default":"8760h","description":"The duration for how long the service token will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The default is 1 year in hours (8760h).","example":"60m","type":"string"},"access_schemas-email":{"description":"The email of the user.","example":"jdoe@example.com","format":"email","type":"string"},"access_schemas-empty_response":{"allOf":[{"properties":{"result":{"nullable":true,"type":"object"},"success":{"enum":[true,false],"example":true,"type":"boolean"}}}],"type":"object"},"access_schemas-exclude":{"default":[],"description":"Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.","items":{"$ref":"#/components/schemas/access_rule"},"type":"array","x-stainless-collection-type":"set"},"access_schemas-facebook":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/access_schemas-generic-oauth-config"}},"type":"object"}],"title":"Facebook","type":"object"},"access_schemas-feature_app_props":{"properties":{"allowed_idps":{"$ref":"#/components/schemas/access_allowed_idps"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/access_schemas-auto_redirect_to_identity"},"domain":{"$ref":"#/components/schemas/access_components-schemas-domain"},"name":{"$ref":"#/components/schemas/access_apps_components-schemas-name"},"session_duration":{"$ref":"#/components/schemas/access_apps_components-schemas-session_duration"},"type":{"$ref":"#/components/schemas/access_components-schemas-type"}},"required":["type"],"type":"object"},"access_schemas-gateway_seat":{"description":"True if the user has logged into the WARP client.","example":false,"type":"boolean"},"access_schemas-generic-oauth-config":{"properties":{"client_id":{"description":"Your OAuth Client ID","example":"\u003cyour client id\u003e","type":"string"},"client_secret":{"description":"Your OAuth Client Secret","example":"\u003cyour client secret\u003e","type":"string","writeOnly":true,"x-sensitive":true}},"type":"object"},"access_schemas-github":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/access_schemas-generic-oauth-config"}},"type":"object"}],"title":"GitHub","type":"object"},"access_schemas-google":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/access_schemas-generic-oauth-config"}},"type":"object"}],"title":"Google","type":"object"},"access_schemas-google-apps":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_schemas-generic-oauth-config"},{"properties":{"apps_domain":{"description":"Your companies TLD","example":"mycompany.com","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Google Workspace","type":"object"},"access_schemas-groups":{"properties":{"created_at":{"$ref":"#/components/schemas/access_created_at"},"exclude":{"$ref":"#/components/schemas/access_exclude"},"id":{"$ref":"#/components/schemas/access_uuid"},"include":{"$ref":"#/components/schemas/access_include"},"is_default":{"$ref":"#/components/schemas/access_require"},"name":{"$ref":"#/components/schemas/access_groups_components-schemas-name"},"require":{"$ref":"#/components/schemas/access_require"},"updated_at":{"$ref":"#/components/schemas/access_updated_at"}},"type":"object"},"access_schemas-id":{"description":"The ID of the CA.","example":"7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9","maxLength":48,"readOnly":true,"type":"string","x-auditable":true},"access_schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/access_schemas-id"}},"type":"object"}}}],"type":"object"},"access_schemas-identifier":{"allOf":[{"$ref":"#/components/schemas/access_identifier"},{"example":"699d98642c564d2e855e9661899b7252"}]},"access_schemas-identity-provider":{"properties":{"config":{"description":"The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).","type":"object"},"id":{"$ref":"#/components/schemas/access_uuid"},"name":{"$ref":"#/components/schemas/access_components-schemas-name"},"scim_config":{"description":"The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.","properties":{"enabled":{"default":false,"description":"A flag to enable or disable SCIM for the identity provider.","type":"boolean","x-stainless-terraform-configurability":"computed_optional"},"identity_update_behavior":{"default":"no_action","description":"Indicates how a SCIM event updates a user identity used for policy evaluation. Use \"automatic\" to automatically update a user's identity and augment it with fields from the SCIM user resource. Use \"reauth\" to force re-authentication on group membership updates, user identity update will only occur after successful re-authentication. With \"reauth\" identities will not contain fields from the SCIM user resource. With \"no_action\" identities will not be changed by SCIM updates in any way and users will not be prompted to reauthenticate.","enum":["automatic","reauth","no_action"],"type":"string","x-stainless-terraform-configurability":"computed_optional"},"scim_base_url":{"description":"The base URL of Cloudflare's SCIM V2.0 API endpoint.","readOnly":true,"type":"string"},"seat_deprovision":{"default":false,"description":"A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider.  This cannot be enabled unless user_deprovision is also enabled.","type":"boolean","x-stainless-terraform-configurability":"computed_optional"},"secret":{"description":"A read-only token generated when the SCIM integration is enabled for the first time.  It is redacted on subsequent requests. If you lose this you will need to refresh it at /access/identity_providers/:idpID/refresh_scim_secret.","readOnly":true,"type":"string","x-sensitive":true},"user_deprovision":{"default":false,"description":"A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider.","type":"boolean","x-stainless-terraform-configurability":"computed_optional"}},"type":"object"},"type":{"description":"The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).","enum":["onetimepin","azureAD","saml","centrify","facebook","github","google-apps","google","linkedin","oidc","okta","onelogin","pingone","yandex"],"example":"onetimepin","type":"string"}},"required":["name","type","config"],"type":"object"},"access_schemas-identity-providers":{"anyOf":[{"$ref":"#/components/schemas/access_schemas-azureAD"},{"$ref":"#/components/schemas/access_schemas-centrify"},{"$ref":"#/components/schemas/access_schemas-facebook"},{"$ref":"#/components/schemas/access_schemas-github"},{"$ref":"#/components/schemas/access_schemas-google"},{"$ref":"#/components/schemas/access_schemas-google-apps"},{"$ref":"#/components/schemas/access_schemas-linkedin"},{"$ref":"#/components/schemas/access_schemas-oidc"},{"$ref":"#/components/schemas/access_schemas-okta"},{"$ref":"#/components/schemas/access_schemas-onelogin"},{"$ref":"#/components/schemas/access_schemas-pingone"},{"$ref":"#/components/schemas/access_schemas-saml"},{"$ref":"#/components/schemas/access_schemas-yandex"}]},"access_schemas-include":{"default":[],"description":"Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.","items":{"$ref":"#/components/schemas/access_rule"},"type":"array","x-stainless-collection-type":"set"},"access_schemas-is_ui_read_only":{"description":"Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled.","example":"false","type":"boolean"},"access_schemas-isolation_required":{"default":false,"description":"Require this application to be served in an isolated browser for users matching this policy.","example":false,"type":"boolean"},"access_schemas-linkedin":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/access_schemas-generic-oauth-config"}},"type":"object"}],"title":"LinkedIn","type":"object"},"access_schemas-login_design":{"properties":{"background_color":{"description":"The background color on your login page.","example":"#c5ed1b","type":"string"},"footer_text":{"description":"The text at the bottom of your login page.","example":"This is an example description.","type":"string"},"header_text":{"description":"The text at the top of your login page.","example":"This is an example description.","type":"string"},"logo_path":{"description":"The URL of the logo on your login page.","example":"https://example.com/logo.png","type":"string"},"text_color":{"description":"The text color on your login page.","example":"#c5ed1b","type":"string"}}},"access_schemas-logo_url":{"description":"The image URL for the logo shown in the App Launcher dashboard.","example":"https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg","type":"string","x-auditable":true},"access_schemas-name":{"description":"The name of the service token.","example":"CI/CD token","type":"string","x-auditable":true},"access_schemas-oidc":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_schemas-generic-oauth-config"},{"properties":{"auth_url":{"description":"The authorization_endpoint URL of your IdP","example":"https://accounts.google.com/o/oauth2/auth","type":"string"},"certs_url":{"description":"The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens","example":"https://www.googleapis.com/oauth2/v3/certs","type":"string"},"claims":{"description":"List of custom claims that will be pulled from your id_token and added to your signed Access JWT token.","example":["given_name","locale"],"items":{"type":"string"},"type":"array"},"scopes":{"description":"OAuth scopes","example":["openid","email","profile"],"items":{"type":"string"},"type":"array"},"token_url":{"description":"The token_endpoint URL of your IdP","example":"https://accounts.google.com/o/oauth2/token","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Generic OAuth","type":"object"},"access_schemas-oidc_saas_app":{"properties":{"access_token_lifetime":{"description":"The lifetime of the OIDC Access Token after creation. Valid units are m,h. Must be greater than or equal to 1m and less than or equal to 24h.","example":"5m","type":"string"},"allow_pkce_without_client_secret":{"description":"If client secret should be required on the token endpoint when authorization_code_with_pkce grant is used.","example":true,"type":"boolean"},"app_launcher_url":{"description":"The URL where this applications tile redirects users","example":"https://example.com/login","type":"string"},"auth_type":{"description":"Identifier of the authentication protocol used for the saas app. Required for OIDC.","enum":["saml","oidc"],"example":"oidc","type":"string"},"client_id":{"description":"The application client id","example":"oidc client id","type":"string"},"client_secret":{"description":"The application client secret, only returned on POST request.","example":"oidc client secret","type":"string","x-sensitive":true},"created_at":{"$ref":"#/components/schemas/access_timestamp"},"custom_claims":{"items":{"properties":{"name":{"description":"The name of the claim.","example":"family_name","type":"string"},"required":{"description":"If the claim is required when building an OIDC token.","example":true,"type":"boolean"},"scope":{"description":"The scope of the claim.","enum":["groups","profile","email","openid"],"example":"profile","type":"string"},"source":{"properties":{"name":{"description":"The name of the IdP claim.","example":"last_name","type":"string"},"name_by_idp":{"description":"A mapping from IdP ID to attribute name.","items":{"properties":{"idp_id":{"description":"The UID of the IdP.","example":"exampleIdPID1","type":"string"},"source_name":{"description":"The name of the IdP provided attribute.","example":"AttributeName1","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"type":"object"},"type":"array"},"grant_types":{"description":"The OIDC flows supported by this application","example":["authorization_code"],"items":{"enum":["authorization_code","authorization_code_with_pkce","refresh_tokens","hybrid","implicit"],"type":"string"},"type":"array"},"group_filter_regex":{"description":"A regex to filter Cloudflare groups returned in ID token and userinfo endpoint.","example":"^GROUP_FILTER-*$","type":"string"},"hybrid_and_implicit_options":{"properties":{"return_access_token_from_authorization_endpoint":{"description":"If an Access Token should be returned from the OIDC Authorization endpoint","type":"boolean"},"return_id_token_from_authorization_endpoint":{"description":"If an ID Token should be returned from the OIDC Authorization endpoint","type":"boolean"}},"type":"object"},"public_key":{"description":"The Access public certificate that will be used to verify your identity.","example":"example unique name","type":"string"},"redirect_uris":{"description":"The permitted URL's for Cloudflare to return Authorization codes and Access/ID tokens","example":["https://example.com"],"items":{"type":"string"},"type":"array"},"refresh_token_options":{"properties":{"lifetime":{"description":"How long a refresh token will be valid for after creation. Valid units are m,h,d. Must be longer than 1m.","example":"30d","type":"string"}},"type":"object"},"scopes":{"description":"Define the user information shared with access, \"offline_access\" scope will be automatically enabled if refresh tokens are enabled","example":["openid","groups","email","profile"],"items":{"enum":["openid","groups","email","profile"],"type":"string"},"type":"array"},"updated_at":{"$ref":"#/components/schemas/access_timestamp"}},"title":"OIDC SaaS App","type":"object"},"access_schemas-okta":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_schemas-generic-oauth-config"},{"properties":{"okta_account":{"description":"Your okta account url","example":"https://dev-abc123.oktapreview.com","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Okta","type":"object"},"access_schemas-onelogin":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_schemas-generic-oauth-config"},{"properties":{"onelogin_account":{"description":"Your OneLogin account url","example":"https://mycompany.onelogin.com","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"OneLogin","type":"object"},"access_schemas-onetimepin":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"properties":{"redirect_url":{"readOnly":true,"type":"string"}},"type":"object"},"type":{"enum":["onetimepin"]}}}],"title":"One Time Pin","type":"object"},"access_schemas-options_preflight_bypass":{"default":false,"description":"Allows options preflight requests to bypass Access authentication and go directly to the origin. Cannot turn on if cors_headers is set.","example":true,"type":"boolean"},"access_schemas-organizations":{"properties":{"auth_domain":{"$ref":"#/components/schemas/access_schemas-auth_domain"},"created_at":{"$ref":"#/components/schemas/access_timestamp"},"is_ui_read_only":{"$ref":"#/components/schemas/access_schemas-is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/access_schemas-login_design"},"name":{"$ref":"#/components/schemas/access_organizations_components-schemas-name"},"ui_read_only_toggle_reason":{"$ref":"#/components/schemas/access_ui_read_only_toggle_reason"},"updated_at":{"$ref":"#/components/schemas/access_timestamp"},"user_seat_expiration_inactive_time":{"$ref":"#/components/schemas/access_schemas-user_seat_expiration_inactive_time"}},"type":"object"},"access_schemas-pingone":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/access_schemas-generic-oauth-config"},{"properties":{"ping_env_id":{"description":"Your PingOne environment identifier","example":"342b5660-0c32-4936-a5a4-ce21fae57b0a","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"PingOne","type":"object"},"access_schemas-policy_check_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"properties":{"app_state":{"properties":{"app_uid":{"$ref":"#/components/schemas/access_uuid"},"aud":{"example":"737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389","type":"string"},"hostname":{"example":"test.com","type":"string"},"name":{"example":"Test App","type":"string"},"policies":{"example":[{"decision":"allow","exclude":[],"include":[{"_type":"email","email":"testuser@gmail.com"}],"precedence":0,"require":[],"status":"Success"}],"items":{},"type":"array"},"status":{"example":"Success","type":"string"}},"type":"object"},"user_identity":{"properties":{"account_id":{"example":"41ecfbb341f033e52b46742756aabb8b","type":"string"},"device_sessions":{"example":{},"type":"object"},"email":{"example":"testuser@gmail.com","type":"string"},"geo":{"properties":{"country":{"example":"US","type":"string"}},"type":"object"},"iat":{"type":"integer"},"id":{"example":"1164449231815010287495","type":"string"},"is_gateway":{"example":false,"type":"boolean"},"is_warp":{"example":false,"type":"boolean"},"name":{"example":"Test User","type":"string"},"user_uuid":{"$ref":"#/components/schemas/access_uuid"},"version":{"type":"integer"}},"type":"object"}},"type":"object"}}}],"type":"object"},"access_schemas-precedence":{"description":"The order of execution for this policy. Must be unique for each policy.","type":"integer"},"access_schemas-purpose_justification_required":{"default":false,"description":"Require users to enter a justification when they log in to the application.","example":true,"type":"boolean"},"access_schemas-require":{"default":[],"description":"Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.","items":{"$ref":"#/components/schemas/access_rule"},"type":"array","x-stainless-collection-type":"set"},"access_schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_schemas-groups"},"type":"array"}}}],"type":"object"},"access_schemas-response_collection_hostnames":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_schemas-settings"},"type":"array"}}}],"type":"object"},"access_schemas-saas_props":{"properties":{"allowed_idps":{"$ref":"#/components/schemas/access_allowed_idps"},"app_launcher_visible":{"$ref":"#/components/schemas/access_app_launcher_visible"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/access_schemas-auto_redirect_to_identity"},"logo_url":{"$ref":"#/components/schemas/access_logo_url"},"name":{"$ref":"#/components/schemas/access_apps_components-schemas-name"},"saas_app":{"oneOf":[{"$ref":"#/components/schemas/access_schemas-saml_saas_app"},{"$ref":"#/components/schemas/access_schemas-oidc_saas_app"}],"type":"object"},"type":{"description":"The application type.","example":"saas","type":"string"}},"title":"SaaS Application","type":"object"},"access_schemas-saml":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"properties":{"attributes":{"description":"A list of SAML attribute names that will be added to your signed JWT token and can be used in SAML policy rules.","example":["group","department_code","divison"],"items":{"type":"string"},"type":"array"},"email_attribute_name":{"description":"The attribute name for email in the SAML response.","example":"Email","type":"string"},"header_attributes":{"description":"Add a list of attribute names that will be returned in the response header from the Access callback.","items":{"properties":{"attribute_name":{"description":"attribute name from the IDP","type":"string"},"header_name":{"description":"header that will be added on the request to the origin","type":"string"}},"type":"object"},"type":"array"},"idp_public_certs":{"description":"X509 certificate to verify the signature in the SAML authentication response","items":{"type":"string"},"type":"array"},"issuer_url":{"description":"IdP Entity ID or Issuer URL","example":"https://whoami.com","type":"string"},"sign_request":{"description":"Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints.","type":"boolean"},"sso_target_url":{"description":"URL to send the SAML authentication requests to","example":"https://edgeaccess.org/idp/saml/login","type":"string"}},"type":"object"}},"type":"object"}],"title":"Generic SAML","type":"object"},"access_schemas-saml_saas_app":{"properties":{"auth_type":{"description":"Optional identifier indicating the authentication protocol used for the saas app. Required for OIDC. Default if unset is \"saml\"","enum":["saml","oidc"],"example":"saml","type":"string"},"consumer_service_url":{"description":"The service provider's endpoint that is responsible for receiving and parsing a SAML assertion.","example":"https://example.com","type":"string"},"created_at":{"$ref":"#/components/schemas/access_timestamp"},"custom_attributes":{"items":{"properties":{"friendly_name":{"description":"The SAML FriendlyName of the attribute.","example":"Last Name","type":"string"},"name":{"description":"The name of the attribute.","example":"family_name","type":"string"},"name_format":{"description":"A globally unique name for an identity or service provider.","enum":["urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified","urn:oasis:names:tc:SAML:2.0:attrname-format:basic","urn:oasis:names:tc:SAML:2.0:attrname-format:uri"],"example":"urn:oasis:names:tc:SAML:2.0:attrname-format:basic","type":"string"},"required":{"description":"If the attribute is required when building a SAML assertion.","example":true,"type":"boolean"},"source":{"properties":{"name":{"description":"The name of the IdP attribute.","example":"last_name","type":"string"},"name_by_idp":{"additionalProperties":{"type":"string"},"description":"A mapping from IdP ID to attribute name.","example":{"exampleIdPID1":"AttributeName1","exampleIdPID2":"AttributeName2"},"type":"object"}},"type":"object"}},"type":"object"},"type":"array"},"idp_entity_id":{"description":"The unique identifier for your SaaS application.","example":"https://example.cloudflareaccess.com","type":"string","x-stainless-configurability":"computed_optional"},"name_id_format":{"description":"The format of the name identifier sent to the SaaS application.","enum":["id","email"],"example":"id","type":"string"},"name_id_transform_jsonata":{"description":"A [JSONata](https://jsonata.org/) expression that transforms an application's user identities into a NameID value for its SAML assertion. This expression should evaluate to a singular string. The output of this expression can override the `name_id_format` setting.\n","example":"$substringBefore(email, '@') \u0026 '+sandbox@' \u0026 $substringAfter(email, '@')","type":"string"},"public_key":{"description":"The Access public certificate that will be used to verify your identity.","example":"example unique name","type":"string","x-stainless-configurability":"computed_optional"},"sp_entity_id":{"description":"A globally unique name for an identity or service provider.","example":"example unique name","type":"string"},"sso_endpoint":{"description":"The endpoint where your SaaS application will send login requests.","example":"https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd","type":"string","x-stainless-configurability":"computed_optional"},"updated_at":{"$ref":"#/components/schemas/access_timestamp"}},"title":"SAML SaaS App","type":"object"},"access_schemas-scim_config":{"description":"Configuration for provisioning to this application via SCIM. This is currently in closed beta.","properties":{"authentication":{"oneOf":[{"$ref":"#/components/schemas/access_schemas-scim_config_single_authentication"},{"$ref":"#/components/schemas/access_schemas-scim_config_multi_authentication"}]},"deactivate_on_delete":{"description":"If false, we propagate DELETE requests to the target application for SCIM resources. If true, we only set `active` to false on the SCIM resource. This is useful because some targets do not support DELETE operations.","type":"boolean"},"enabled":{"description":"Whether SCIM provisioning is turned on for this application.","type":"boolean"},"idp_uid":{"description":"The UID of the IdP to use as the source for SCIM resources to provision to this application.","type":"string"},"mappings":{"description":"A list of mappings to apply to SCIM resources before provisioning them in this application. These can transform or filter the resources to be provisioned.","items":{"$ref":"#/components/schemas/access_scim_config_mapping"},"type":"array"},"remote_uri":{"description":"The base URI for the application's SCIM-compatible API.","type":"string"}},"required":["remote_uri","idp_uid"],"type":"object"},"access_schemas-scim_config_authentication_oauth_bearer_token":{"description":"Attributes for configuring OAuth Bearer Token authentication scheme for SCIM provisioning to an application.","properties":{"scheme":{"description":"The authentication scheme to use when making SCIM requests to this application.","enum":["oauthbearertoken"],"type":"string"},"token":{"description":"Token used to authenticate with the remote SCIM service.","type":"string"}},"required":["scheme","token"],"title":"OAuth Bearer Token","type":"object"},"access_schemas-scim_config_multi_authentication":{"description":"Multiple authentication schemes","items":{"$ref":"#/components/schemas/access_schemas-scim_config_single_authentication"},"type":"array"},"access_schemas-scim_config_single_authentication":{"oneOf":[{"$ref":"#/components/schemas/access_scim_config_authentication_http_basic"},{"$ref":"#/components/schemas/access_schemas-scim_config_authentication_oauth_bearer_token"},{"$ref":"#/components/schemas/access_scim_config_authentication_oauth2"},{"$ref":"#/components/schemas/access_scim_config_authentication_access_service_token"}]},"access_schemas-seat_uid":{"description":"The unique API identifier for the Zero Trust seat.","type":"string"},"access_schemas-self_hosted_props":{"properties":{"allow_iframe":{"$ref":"#/components/schemas/access_allow_iframe"},"allowed_idps":{"$ref":"#/components/schemas/access_allowed_idps"},"app_launcher_visible":{"$ref":"#/components/schemas/access_app_launcher_visible"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/access_schemas-auto_redirect_to_identity"},"cors_headers":{"$ref":"#/components/schemas/access_schemas-cors_headers"},"custom_deny_message":{"$ref":"#/components/schemas/access_custom_deny_message"},"custom_deny_url":{"$ref":"#/components/schemas/access_schemas-custom_deny_url"},"domain":{"$ref":"#/components/schemas/access_components-schemas-domain"},"enable_binding_cookie":{"$ref":"#/components/schemas/access_enable_binding_cookie"},"http_only_cookie_attribute":{"$ref":"#/components/schemas/access_http_only_cookie_attribute"},"logo_url":{"$ref":"#/components/schemas/access_logo_url"},"name":{"$ref":"#/components/schemas/access_apps_components-schemas-name"},"options_preflight_bypass":{"$ref":"#/components/schemas/access_schemas-options_preflight_bypass"},"same_site_cookie_attribute":{"$ref":"#/components/schemas/access_same_site_cookie_attribute"},"service_auth_401_redirect":{"$ref":"#/components/schemas/access_service_auth_401_redirect"},"session_duration":{"$ref":"#/components/schemas/access_apps_components-schemas-session_duration"},"skip_interstitial":{"$ref":"#/components/schemas/access_skip_interstitial"},"type":{"description":"The application type.","example":"self_hosted","type":"string"}},"required":["type","domain"],"title":"Self Hosted Application","type":"object"},"access_schemas-service-tokens":{"properties":{"client_id":{"$ref":"#/components/schemas/access_client_id"},"created_at":{"$ref":"#/components/schemas/access_timestamp"},"duration":{"$ref":"#/components/schemas/access_schemas-duration"},"expires_at":{"$ref":"#/components/schemas/access_timestamp"},"id":{"allOf":[{"description":"The ID of the service token."},{"$ref":"#/components/schemas/access_uuid"}]},"last_seen_at":{"$ref":"#/components/schemas/access_timestamp"},"name":{"$ref":"#/components/schemas/access_service-tokens_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/access_timestamp"}},"type":"object"},"access_schemas-session_duration":{"default":"24h","description":"The amount of time that tokens issued for this application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. Note: unsupported for infrastructure type applications.","example":"24h","type":"string"},"access_schemas-settings":{"additionalProperties":false,"properties":{"china_network":{"description":"Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.","example":false,"type":"boolean"},"client_certificate_forwarding":{"description":"Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.","example":true,"type":"boolean"},"hostname":{"description":"The hostname that these settings apply to.","example":"admin.example.com","type":"string"}},"required":["hostname","china_network","client_certificate_forwarding"],"title":"Hostname Settings","type":"object"},"access_schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_service-tokens"}}}],"type":"object"},"access_schemas-ssh_props":{"allOf":[{"$ref":"#/components/schemas/access_schemas-self_hosted_props"},{"properties":{"type":{"description":"The application type.","example":"ssh","type":"string"}}}]},"access_schemas-type":{"description":"Custom page type.","enum":["identity_denied","forbidden"],"type":"string","x-auditable":true},"access_schemas-user_seat_expiration_inactive_time":{"description":"The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count. Must be in the format `300ms` or `2h45m`. Valid time units are: `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.","example":"720h","type":"string"},"access_schemas-users":{"properties":{"access_seat":{"$ref":"#/components/schemas/access_schemas-access_seat"},"active_device_count":{"$ref":"#/components/schemas/access_active_device_count"},"created_at":{"$ref":"#/components/schemas/access_timestamp"},"email":{"$ref":"#/components/schemas/access_schemas-email"},"gateway_seat":{"$ref":"#/components/schemas/access_schemas-gateway_seat"},"id":{"$ref":"#/components/schemas/access_uuid"},"last_successful_login":{"$ref":"#/components/schemas/access_last_successful_login"},"name":{"$ref":"#/components/schemas/access_users_components-schemas-name"},"seat_uid":{"$ref":"#/components/schemas/access_schemas-seat_uid"},"uid":{"$ref":"#/components/schemas/access_uid"},"updated_at":{"$ref":"#/components/schemas/access_timestamp"}},"type":"object"},"access_schemas-uuid":{"description":"The UUID of the policy","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string"},"access_schemas-vnc_props":{"allOf":[{"$ref":"#/components/schemas/access_schemas-self_hosted_props"},{"properties":{"type":{"description":"The application type.","example":"vnc","type":"string"}}}]},"access_schemas-warp_props":{"allOf":[{"$ref":"#/components/schemas/access_schemas-feature_app_props"},{"properties":{"domain":{"example":"authdomain.cloudflareaccess.com/warp","readOnly":true},"name":{"default":"Warp Login App","example":"Warp Login App","readOnly":true},"type":{"description":"The application type.","example":"warp","type":"string"}}}]},"access_schemas-yandex":{"allOf":[{"$ref":"#/components/schemas/access_schemas-identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/access_schemas-generic-oauth-config"}},"type":"object"}],"title":"Yandex","type":"object"},"access_scim_config":{"description":"Configuration for provisioning to this application via SCIM. This is currently in closed beta.","properties":{"authentication":{"oneOf":[{"$ref":"#/components/schemas/access_scim_config_single_authentication"},{"$ref":"#/components/schemas/access_scim_config_multi_authentication"}]},"deactivate_on_delete":{"description":"If false, propagates DELETE requests to the target application for SCIM resources. If true, sets 'active' to false on the SCIM resource. Note: Some targets do not support DELETE operations.","type":"boolean"},"enabled":{"description":"Whether SCIM provisioning is turned on for this application.","type":"boolean"},"idp_uid":{"description":"The UID of the IdP to use as the source for SCIM resources to provision to this application.","type":"string"},"mappings":{"description":"A list of mappings to apply to SCIM resources before provisioning them in this application. These can transform or filter the resources to be provisioned.","items":{"$ref":"#/components/schemas/access_scim_config_mapping"},"type":"array"},"remote_uri":{"description":"The base URI for the application's SCIM-compatible API.","type":"string"}},"required":["remote_uri","idp_uid"],"type":"object"},"access_scim_config_authentication_access_service_token":{"description":"Attributes for configuring Access Service Token authentication scheme for SCIM provisioning to an application.","properties":{"client_id":{"description":"Client ID of the Access service token used to authenticate with the remote service.","type":"string"},"client_secret":{"description":"Client secret of the Access service token used to authenticate with the remote service.","type":"string","x-sensitive":true},"scheme":{"description":"The authentication scheme to use when making SCIM requests to this application.","enum":["access_service_token"],"type":"string"}},"required":["scheme","client_id","client_secret"],"title":"Access Service Token","type":"object"},"access_scim_config_authentication_http_basic":{"description":"Attributes for configuring HTTP Basic authentication scheme for SCIM provisioning to an application.","properties":{"password":{"description":"Password used to authenticate with the remote SCIM service.","type":"string"},"scheme":{"description":"The authentication scheme to use when making SCIM requests to this application.","enum":["httpbasic"],"type":"string"},"user":{"description":"User name used to authenticate with the remote SCIM service.","type":"string"}},"required":["scheme","user","password"],"title":"HTTP Basic","type":"object"},"access_scim_config_authentication_oauth2":{"description":"Attributes for configuring OAuth 2 authentication scheme for SCIM provisioning to an application.","properties":{"authorization_url":{"description":"URL used to generate the auth code used during token generation.","type":"string"},"client_id":{"description":"Client ID used to authenticate when generating a token for authenticating with the remote SCIM service.","type":"string"},"client_secret":{"description":"Secret used to authenticate when generating a token for authenticating with the remove SCIM service.","type":"string","x-sensitive":true},"scheme":{"description":"The authentication scheme to use when making SCIM requests to this application.","enum":["oauth2"],"type":"string"},"scopes":{"description":"The authorization scopes to request when generating the token used to authenticate with the remove SCIM service.","items":{"type":"string"},"type":"array"},"token_url":{"description":"URL used to generate the token used to authenticate with the remote SCIM service.","type":"string"}},"required":["scheme","client_id","client_secret","authorization_url","token_url"],"title":"OAuth 2","type":"object"},"access_scim_config_authentication_oauth_bearer_token":{"description":"Attributes for configuring OAuth Bearer Token authentication scheme for SCIM provisioning to an application.","properties":{"scheme":{"description":"The authentication scheme to use when making SCIM requests to this application.","enum":["oauthbearertoken"],"type":"string"},"token":{"description":"Token used to authenticate with the remote SCIM service.","type":"string","x-sensitive":true}},"required":["scheme","token"],"title":"OAuth Bearer Token","type":"object"},"access_scim_config_mapping":{"description":"Transformations and filters applied to resources before they are provisioned in the remote SCIM service.","properties":{"enabled":{"description":"Whether or not this mapping is enabled.","type":"boolean"},"filter":{"description":"A [SCIM filter expression](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2) that matches resources that should be provisioned to this application.","example":"title pr or userType eq \"Intern\"","type":"string"},"operations":{"description":"Whether or not this mapping applies to creates, updates, or deletes.","properties":{"create":{"description":"Whether or not this mapping applies to create (POST) operations.","type":"boolean"},"delete":{"description":"Whether or not this mapping applies to DELETE operations.","type":"boolean"},"update":{"description":"Whether or not this mapping applies to update (PATCH/PUT) operations.","type":"boolean"}},"type":"object"},"schema":{"description":"Which SCIM resource type this mapping applies to.","example":"urn:ietf:params:scim:schemas:core:2.0:User","type":"string"},"strictness":{"description":"The level of adherence to outbound resource schemas when provisioning to this mapping. ‘Strict’ removes unknown values, while ‘passthrough’ passes unknown values to the target.","enum":["strict","passthrough"],"type":"string"},"transform_jsonata":{"description":"A [JSONata](https://jsonata.org/) expression that transforms the resource before provisioning it in the application.","example":"$merge([$, {'userName': $substringBefore($.userName, '@') \u0026 '+test@' \u0026 $substringAfter($.userName, '@')}])","type":"string"}},"required":["schema"],"type":"object"},"access_scim_config_multi_authentication":{"description":"Multiple authentication schemes","items":{"$ref":"#/components/schemas/access_scim_config_single_authentication"},"type":"array"},"access_scim_config_single_authentication":{"oneOf":[{"$ref":"#/components/schemas/access_scim_config_authentication_http_basic"},{"$ref":"#/components/schemas/access_scim_config_authentication_oauth_bearer_token"},{"$ref":"#/components/schemas/access_scim_config_authentication_oauth2"},{"$ref":"#/components/schemas/access_scim_config_authentication_access_service_token"}]},"access_scim_groups_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_groups"},"type":"array"}},"type":"object"}]},"access_scim_update_logs_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_responses"},"type":"array"}},"type":"object"}]},"access_scim_users_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_users"},"type":"array"}},"type":"object"}]},"access_seat":{"properties":{"access_seat":{"$ref":"#/components/schemas/access_access_seat"},"gateway_seat":{"$ref":"#/components/schemas/access_gateway_seat"},"seat_uid":{"$ref":"#/components/schemas/access_seat_uid"}},"required":["seat_uid","gateway_seat","access_seat"],"type":"object"},"access_seat_uid":{"description":"The unique API identifier for the Zero Trust seat.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string","x-auditable":true},"access_seats":{"properties":{"access_seat":{"$ref":"#/components/schemas/access_access_seat"},"created_at":{"$ref":"#/components/schemas/access_timestamp"},"gateway_seat":{"$ref":"#/components/schemas/access_gateway_seat"},"seat_uid":{"$ref":"#/components/schemas/access_seat_uid"},"updated_at":{"$ref":"#/components/schemas/access_timestamp"}},"type":"object"},"access_seats_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_seats"},"type":"array"}}}],"type":"object"},"access_seats_definition":{"items":{"$ref":"#/components/schemas/access_seat"},"required":["seat_uid","gateway_seat","access_seat"],"type":"array"},"access_self_hosted_domains":{"default":[],"deprecated":true,"description":"List of public domains that Access will secure. This field is deprecated in favor of `destinations` and will be supported until **November 21, 2025.** If `destinations` are provided, then `self_hosted_domains` will be ignored.\n","example":["test.example.com/admin","test.anotherexample.com/staff"],"items":{"description":"A domain that Access will secure.","type":"string"},"type":"array"},"access_self_hosted_props":{"properties":{"allow_authenticate_via_warp":{"$ref":"#/components/schemas/access_schemas-allow_authenticate_via_warp"},"allow_iframe":{"$ref":"#/components/schemas/access_allow_iframe"},"allowed_idps":{"$ref":"#/components/schemas/access_allowed_idps"},"app_launcher_visible":{"$ref":"#/components/schemas/access_app_launcher_visible"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/access_schemas-auto_redirect_to_identity"},"cors_headers":{"$ref":"#/components/schemas/access_cors_headers"},"custom_deny_message":{"$ref":"#/components/schemas/access_custom_deny_message"},"custom_deny_url":{"$ref":"#/components/schemas/access_custom_deny_url"},"custom_non_identity_deny_url":{"$ref":"#/components/schemas/access_custom_non_identity_deny_url"},"custom_pages":{"$ref":"#/components/schemas/access_schemas-custom_pages"},"destinations":{"$ref":"#/components/schemas/access_destinations"},"domain":{"$ref":"#/components/schemas/access_domain"},"enable_binding_cookie":{"$ref":"#/components/schemas/access_enable_binding_cookie"},"http_only_cookie_attribute":{"$ref":"#/components/schemas/access_http_only_cookie_attribute"},"logo_url":{"$ref":"#/components/schemas/access_logo_url"},"name":{"$ref":"#/components/schemas/access_apps_components-schemas-name"},"options_preflight_bypass":{"$ref":"#/components/schemas/access_options_preflight_bypass"},"path_cookie_attribute":{"$ref":"#/components/schemas/access_path_cookie_attribute"},"read_service_tokens_from_header":{"$ref":"#/components/schemas/access_read_service_tokens_from_header"},"same_site_cookie_attribute":{"$ref":"#/components/schemas/access_same_site_cookie_attribute"},"scim_config":{"$ref":"#/components/schemas/access_scim_config"},"self_hosted_domains":{"$ref":"#/components/schemas/access_self_hosted_domains"},"service_auth_401_redirect":{"$ref":"#/components/schemas/access_service_auth_401_redirect"},"session_duration":{"$ref":"#/components/schemas/access_schemas-session_duration"},"skip_interstitial":{"$ref":"#/components/schemas/access_skip_interstitial"},"tags":{"$ref":"#/components/schemas/access_tags"},"type":{"allOf":[{"$ref":"#/components/schemas/access_type"},{"example":"self_hosted"}]}},"required":["type","domain"],"title":"Self Hosted Application","type":"object"},"access_service-tokens":{"properties":{"client_id":{"$ref":"#/components/schemas/access_client_id"},"created_at":{"$ref":"#/components/schemas/access_created_at"},"duration":{"$ref":"#/components/schemas/access_duration"},"expires_at":{"$ref":"#/components/schemas/access_timestamp"},"id":{"allOf":[{"description":"The ID of the service token."},{"$ref":"#/components/schemas/access_uuid"}]},"last_seen_at":{"allOf":[{"x-stainless-skip":true},{"$ref":"#/components/schemas/access_timestamp"}]},"name":{"$ref":"#/components/schemas/access_schemas-name"},"updated_at":{"$ref":"#/components/schemas/access_updated_at"}},"type":"object"},"access_service-tokens_components-schemas-name":{"description":"The name of the service token.","example":"CI/CD token","type":"string"},"access_service-tokens_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_schemas-service-tokens"},"type":"array"}}}],"type":"object"},"access_service-tokens_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_schemas-service-tokens"}}}],"type":"object"},"access_service_auth_401_redirect":{"description":"Returns a 401 status code when the request is blocked by a Service Auth policy.","example":true,"type":"boolean"},"access_service_token_rule":{"description":"Matches a specific Access Service Token","properties":{"service_token":{"properties":{"token_id":{"description":"The ID of a Service Token.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f","type":"string"}},"required":["token_id"],"type":"object"}},"required":["service_token"],"title":"Service Token","type":"object"},"access_session_duration":{"description":"The amount of time that tokens issued for applications will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.","example":"24h","type":"string"},"access_settings":{"additionalProperties":false,"properties":{"china_network":{"description":"Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.","example":false,"type":"boolean","x-auditable":true},"client_certificate_forwarding":{"description":"Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.","example":true,"type":"boolean","x-auditable":true},"hostname":{"description":"The hostname that these settings apply to.","example":"admin.example.com","type":"string","x-auditable":true}},"required":["hostname","china_network","client_certificate_forwarding"],"title":"Hostname Settings","type":"object"},"access_since":{"description":"the timestamp of the earliest update log.","example":"2025-01-01T00:00:00Z","format":"date-time","type":"string"},"access_single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"type":"object"},{"properties":{"result":{"$ref":"#/components/schemas/access_organizations"}}}],"type":"object"},"access_single_response_update":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_app_settings_response"}}}],"type":"object"},"access_single_response_without_html":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_custom_page_without_html"}}}],"type":"object"},"access_skip_app_launcher_login_page":{"default":false,"description":"Determines when to skip the App Launcher landing page.","example":true,"type":"boolean"},"access_skip_interstitial":{"description":"Enables automatic authentication through cloudflared.","example":true,"type":"boolean"},"access_ssh_props":{"allOf":[{"$ref":"#/components/schemas/access_self_hosted_props"},{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/access_type"},{"example":"ssh"}]}}}]},"access_status":{"description":"The status of the policy test request.","enum":["success"],"example":"success","type":"string","x-auditable":true},"access_string_key_map_device_session":{"additionalProperties":{"$ref":"#/components/schemas/access_device_session"},"type":"object"},"access_tag":{"description":"A tag","properties":{"app_count":{"description":"The number of applications that have this tag","example":1,"type":"integer","x-auditable":true,"x-stainless-skip":true},"created_at":{"$ref":"#/components/schemas/access_created_at"},"name":{"$ref":"#/components/schemas/access_tags_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/access_updated_at"}},"required":["name"],"type":"object"},"access_tag_without_app_count":{"description":"A tag","properties":{"created_at":{"$ref":"#/components/schemas/access_created_at"},"name":{"$ref":"#/components/schemas/access_tags_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/access_updated_at"}},"required":["name"],"type":"object"},"access_tags":{"default":[],"description":"The tags you want assigned to an application. Tags are used to filter applications in the App Launcher dashboard.","items":{"description":"The tag associated with an application.","example":"engineers","type":"string"},"type":"array","x-stainless-collection-type":"set"},"access_tags_components-schemas-name":{"description":"The name of the tag","example":"engineers","type":"string"},"access_tags_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_tag"},"type":"array"}},"type":"object"}],"type":"object"},"access_tags_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/access_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/access_tag"}},"type":"object"}],"type":"object"},"access_target_attributes":{"additionalProperties":{"example":["test-server","production-server"],"items":{"type":"string"},"type":"array"},"description":"Contains a map of target attribute keys to target attribute values.","example":{"hostname":["test-server","production-server"]},"type":"object"},"access_target_criteria_base":{"properties":{"port":{"$ref":"#/components/schemas/access_port"},"target_attributes":{"$ref":"#/components/schemas/access_target_attributes"}},"required":["target_attributes","port","protocol"],"title":"Target Criteria","type":"object"},"access_target_criteria_infra_app":{"allOf":[{"$ref":"#/components/schemas/access_target_criteria_base"},{"properties":{"protocol":{"$ref":"#/components/schemas/access_protocol_infra_app"}},"type":"object"}]},"access_target_criteria_self_hosted_app":{"allOf":[{"$ref":"#/components/schemas/access_target_criteria_base"},{"properties":{"protocol":{"$ref":"#/components/schemas/access_protocol_self_hosted_app"}},"type":"object"}]},"access_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true},"access_title":{"default":"Welcome!","description":"The title shown on the landing page.","example":"Welcome back!","type":"string"},"access_total_users":{"description":"The total number of users in the user base.","example":20,"type":"integer","x-auditable":true},"access_type":{"description":"The application type.","enum":["self_hosted","saas","ssh","vnc","app_launcher","warp","biso","bookmark","dash_sso","infrastructure","rdp","mcp","mcp_portal","proxy_endpoint"],"example":"self_hosted","type":"string"},"access_ui_read_only_toggle_reason":{"description":"A description of the reason why the UI read only field is being toggled.","example":"Temporarily turn off the UI read only lock to make a change via the UI","type":"string"},"access_uid":{"description":"The unique API identifier for the user.","type":"string"},"access_until":{"description":"the timestamp of the most-recent update log.","example":"2025-01-02T00:00:00Z","format":"date-time","type":"string"},"access_update_status":{"description":"The status of the policy test.","enum":["blocked","processing","exceeded time","complete"],"example":"complete","type":"string","x-auditable":true},"access_updated_at":{"allOf":[{"x-stainless-skip":true},{"$ref":"#/components/schemas/access_timestamp"}]},"access_user_id":{"description":"The UUID of the authenticating user.","example":"f757c5c3-c1b2-50f7-9126-150a099b6f7e","format":"uuid","type":"string"},"access_user_result":{"description":"Policy evaluation result for an individual user.","enum":["approved","blocked","error"],"example":"approved","type":"string","x-auditable":true},"access_user_seat_expiration_inactive_time":{"description":"The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count.  Minimum value for this setting is 1 month (730h). Must be in the format `300ms` or `2h45m`. Valid time units are: `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.","example":"730h","type":"string","x-auditable":true},"access_username":{"description":"The username of the SCIM User resource.","example":"John Smith","type":"string"},"access_usernames":{"description":"Contains the Unix usernames that may be used when connecting over SSH.","example":["root","ubuntu"],"items":{"type":"string","x-auditable":true},"type":"array"},"access_users":{"properties":{"active":{"description":"Determines the status of the SCIM User resource.","example":true,"type":"boolean"},"displayName":{"description":"The name of the SCIM User resource.","example":"John Smith","type":"string"},"emails":{"items":{"properties":{"primary":{"description":"Indicates if the email address is the primary email belonging to the SCIM User resource.","example":true,"type":"boolean"},"type":{"description":"Indicates the type of the email address.","example":"work","type":"string"},"value":{"description":"The email address of the SCIM User resource.","example":"john.smith@example.com","format":"email","type":"string"}},"type":"object"},"type":"array"},"externalId":{"description":"The IdP-generated Id of the SCIM resource.","example":"john_smith","type":"string"},"id":{"$ref":"#/components/schemas/access_id"},"meta":{"$ref":"#/components/schemas/access_meta"},"schemas":{"description":"The list of URIs which indicate the attributes contained within a SCIM resource.","example":["urn:ietf:params:scim:schemas:core:2.0:User"],"items":{"type":"string"},"type":"array"}},"type":"object"},"access_users-cf_resource_id":{"description":"The unique Cloudflare-generated Id of the SCIM User resource; also known as the \"Id\".","example":"bd97ef8d-7986-43e3-9ee0-c25dda33e4b0","type":"string"},"access_users-idp_resource_id":{"description":"The IdP-generated Id of the SCIM User resource; also known as the \"external Id\".","example":"john_smith_01","type":"string"},"access_users-name":{"description":"The name of the SCIM User resource.","example":"John Smith","type":"string"},"access_users_approved":{"description":"The number of (processed) users approved based on policy evaluation results.","example":5,"type":"integer","x-auditable":true},"access_users_blocked":{"description":"The number of (processed) users blocked based on policy evaluation results.","example":5,"type":"integer","x-auditable":true},"access_users_components-schemas-name":{"description":"The name of the user.","example":"Jane Doe","type":"string"},"access_users_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/access_api-response-collection"},{"properties":{"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1}},"type":"object"}}},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access_schemas-users"},"type":"array"}}}],"type":"object"},"access_users_errored":{"description":"The number of (processed) users errored based on policy evaluation results.","example":5,"type":"integer"},"access_uuid":{"description":"UUID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string","x-auditable":true},"access_vnc_props":{"allOf":[{"$ref":"#/components/schemas/access_self_hosted_props"},{"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/access_type"},{"example":"vnc"}]}}}]},"access_warp_auth_session_duration":{"description":"The amount of time that tokens issued for applications will be valid. Must be in the format `30m` or `2h45m`. Valid time units are: m, h.","example":"24h","type":"string","x-auditable":true},"access_warp_props":{"allOf":[{"$ref":"#/components/schemas/access_feature_app_props"},{"properties":{"domain":{"example":"authdomain.cloudflareaccess.com/warp","readOnly":true},"name":{"default":"Warp Login App","example":"Warp Login App","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/access_type"},{"example":"warp"}]}}}]},"access_yandex":{"allOf":[{"$ref":"#/components/schemas/access_identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/access_generic-oauth-config"}},"type":"object"}],"title":"Yandex","type":"object"},"addressing_account_identifier":{"description":"Identifier of a Cloudflare account.","example":"258def64c72dae45f3e4c8516e2111f2","maxLength":32,"type":"string","x-auditable":true},"addressing_address-maps":{"properties":{"can_delete":{"$ref":"#/components/schemas/addressing_can_delete"},"can_modify_ips":{"$ref":"#/components/schemas/addressing_can_modify_ips"},"created_at":{"$ref":"#/components/schemas/addressing_timestamp"},"default_sni":{"$ref":"#/components/schemas/addressing_default_sni"},"description":{"$ref":"#/components/schemas/addressing_schemas-description"},"enabled":{"$ref":"#/components/schemas/addressing_enabled"},"id":{"$ref":"#/components/schemas/addressing_address_map_identifier"},"modified_at":{"$ref":"#/components/schemas/addressing_timestamp"}},"type":"object"},"addressing_address-maps-ip":{"properties":{"created_at":{"$ref":"#/components/schemas/addressing_timestamp"},"ip":{"$ref":"#/components/schemas/addressing_ip"}},"type":"object"},"addressing_address-maps-membership":{"properties":{"can_delete":{"$ref":"#/components/schemas/addressing_schemas-can_delete"},"created_at":{"$ref":"#/components/schemas/addressing_timestamp"},"identifier":{"$ref":"#/components/schemas/addressing_identifier"},"kind":{"$ref":"#/components/schemas/addressing_kind"}},"type":"object"},"addressing_address-maps-membership-request":{"properties":{"identifier":{"$ref":"#/components/schemas/addressing_identifier"},"kind":{"$ref":"#/components/schemas/addressing_kind"}},"type":"object"},"addressing_address_map_identifier":{"description":"Identifier of an Address Map.","example":"055817b111884e0227e1be16a0be6ee0","maxLength":32,"type":"string","x-auditable":true},"addressing_advertised":{"deprecated":true,"description":"Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.","example":true,"nullable":true,"type":"boolean","x-auditable":true,"x-stainless-deprecation-message":"Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix."},"addressing_advertised_modified_at_nullable":{"deprecated":true,"description":"Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"type":"string","x-auditable":true,"x-stainless-deprecation-message":"Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix."},"addressing_advertised_response":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-single"},{"properties":{"result":{"properties":{"advertised":{"$ref":"#/components/schemas/addressing_components-schemas-advertised"},"advertised_modified_at":{"$ref":"#/components/schemas/addressing_modified_at_nullable"}},"type":"object"}}}]},"addressing_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"addressing_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/addressing_messages"},"messages":{"$ref":"#/components/schemas/addressing_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"addressing_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/addressing_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/addressing_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"addressing_api-response-single":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-common"}],"type":"object"},"addressing_approved":{"description":"Approval state of the prefix (P = pending, V = active).","example":"P","type":"string","x-auditable":true},"addressing_asn":{"description":"Autonomous System Number (ASN) the prefix will be advertised under.","example":13335,"type":"integer","x-auditable":true},"addressing_asn_prepend_count":{"default":0,"description":"Number of times to prepend the Cloudflare ASN to the BGP AS-Path attribute","example":2,"maximum":3,"minimum":0,"type":"integer","x-auditable":true},"addressing_auto_advertise_withdraw":{"default":false,"description":"Determines if Cloudflare advertises a BYOIP BGP prefix even when there is no matching BGP prefix in the Magic routing table. When true, Cloudflare will automatically withdraw the BGP prefix when there are no matching BGP routes, and will resume advertising when there is at least one matching BGP route.","example":true,"type":"boolean","x-auditable":true},"addressing_bgp_on_demand":{"properties":{"advertised":{"$ref":"#/components/schemas/addressing_schemas-advertised"},"advertised_modified_at":{"$ref":"#/components/schemas/addressing_modified_at_nullable"},"on_demand_enabled":{"$ref":"#/components/schemas/addressing_schemas-on_demand_enabled"},"on_demand_locked":{"$ref":"#/components/schemas/addressing_schemas-on_demand_locked"}},"type":"object"},"addressing_bgp_prefix_create":{"properties":{"cidr":{"$ref":"#/components/schemas/addressing_cidr"}},"required":["cidr"],"type":"object"},"addressing_bgp_prefix_identifier":{"description":"Identifier of BGP Prefix.","example":"7009ba364c7a5760798ceb430e603b74","maxLength":32,"type":"string","x-auditable":true},"addressing_bgp_prefix_update_advertisement":{"properties":{"asn_prepend_count":{"$ref":"#/components/schemas/addressing_asn_prepend_count"},"auto_advertise_withdraw":{"$ref":"#/components/schemas/addressing_auto_advertise_withdraw"},"on_demand":{"properties":{"advertised":{"type":"boolean"}},"type":"object"}},"type":"object"},"addressing_bgp_signal_opts":{"properties":{"enabled":{"$ref":"#/components/schemas/addressing_bgp_signaling_enabled"},"modified_at":{"$ref":"#/components/schemas/addressing_bgp_signaling_modified_at"}},"type":"object"},"addressing_bgp_signaling_enabled":{"description":"Whether control of advertisement of the prefix to the Internet is enabled to be performed via BGP signal","example":false,"type":"boolean","x-auditable":true},"addressing_bgp_signaling_modified_at":{"description":"Last time BGP signaling control was toggled. This field is null if BGP signaling has never been enabled.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"type":"string","x-auditable":true},"addressing_can_delete":{"description":"If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.","example":true,"readOnly":true,"type":"boolean","x-auditable":true},"addressing_can_modify_ips":{"description":"If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.","example":true,"readOnly":true,"type":"boolean","x-auditable":true},"addressing_cidr":{"description":"IP Prefix in Classless Inter-Domain Routing format.","example":"192.0.2.0/24","type":"string","x-auditable":true},"addressing_components-schemas-advertised":{"description":"Advertisement status of the prefix. If `true`, the BGP route for the prefix is advertised to the Internet. If \n`false`, the BGP route is withdrawn.\n","example":true,"type":"boolean","x-auditable":true},"addressing_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/addressing_address-maps"},"type":"array"}}}]},"addressing_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/addressing_address-maps"}}}]},"addressing_create_binding_request":{"properties":{"cidr":{"$ref":"#/components/schemas/addressing_cidr"},"service_id":{"$ref":"#/components/schemas/addressing_service_identifier"}},"required":["cidr","service_id"],"type":"object"},"addressing_created_at":{"description":"Timestamp of the moment the object was created.","format":"date-time","type":"string"},"addressing_default_sni":{"description":"If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.","example":"*.example.com","nullable":true,"type":"string","x-auditable":true},"addressing_delegate_loa_creation":{"default":false,"description":"Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.","example":true,"type":"boolean","x-auditable":true},"addressing_delegated_account_identifier":{"description":"Account identifier for the account to which prefix is being delegated.","example":"b1946ac92492d2347c6235b4d2611184","maxLength":32,"type":"string","x-auditable":true},"addressing_delegation_identifier":{"description":"Identifier of a Delegation.","example":"d933b1530bc56c9953cf8ce166da8004","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"addressing_description":{"description":"Description of the prefix.","example":"Internal test prefix","maxLength":1000,"type":"string","x-auditable":true},"addressing_enabled":{"default":false,"description":"Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.","example":true,"nullable":true,"type":"boolean","x-auditable":true},"addressing_full_response":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/addressing_address-maps"},{"properties":{"ips":{"$ref":"#/components/schemas/addressing_ips"},"memberships":{"$ref":"#/components/schemas/addressing_memberships"}},"type":"object"}]}},"type":"object"}]},"addressing_id_response":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/addressing_delegation_identifier"}},"type":"object"}}}]},"addressing_identifier":{"description":"The identifier for the membership (eg. a zone or account tag).","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"addressing_ip":{"description":"An IPv4 or IPv6 address.","example":"192.0.2.1","type":"string","x-auditable":true},"addressing_ip_address":{"description":"An IPv4 or IPv6 address.","example":"192.0.2.1","type":"string","x-auditable":true},"addressing_ipam-bgp-prefixes":{"properties":{"asn":{"$ref":"#/components/schemas/addressing_schemas-asn"},"asn_prepend_count":{"$ref":"#/components/schemas/addressing_asn_prepend_count"},"auto_advertise_withdraw":{"$ref":"#/components/schemas/addressing_auto_advertise_withdraw"},"bgp_signal_opts":{"$ref":"#/components/schemas/addressing_bgp_signal_opts"},"cidr":{"$ref":"#/components/schemas/addressing_cidr"},"created_at":{"$ref":"#/components/schemas/addressing_timestamp"},"id":{"$ref":"#/components/schemas/addressing_bgp_prefix_identifier"},"modified_at":{"$ref":"#/components/schemas/addressing_timestamp"},"on_demand":{"$ref":"#/components/schemas/addressing_bgp_on_demand"}},"type":"object"},"addressing_ipam-delegations":{"properties":{"cidr":{"$ref":"#/components/schemas/addressing_cidr"},"created_at":{"$ref":"#/components/schemas/addressing_timestamp"},"delegated_account_id":{"$ref":"#/components/schemas/addressing_delegated_account_identifier"},"id":{"$ref":"#/components/schemas/addressing_delegation_identifier"},"modified_at":{"$ref":"#/components/schemas/addressing_timestamp"},"parent_prefix_id":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},"type":"object"},"addressing_ipam-prefixes":{"properties":{"account_id":{"$ref":"#/components/schemas/addressing_account_identifier"},"advertised":{"$ref":"#/components/schemas/addressing_advertised"},"advertised_modified_at":{"$ref":"#/components/schemas/addressing_advertised_modified_at_nullable"},"approved":{"$ref":"#/components/schemas/addressing_approved"},"asn":{"$ref":"#/components/schemas/addressing_asn"},"cidr":{"$ref":"#/components/schemas/addressing_cidr"},"created_at":{"$ref":"#/components/schemas/addressing_timestamp"},"delegate_loa_creation":{"$ref":"#/components/schemas/addressing_delegate_loa_creation"},"description":{"$ref":"#/components/schemas/addressing_description"},"id":{"$ref":"#/components/schemas/addressing_prefix_identifier"},"irr_validation_state":{"$ref":"#/components/schemas/addressing_validation_state"},"loa_document_id":{"$ref":"#/components/schemas/addressing_loa_document_identifier"},"modified_at":{"$ref":"#/components/schemas/addressing_timestamp"},"on_demand_enabled":{"$ref":"#/components/schemas/addressing_on_demand_enabled"},"on_demand_locked":{"$ref":"#/components/schemas/addressing_on_demand_locked"},"ownership_validation_state":{"$ref":"#/components/schemas/addressing_validation_state"},"ownership_validation_token":{"$ref":"#/components/schemas/addressing_ownership_validation_token"},"rpki_validation_state":{"$ref":"#/components/schemas/addressing_validation_state"}},"type":"object"},"addressing_ips":{"description":"The set of IPs on the Address Map.","items":{"$ref":"#/components/schemas/addressing_address-maps-ip"},"type":"array"},"addressing_kind":{"description":"The type of the membership.","enum":["zone","account"],"example":"zone","type":"string","x-auditable":true},"addressing_lease":{"properties":{"active_from":{"description":"Timestamp of the moment the lease was created.\n","example":"2020-01-01T00:00:00Z","format":"date-time","type":"string"},"cidrs":{"description":"CIDRs attached to the lease","example":["192.0.2.100/32","192.0.2.101/32"],"items":{"$ref":"#/components/schemas/addressing_schemas-cidr"},"type":"array"},"created_at":{"$ref":"#/components/schemas/addressing_created_at"},"id":{"$ref":"#/components/schemas/addressing_lease_id"},"modified_at":{"$ref":"#/components/schemas/addressing_modified_at"},"owner_id":{"$ref":"#/components/schemas/addressing_lease_owner_id"},"purpose":{"description":"Describes the purpose of the addresses.","example":"Spectrum Static IPs","type":"string"}},"type":"object"},"addressing_lease_id":{"description":"Identifier for the lease","example":"8fee4b6fd361283a72381ccfda355471","type":"string"},"addressing_lease_owner_id":{"description":"Cloudflare account ID of the account owning the lease.","example":"3a7d3de1d0682240cf046c7f50866cc5","type":"string"},"addressing_leases_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/addressing_lease"},"type":"array"}}}]},"addressing_loa_document_identifier":{"description":"Identifier for the uploaded LOA document.","example":"d933b1530bc56c9953cf8ce166da8004","maxLength":32,"nullable":true,"type":"string","x-auditable":true},"addressing_membership_requests":{"description":"Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.","example":[{"identifier":"023e105f4ecef8ad9ca31a8372d0c353","kind":"zone"}],"items":{"$ref":"#/components/schemas/addressing_address-maps-membership-request"},"type":"array"},"addressing_memberships":{"description":"Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.","items":{"$ref":"#/components/schemas/addressing_address-maps-membership"},"type":"array"},"addressing_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"addressing_modified_at":{"description":"Timestamp of the moment the object was modified.","format":"date-time","type":"string"},"addressing_modified_at_nullable":{"description":"Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"type":"string","x-auditable":true},"addressing_on_demand_enabled":{"deprecated":true,"description":"Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.","example":true,"type":"boolean","x-auditable":true,"x-stainless-deprecation-message":"Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix."},"addressing_on_demand_locked":{"deprecated":true,"description":"Whether advertisement status of the prefix is locked, meaning it cannot be changed.","example":false,"type":"boolean","x-auditable":true,"x-stainless-deprecation-message":"Prefer the [BGP Prefixes API](https://developers.cloudflare.com/api/resources/addressing/subresources/prefixes/subresources/bgp_prefixes/) instead, which allows for advertising multiple BGP routes within a single IP Prefix."},"addressing_ownership_validation_token":{"description":"Token provided to demonstrate ownership of the prefix.","example":"1234a5b6-1234-1abc-12a3-1234a5b6789c","type":"string","x-auditable":true},"addressing_prefix_identifier":{"description":"Identifier of an IP Prefix.","example":"2af39739cc4e3b5910c918468bb89828","maxLength":32,"type":"string","x-auditable":true},"addressing_provisioning":{"description":"Status of a Service Binding's deployment to the Cloudflare network","properties":{"state":{"description":"When a binding has been deployed to a majority of Cloudflare datacenters, the binding will become active and can be used with its associated service.\n","enum":["provisioning","active"],"example":"provisioning","type":"string","x-auditable":true}},"type":"object"},"addressing_response_collection":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/addressing_ipam-prefixes"},"type":"array"}}}]},"addressing_response_collection_bgp":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/addressing_ipam-bgp-prefixes"},"type":"array"}}}]},"addressing_schemas-account_identifier":{"description":"Identifier of a Cloudflare account.","example":"258def64c72dae45f3e4c8516e2111f2","maxLength":32,"type":"string"},"addressing_schemas-advertised":{"description":"Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.","example":true,"nullable":true,"type":"boolean","x-auditable":true},"addressing_schemas-asn":{"description":"Autonomous System Number (ASN) the prefix will be advertised under.","example":13335,"nullable":true,"type":"integer","x-auditable":true},"addressing_schemas-can_delete":{"description":"Controls whether the membership can be deleted via the API or not.","example":true,"readOnly":true,"type":"boolean","x-auditable":true},"addressing_schemas-cidr":{"description":"IP Prefix in Classless Inter-Domain Routing format.","example":"192.0.2.0/24","type":"string"},"addressing_schemas-description":{"description":"An optional description field which may be used to describe the types of IPs or zones on the map.","example":"My Ecommerce zones","nullable":true,"type":"string","x-auditable":true},"addressing_schemas-on_demand_enabled":{"description":"Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.","example":true,"type":"boolean","x-auditable":true},"addressing_schemas-on_demand_locked":{"description":"Whether the advertisement status of the prefix is locked, meaning it cannot be changed.","example":false,"type":"boolean","x-auditable":true},"addressing_schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/addressing_ipam-delegations"},"type":"array"}}}]},"addressing_schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/addressing_ipam-delegations"}}}]},"addressing_service_binding":{"properties":{"cidr":{"$ref":"#/components/schemas/addressing_cidr"},"id":{"$ref":"#/components/schemas/addressing_service_binding_identifier"},"provisioning":{"$ref":"#/components/schemas/addressing_provisioning"},"service_id":{"$ref":"#/components/schemas/addressing_service_identifier"},"service_name":{"$ref":"#/components/schemas/addressing_service_name"}},"type":"object"},"addressing_service_binding_identifier":{"description":"Identifier of a Service Binding.","example":"0429b49b6a5155297b78e75a44b09e14","maxLength":32,"type":"string","x-auditable":true},"addressing_service_identifier":{"description":"Identifier of a Service on the Cloudflare network. Available services and their IDs may be found in the\n**List Services** endpoint.\n","example":"2db684ee7ca04e159946fd05b99e1bcd","maxLength":32,"type":"string","x-auditable":true},"addressing_service_name":{"description":"Name of a service running on the Cloudflare network","example":"Magic Transit","type":"string","x-auditable":true},"addressing_single_response":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/addressing_ipam-prefixes"}}}]},"addressing_single_response_bgp":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/addressing_ipam-bgp-prefixes"}}}]},"addressing_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true},"addressing_validation_state":{"description":"State of one kind of validation for an IP prefix.","example":"pending","type":"string","x-auditable":true},"addressing_zone_identifier":{"description":"Identifier of a zone.","example":"8ac8489932db6327334c9b6d58544cfe","maxLength":32,"type":"string","x-auditable":true},"api-shield_Rule":{"description":"A Token Validation rule that can enforce security policies using JWT Tokens.","properties":{"action":{"$ref":"#/components/schemas/api-shield_action"},"created_at":{"$ref":"#/components/schemas/api-shield_schemas-timestamp"},"description":{"$ref":"#/components/schemas/api-shield_schemas-description"},"enabled":{"$ref":"#/components/schemas/api-shield_enabled"},"expression":{"$ref":"#/components/schemas/api-shield_expression"},"id":{"$ref":"#/components/schemas/api-shield_schemas-uuid"},"last_updated":{"$ref":"#/components/schemas/api-shield_schemas-timestamp"},"selector":{"$ref":"#/components/schemas/api-shield_selector"},"title":{"$ref":"#/components/schemas/api-shield_schemas-title"}},"required":["title","description","action","enabled","expression","selector"],"type":"object"},"api-shield_TokenConfiguration":{"properties":{"created_at":{"$ref":"#/components/schemas/api-shield_schemas-timestamp"},"credentials":{"$ref":"#/components/schemas/api-shield_credentials"},"description":{"$ref":"#/components/schemas/api-shield_description"},"id":{"$ref":"#/components/schemas/api-shield_schemas-uuid"},"last_updated":{"$ref":"#/components/schemas/api-shield_schemas-timestamp"},"title":{"$ref":"#/components/schemas/api-shield_title"},"token_sources":{"$ref":"#/components/schemas/api-shield_token_sources"},"token_type":{"$ref":"#/components/schemas/api-shield_token_type"}},"required":["id","title","description","token_sources","token_type","credentials","created_at","last_updated"],"type":"object"},"api-shield_action":{"description":"Action to take on requests that match operations included in `selector` and fail `expression`.","enum":["log","block"],"example":"log","type":"string","x-auditable":true},"api-shield_after":{"description":"Move rule to before rule with ID.","properties":{"after":{"description":"Move rule to after rule with this ID.","example":"0d9bf70c-92e1-4bb3-9411-34a3bcc59003","format":"uuid","maxLength":36,"type":"string","x-auditable":true}},"type":"object"},"api-shield_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"api-shield_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/api-shield_messages"},"messages":{"$ref":"#/components/schemas/api-shield_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"api-shield_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/api-shield_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/api-shield_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"api-shield_api-response-single":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"}],"type":"object"},"api-shield_api-response-single-obj":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"api-shield_api_discovery_origin":{"description":"* `ML` - Discovered operation was sourced using ML API Discovery * `SessionIdentifier` - Discovered operation was sourced using Session Identifier API Discovery * `LabelDiscovery` - Discovered operation was identified to have a specific label\n","enum":["ML","SessionIdentifier","LabelDiscovery"],"type":"string","x-auditable":true},"api-shield_api_discovery_patch_multiple_request":{"additionalProperties":{"$ref":"#/components/schemas/api-shield_api_discovery_patch_multiple_request_entry"},"example":{"3818d821-5901-4147-a474-f5f5aec1d54e":{"state":"ignored"},"b17c8043-99a0-4202-b7d9-8f7cdbee02cd":{"state":"review"}},"type":"object"},"api-shield_api_discovery_patch_multiple_request_entry":{"description":"Mappings of discovered operations (keys) to objects describing their state","properties":{"state":{"$ref":"#/components/schemas/api-shield_api_discovery_state_patch"}},"type":"object"},"api-shield_api_discovery_state":{"description":"State of operation in API Discovery\n  * `review` - Operation is not saved into API Shield Endpoint Management\n  * `saved` - Operation is saved into API Shield Endpoint Management\n  * `ignored` - Operation is marked as ignored\n","enum":["review","saved","ignored"],"type":"string","x-auditable":true},"api-shield_api_discovery_state_patch":{"description":"Mark state of operation in API Discovery\n  * `review` - Mark operation as for review\n  * `ignored` - Mark operation as ignored\n","enum":["review","ignored"],"type":"string","x-auditable":true},"api-shield_auth_id_characteristic":{"description":"Auth ID Characteristic","properties":{"name":{"description":"The name of the characteristic field, i.e., the header or cookie name.","example":"authorization","maxLength":128,"type":"string","x-auditable":true},"type":{"description":"The type of characteristic.","enum":["header","cookie"],"example":"header","type":"string","x-auditable":true}},"required":["type","name"]},"api-shield_auth_id_characteristic_jwt_claim":{"description":"Auth ID Characteristic extracted from JWT Token Claims","properties":{"name":{"description":"Claim location expressed as `$(token_config_id):$(json_path)`, where `token_config_id` \nis the ID of the token configuration used in validating the JWT, and `json_path` is a RFC 9535 \nJSONPath (https://goessner.net/articles/JsonPath/, https://www.rfc-editor.org/rfc/rfc9535.html).\nThe JSONPath expression may be in dot or bracket notation, may only specify literal keys\nor array indexes, and must return a singleton value, which will be interpreted as a string.\n","example":"e0de1a3a-8c2c-4f90-98d8-cbdf0a3f2cb5:$.foo.bar[0].baz","maxLength":128,"pattern":"^(?\u003ctoken_config_id\u003e[a-z0-9\\-]{32,36}):\\$(?\u003cjson_path\u003e.*?)$","type":"string","x-auditable":true},"type":{"description":"The type of characteristic.","enum":["jwt"],"example":"jwt","type":"string","x-auditable":true}},"required":["type","name"],"type":"object"},"api-shield_auth_id_characteristics":{"items":{"anyOf":[{"$ref":"#/components/schemas/api-shield_auth_id_characteristic"},{"$ref":"#/components/schemas/api-shield_auth_id_characteristic_jwt_claim"}]},"maxItems":10,"type":"array","uniqueItems":true},"api-shield_auth_id_tokens":{"description":"The total number of auth-ids seen across this calculation.","readOnly":true,"type":"integer","x-auditable":true},"api-shield_basic_operation":{"properties":{"endpoint":{"$ref":"#/components/schemas/api-shield_endpoint"},"host":{"$ref":"#/components/schemas/api-shield_host"},"method":{"$ref":"#/components/schemas/api-shield_method"}},"required":["method","host","endpoint"],"type":"object"},"api-shield_before":{"description":"Move rule to after rule with ID.","properties":{"before":{"description":"Move rule to before rule with this ID.","example":"0d9bf70c-92e1-4bb3-9411-34a3bcc59003","format":"uuid","maxLength":36,"type":"string","x-auditable":true}},"type":"object"},"api-shield_confidence_intervals_bounds":{"description":"Upper and lower bound for percentile estimate","properties":{"lower":{"description":"Lower bound for percentile estimate","example":20.5,"type":"number","x-auditable":true},"upper":{"description":"Upper bound for percentile estimate","example":30.4,"type":"number","x-auditable":true}},"readOnly":true,"type":"object"},"api-shield_configuration":{"properties":{"auth_id_characteristics":{"$ref":"#/components/schemas/api-shield_auth_id_characteristics"}},"required":["auth_id_characteristics"],"type":"object"},"api-shield_configuration-single-response":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_configuration"}},"required":["result"],"type":"object"}]},"api-shield_cookie":{"description":"HTTP request cookie","example":"http.request.cookies[\"Authorization\"][0]","pattern":"^http.request.cookies\\[.*?\\]\\[\\d+\\]$","type":"string","x-auditable":true},"api-shield_create-single-rule-request":{"allOf":[{"description":"A Token Validation rule that can enforce security policies using JWT Tokens.","required":["title","description","action","enabled","expression","selector"],"type":"object"},{"$ref":"#/components/schemas/api-shield_rule-properties"}]},"api-shield_credentials":{"properties":{"keys":{"items":{"$ref":"#/components/schemas/api-shield_credentials-JWT-Key"},"maxItems":4,"minItems":1,"type":"array"}},"required":["keys"],"type":"object"},"api-shield_credentials-JWT-Key":{"description":"JSON representation of a JWKS key.","example":{"alg":"ES256","crv":"P-256","kid":"38013f13-c266-4eec-a72a-92ec92779f21","kty":"EC","x":"KN53JRwN3wCjm2o39bvZUX2VdrsHzS8pxOAGjm8m7EQ","y":"lnkkzIxaveggz-HFhcMWW15nxvOj0Z_uQsXbpK0GFcY"},"oneOf":[{"$ref":"#/components/schemas/api-shield_credentials-JWT-Key-RSA"},{"$ref":"#/components/schemas/api-shield_credentials-JWT-Key-EC-ES256"},{"$ref":"#/components/schemas/api-shield_credentials-JWT-Key-EC-ES384"}],"type":"object"},"api-shield_credentials-JWT-Key-EC-ES256":{"allOf":[{"$ref":"#/components/schemas/api-shield_credentials-JWT-Key-common"},{"$ref":"#/components/schemas/api-shield_credentials-JWT-Key-EC-common"},{"properties":{"alg":{"description":"Algorithm","enum":["ES256"],"type":"string","x-auditable":true},"crv":{"description":"Curve","enum":["P-256"],"type":"string","x-auditable":true}},"required":["alg","crv"],"type":"object"}],"description":"JSON representation of an ES256 key","type":"object"},"api-shield_credentials-JWT-Key-EC-ES384":{"allOf":[{"$ref":"#/components/schemas/api-shield_credentials-JWT-Key-common"},{"$ref":"#/components/schemas/api-shield_credentials-JWT-Key-EC-common"},{"properties":{"alg":{"description":"Algorithm","enum":["ES384"],"type":"string","x-auditable":true},"crv":{"description":"Curve","enum":["P-384"],"type":"string","x-auditable":true}},"required":["alg","crv"],"type":"object"}],"description":"JSON representation of an ES384 key","type":"object"},"api-shield_credentials-JWT-Key-EC-common":{"properties":{"kty":{"description":"Key Type","enum":["EC"],"type":"string","x-auditable":true},"x":{"description":"X EC coordinate","type":"string","x-auditable":false},"y":{"description":"Y EC coordinate","type":"string","x-auditable":false}},"required":["kty","x","y"],"type":"object"},"api-shield_credentials-JWT-Key-RSA":{"allOf":[{"$ref":"#/components/schemas/api-shield_credentials-JWT-Key-common"},{"properties":{"alg":{"description":"Algorithm","enum":["RS256","RS384","RS512","PS256","PS384","PS512"],"type":"string","x-auditable":true},"e":{"description":"RSA exponent","type":"string","x-auditable":false},"kty":{"description":"Key Type","enum":["RSA"],"type":"string","x-auditable":true},"n":{"description":"RSA modulus","type":"string","x-auditable":false}},"required":["kty","alg","n","e"],"type":"object"}],"description":"JSON representation of an RSA key.","type":"object"},"api-shield_credentials-JWT-Key-common":{"properties":{"kid":{"description":"Key ID","type":"string","x-auditable":true}},"required":["kid"],"type":"object"},"api-shield_data_points":{"description":"The number of data points used for the threshold suggestion calculation.","readOnly":true,"type":"integer","x-auditable":true},"api-shield_description":{"example":"Long description for Token Validation Configuration","maxLength":500,"type":"string","x-auditable":true},"api-shield_discovery_operation":{"allOf":[{"properties":{"features":{"$ref":"#/components/schemas/api-shield_traffic_stats"},"id":{"$ref":"#/components/schemas/api-shield_schemas-uuid"},"last_updated":{"$ref":"#/components/schemas/api-shield_schemas-timestamp"},"origin":{"description":"API discovery engine(s) that discovered this operation","items":{"$ref":"#/components/schemas/api-shield_api_discovery_origin"},"type":"array"},"state":{"$ref":"#/components/schemas/api-shield_api_discovery_state"}},"required":["id","last_updated","state","origin"],"type":"object"},{"$ref":"#/components/schemas/api-shield_basic_operation"}]},"api-shield_edit-single-rule-request":{"allOf":[{"$ref":"#/components/schemas/api-shield_rule-properties"},{"properties":{"position":{"$ref":"#/components/schemas/api-shield_position"}},"type":"object"}]},"api-shield_enabled":{"description":"Toggle rule on or off.","example":true,"type":"boolean","x-auditable":true},"api-shield_endpoint":{"description":"The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.","example":"/api/v1/users/{var1}","format":"uri-template","maxLength":4096,"pattern":"^/.*$","type":"string","x-auditable":true},"api-shield_expression":{"description":"Rule expression. Requests that fail to match this expression will be subject to `action`.\n\nFor details on expressions, see the [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).\n","example":"is_jwt_valid(\"52973293-cb04-4a97-8f55-e7d2ad1107dd\") or is_jwt_valid(\"46eab8d1-6376-45e3-968f-2c649d77d423\")","type":"string","x-auditable":true},"api-shield_global_setting_change_base":{"properties":{"validation_default_mitigation_action":{"description":"The default mitigation action used\nMitigation actions are as follows:\n\n  - `\"log\"` - log request when request does not conform to schema\n  - `\"block\"` - deny access to the site when request does not conform to schema\n  - `\"none\"` - skip running schema validation\n","enum":["none","log","block"],"example":"block","type":"string","x-auditable":true},"validation_override_mitigation_action":{"description":"When set, this overrides both zone level and operation level mitigation actions.\n\n  - `\"none\"` - skip running schema validation entirely for the request\n  - `null` - clears any existing override\n","enum":["none",null],"nullable":true,"type":"string","x-auditable":true}},"type":"object"},"api-shield_global_settings":{"properties":{"validation_default_mitigation_action":{"description":"The default mitigation action used\n\nMitigation actions are as follows:\n\n  - `log` - log request when request does not conform to schema\n  - `block` - deny access to the site when request does not conform to schema\n  - `none` - skip running schema validation\n","enum":["none","log","block"],"example":"block","type":"string","x-auditable":true},"validation_override_mitigation_action":{"description":"When not null, this overrides global both zone level and operation level mitigation actions. This can serve as a quick way to disable schema validation for the whole zone.\n\n  - `\"none\"` will skip running schema validation entirely for the request\n","enum":["none"],"type":"string","x-auditable":true}},"required":["validation_default_mitigation_action"],"type":"object"},"api-shield_header":{"description":"HTTP request header (must be lowercase)","example":"http.request.headers[\"x-auth\"][0]","pattern":"^http.request.headers\\[.*?\\]\\[\\d+\\]$","type":"string","x-auditable":true},"api-shield_host":{"description":"RFC3986-compliant host.","example":"www.example.com","format":"hostname","maxLength":255,"type":"string","x-auditable":true},"api-shield_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"api-shield_index":{"properties":{"index":{"description":"Move rule to this position","example":2,"minimum":1,"type":"integer","x-auditable":true}},"required":["index"],"type":"object"},"api-shield_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"api-shield_method":{"description":"The HTTP method used to access the endpoint.","enum":["GET","POST","HEAD","OPTIONS","PUT","DELETE","CONNECT","PATCH","TRACE"],"example":"GET","type":"string","x-auditable":true},"api-shield_multiple-operation-response":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/api-shield_operation"},"type":"array"}},"required":["result"],"type":"object"}]},"api-shield_multiple-operation-response-paginated":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"items":{"allOf":[{"$ref":"#/components/schemas/api-shield_operation"}]},"type":"array"}},"required":["result"],"type":"object"}]},"api-shield_object-with-operation-id":{"properties":{"operation_id":{"allOf":[{"description":"The ID of the operation","type":"string","x-auditable":true},{"$ref":"#/components/schemas/api-shield_schemas-uuid"}]}},"required":["operation_id"],"type":"object"},"api-shield_old_kind":{"description":"Kind of schema","enum":["openapi_v3"],"example":"openapi_v3","type":"string","x-auditable":true},"api-shield_old_operation_mitigation_action":{"description":"When set, this applies a mitigation action to this operation\n\n  - `log` log request when request does not conform to schema for this operation\n  - `block` deny access to the site when request does not conform to schema for this operation\n  - `none` will skip mitigation for this operation\n  - `null` indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied\n","enum":["log","block","none",null],"example":"block","nullable":true,"type":"string","x-auditable":true},"api-shield_old_operation_schema_validation_settings":{"properties":{"mitigation_action":{"$ref":"#/components/schemas/api-shield_old_operation_mitigation_action"},"operation_id":{"$ref":"#/components/schemas/api-shield_schemas-uuid"}},"type":"object"},"api-shield_old_operation_schema_validation_settings_modify_request":{"properties":{"mitigation_action":{"$ref":"#/components/schemas/api-shield_old_operation_mitigation_action"}},"type":"object"},"api-shield_old_operation_schema_validation_settings_multiple_request":{"additionalProperties":{"$ref":"#/components/schemas/api-shield_old_operation_schema_validation_settings_multiple_request_entry"},"example":{"3818d821-5901-4147-a474-f5f5aec1d54e":{"mitigation_action":"log"},"b17c8043-99a0-4202-b7d9-8f7cdbee02cd":{"mitigation_action":"block"}},"type":"object"},"api-shield_old_operation_schema_validation_settings_multiple_request_entry":{"description":"Operation ID to mitigation action mappings","properties":{"mitigation_action":{"$ref":"#/components/schemas/api-shield_old_operation_mitigation_action"}},"type":"object"},"api-shield_old_public_schema":{"properties":{"created_at":{"$ref":"#/components/schemas/api-shield_schemas-timestamp"},"kind":{"$ref":"#/components/schemas/api-shield_old_kind"},"name":{"description":"Name of the schema","example":"petstore schema","type":"string","x-auditable":true},"schema_id":{"$ref":"#/components/schemas/api-shield_schemas-uuid"},"source":{"description":"Source of the schema","example":"\u003cschema file bytes\u003e","type":"string","x-auditable":true},"validation_enabled":{"$ref":"#/components/schemas/api-shield_old_validation_enabled"}},"required":["schema_id","name","kind","created_at"],"type":"object"},"api-shield_old_response_user_schemas_hosts":{"properties":{"created_at":{"$ref":"#/components/schemas/api-shield_schemas-timestamp"},"hosts":{"description":"Hosts serving the schema, e.g zone.host.com","items":{"type":"string"},"type":"array"},"name":{"description":"Name of the schema","example":"petstore schema","type":"string","x-auditable":true},"schema_id":{"$ref":"#/components/schemas/api-shield_schemas-uuid"}},"required":["schema_id","name","hosts","created_at"],"type":"object"},"api-shield_old_schema_upload_details_errors_critical":{"properties":{"critical":{"description":"Diagnostic critical error events that occurred during processing.","items":{"$ref":"#/components/schemas/api-shield_old_schema_upload_log_event"},"type":"array"},"errors":{"description":"Diagnostic error events that occurred during processing.","items":{"$ref":"#/components/schemas/api-shield_old_schema_upload_log_event"},"type":"array"}},"type":"object"},"api-shield_old_schema_upload_details_warnings_only":{"properties":{"warnings":{"description":"Diagnostic warning events that occurred during processing. These events are non-critical errors found within the schema.","items":{"$ref":"#/components/schemas/api-shield_old_schema_upload_log_event"},"type":"array"}},"type":"object"},"api-shield_old_schema_upload_failure":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common-failure"},{"properties":{"upload_details":{"$ref":"#/components/schemas/api-shield_old_schema_upload_details_errors_critical"}},"type":"object"}]},"api-shield_old_schema_upload_log_event":{"properties":{"code":{"description":"Code that identifies the event that occurred.","example":28,"type":"integer","x-auditable":true},"locations":{"description":"JSONPath location(s) in the schema where these events were encountered.  See [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) for JSONPath specification.","items":{"description":"JSONPath location in the schema where these events were encountered.  See [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) for JSONPath specification.","example":".paths[\"/user/{username}\"].put","type":"string","x-auditable":true},"type":"array"},"message":{"description":"Diagnostic message that describes the event.","example":"unsupported media type: application/octet-stream","type":"string","x-auditable":true}},"required":["code"],"type":"object"},"api-shield_old_schema_upload_response":{"properties":{"schema":{"$ref":"#/components/schemas/api-shield_old_public_schema"},"upload_details":{"$ref":"#/components/schemas/api-shield_old_schema_upload_details_warnings_only"}},"required":["schema"],"type":"object"},"api-shield_old_validation_default_mitigation_action":{"description":"The default mitigation action used when there is no mitigation action defined on the operation\n\nMitigation actions are as follows:\n\n  * `log` - log request when request does not conform to schema\n  * `block` - deny access to the site when request does not conform to schema\n\nA special value of of `none` will skip running schema validation entirely for the request when there is no mitigation action defined on the operation\n","enum":["none","log","block"],"example":"block","type":"string","x-auditable":true},"api-shield_old_validation_default_mitigation_action_patch":{"description":"The default mitigation action used when there is no mitigation action defined on the operation\nMitigation actions are as follows:\n\n  * `log` - log request when request does not conform to schema\n  * `block` - deny access to the site when request does not conform to schema\n\nA special value of of `none` will skip running schema validation entirely for the request when there is no mitigation action defined on the operation\n\n`null` will have no effect.\n","enum":["none","log","block",null],"example":"block","nullable":true,"type":"string","x-auditable":true},"api-shield_old_validation_enabled":{"description":"Flag whether schema is enabled for validation.","type":"boolean","x-auditable":true},"api-shield_old_validation_override_mitigation_action":{"description":"When set, this overrides both zone level and operation level mitigation actions.\n\n  - `none` will skip running schema validation entirely for the request\n  - `null` indicates that no override is in place\n","enum":["none",null],"example":"disable_override","nullable":true,"type":"string","x-auditable":true},"api-shield_old_validation_override_mitigation_action_patch":{"description":"When set, this overrides both zone level and operation level mitigation actions.\n\n  - `none` will skip running schema validation entirely for the request\n\nTo clear any override, use the special value `disable_override`\n\n`null` will have no effect.\n","enum":["none","disable_override",null],"example":"none","nullable":true,"type":"string","x-auditable":true},"api-shield_old_validation_override_mitigation_action_write":{"description":"When set, this overrides both zone level and operation level mitigation actions.\n\n  - `none` will skip running schema validation entirely for the request\n  - `null` indicates that no override is in place\n\nTo clear any override, use the special value `disable_override` or `null`\n","enum":["none","disable_override",null],"example":"none","nullable":true,"type":"string","x-auditable":true},"api-shield_old_zone_schema_validation_settings":{"properties":{"validation_default_mitigation_action":{"$ref":"#/components/schemas/api-shield_old_validation_default_mitigation_action"},"validation_override_mitigation_action":{"$ref":"#/components/schemas/api-shield_old_validation_override_mitigation_action"}},"type":"object"},"api-shield_old_zone_schema_validation_settings_patch":{"properties":{"validation_default_mitigation_action":{"$ref":"#/components/schemas/api-shield_old_validation_default_mitigation_action_patch"},"validation_override_mitigation_action":{"$ref":"#/components/schemas/api-shield_old_validation_override_mitigation_action_patch"}},"type":"object"},"api-shield_old_zone_schema_validation_settings_put":{"properties":{"validation_default_mitigation_action":{"$ref":"#/components/schemas/api-shield_old_validation_default_mitigation_action"},"validation_override_mitigation_action":{"$ref":"#/components/schemas/api-shield_old_validation_override_mitigation_action_write"}},"required":["validation_default_mitigation_action"],"type":"object"},"api-shield_openapi":{"description":"A OpenAPI 3.0.0 compliant schema.","example":{"info":{"title":"OpenAPI JSON schema for www.example.com","version":"1.0"},"openapi":"3.0.0","paths":{"... Further paths ...":{},"/api/v1/users/{var1}":{"get":{"parameters":[{"in":"path","name":"var1","required":true,"schema":{"type":"string"}}]}}},"servers":[{"url":"www.example.com"}]},"type":"object"},"api-shield_openapi-with-thresholds":{"description":"A OpenAPI 3.0.0 compliant schema.","example":{"info":{"title":"OpenAPI JSON schema for www.example.com","version":"1.0"},"openapi":"3.0.0","paths":{"... Further paths ...":{},"/api/v1/users/{var1}":{"get":{"parameters":[{"in":"path","name":"var1","required":true,"schema":{"type":"string"}}]}}},"servers":[{"url":"www.example.com"}]},"type":"object"},"api-shield_operation":{"allOf":[{"$ref":"#/components/schemas/api-shield_standard_operation"},{"default":{},"nullable":true,"properties":{"features":{"$ref":"#/components/schemas/api-shield_operation_features"}},"type":"object"}]},"api-shield_operation_feature_api_routing":{"example":{"api_routing":{"last_updated":"2014-01-01T05:20:00.12345Z","route":"https://api.example.com/api/service"}},"properties":{"api_routing":{"description":"API Routing settings on endpoint.","properties":{"last_updated":{"$ref":"#/components/schemas/api-shield_timestamp"},"route":{"description":"Target route.","example":"https://api.example.com/api/service","type":"string","x-auditable":true}},"type":"object"}},"readOnly":true,"type":"object"},"api-shield_operation_feature_confidence_intervals":{"example":{"confidence_intervals":{"last_updated":"2014-01-01T05:20:00.12345Z","suggested_threshold":{"confidence_intervals":{"p90":{"lower":23.1,"upper":23.9},"p95":{"lower":22,"upper":24.1},"p99":{"lower":20.2,"upper":30}},"mean":23.5}}},"properties":{"confidence_intervals":{"properties":{"last_updated":{"$ref":"#/components/schemas/api-shield_timestamp"},"suggested_threshold":{"properties":{"confidence_intervals":{"properties":{"p90":{"$ref":"#/components/schemas/api-shield_confidence_intervals_bounds"},"p95":{"$ref":"#/components/schemas/api-shield_confidence_intervals_bounds"},"p99":{"$ref":"#/components/schemas/api-shield_confidence_intervals_bounds"}},"type":"object"},"mean":{"description":"Suggested threshold.","example":25.5,"type":"number","x-auditable":true}},"type":"object"}},"type":"object"}},"readOnly":true,"type":"object"},"api-shield_operation_feature_parameter_schemas":{"properties":{"parameter_schemas":{"properties":{"last_updated":{"$ref":"#/components/schemas/api-shield_timestamp"},"parameter_schemas":{"$ref":"#/components/schemas/api-shield_parameter_schemas_definition"}},"type":"object"}},"readOnly":true,"required":["parameter_schemas","last_updated"],"type":"object"},"api-shield_operation_feature_schema_info":{"properties":{"schema_info":{"properties":{"active_schema":{"description":"Schema active on endpoint.","properties":{"created_at":{"$ref":"#/components/schemas/api-shield_timestamp"},"id":{"$ref":"#/components/schemas/api-shield_schemas-uuid"},"is_learned":{"description":"True if schema is Cloudflare-provided.","example":true,"type":"boolean","x-auditable":true},"name":{"description":"Schema file name.","example":"api-endpoints-8694824bf5c04d019edcbf399c03c103-api-discovery.example.com-thresholds.json","type":"string","x-auditable":true}},"type":"object"},"learned_available":{"description":"True if a Cloudflare-provided learned schema is available for this endpoint.","example":true,"type":"boolean","x-auditable":true},"mitigation_action":{"description":"Action taken on requests failing validation.","enum":["none","log","block"],"example":"block","nullable":true,"type":"string","x-auditable":true}},"type":"object"}},"readOnly":true,"type":"object"},"api-shield_operation_feature_thresholds":{"properties":{"thresholds":{"properties":{"auth_id_tokens":{"$ref":"#/components/schemas/api-shield_auth_id_tokens"},"data_points":{"$ref":"#/components/schemas/api-shield_data_points"},"last_updated":{"$ref":"#/components/schemas/api-shield_timestamp"},"p50":{"$ref":"#/components/schemas/api-shield_p50"},"p90":{"$ref":"#/components/schemas/api-shield_p90"},"p99":{"$ref":"#/components/schemas/api-shield_p99"},"period_seconds":{"$ref":"#/components/schemas/api-shield_period_seconds"},"requests":{"$ref":"#/components/schemas/api-shield_requests"},"suggested_threshold":{"$ref":"#/components/schemas/api-shield_suggested_threshold"}},"type":"object"}},"readOnly":true,"required":["period_seconds","suggested_threshold","p50","p90","p99","requests","auth_id_tokens","data_points","last_updated"],"type":"object"},"api-shield_operation_features":{"anyOf":[{"$ref":"#/components/schemas/api-shield_operation_feature_thresholds"},{"$ref":"#/components/schemas/api-shield_operation_feature_parameter_schemas"},{"$ref":"#/components/schemas/api-shield_operation_feature_api_routing"},{"$ref":"#/components/schemas/api-shield_operation_feature_confidence_intervals"},{"$ref":"#/components/schemas/api-shield_operation_feature_schema_info"}],"readOnly":true,"type":"object"},"api-shield_p50":{"description":"The p50 quantile of requests (in period_seconds).","readOnly":true,"type":"integer","x-auditable":true},"api-shield_p90":{"description":"The p90 quantile of requests (in period_seconds).","readOnly":true,"type":"integer","x-auditable":true},"api-shield_p99":{"description":"The p99 quantile of requests (in period_seconds).","readOnly":true,"type":"integer","x-auditable":true},"api-shield_parameter_schemas_definition":{"description":"An operation schema object containing a response.","example":{"parameters":[{"description":"Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema.","in":"path","name":"var1","required":true,"schema":{"maximum":10,"minimum":1,"type":"integer"}}],"responses":null},"properties":{"parameters":{"description":"An array containing the learned parameter schemas.","example":[{"description":"Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema.","in":"path","name":"var1","required":true,"schema":{"maximum":10,"minimum":1,"type":"integer"}}],"items":{"type":"object"},"readOnly":true,"type":"array"},"responses":{"description":"An empty response object. This field is required to yield a valid operation schema.","nullable":true,"readOnly":true,"type":"object"}},"readOnly":true,"type":"object"},"api-shield_patch_discoveries_response":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_api_discovery_patch_multiple_request"}},"required":["result"],"type":"object"}]},"api-shield_patch_discovery_response":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"properties":{"state":{"$ref":"#/components/schemas/api-shield_api_discovery_state"}},"type":"object"}},"required":["result"],"type":"object"}]},"api-shield_per_operation_bulk_settings":{"additionalProperties":{"$ref":"#/components/schemas/api-shield_per_operation_setting"},"description":"Operation ID to per operation setting mapping","example":{"3818d821-5901-4147-a474-f5f5aec1d54e":{"mitigation_action":"log"},"b17c8043-99a0-4202-b7d9-8f7cdbee02cd":{"mitigation_action":"block"}},"type":"object"},"api-shield_per_operation_setting":{"properties":{"mitigation_action":{"description":"When set, this applies a mitigation action to this operation which supersedes a global schema validation setting just for this operation\n\n  - `\"log\"` - log request when request does not conform to schema for this operation\n  - `\"block\"` - deny access to the site when request does not conform to schema for this operation\n  - `\"none\"` - will skip mitigation for this operation\n","enum":["log","block","none"],"example":"block","type":"string","x-auditable":true},"operation_id":{"$ref":"#/components/schemas/api-shield_schemas-uuid"}},"required":["operation_id","mitigation_action"],"type":"object"},"api-shield_per_operation_setting_change_base":{"properties":{"mitigation_action":{"description":"When set, this applies a mitigation action to this operation\n\n  - `\"log\"` - log request when request does not conform to schema for this operation\n  - `\"block\"` - deny access to the site when request does not conform to schema for this operation\n  - `\"none\"` - will skip mitigation for this operation\n  - `null` - clears any mitigation action\n","enum":["log","block","none",null],"example":"block","nullable":true,"type":"string","x-auditable":true}},"type":"object"},"api-shield_period_seconds":{"description":"The period over which this threshold is suggested.","readOnly":true,"type":"integer","x-auditable":true},"api-shield_position":{"description":"Update rule order among zone rules.","oneOf":[{"$ref":"#/components/schemas/api-shield_index"},{"$ref":"#/components/schemas/api-shield_before"},{"$ref":"#/components/schemas/api-shield_after"}],"type":"object","writeOnly":true},"api-shield_public_schema":{"description":"A schema used in schema validation","properties":{"created_at":{"$ref":"#/components/schemas/api-shield_schemas-timestamp"},"kind":{"description":"The kind of the schema","enum":["openapi_v3"],"example":"openapi_v3","readOnly":true,"type":"string","x-auditable":true},"name":{"description":"A human-readable name for the schema","example":"petstore schema","readOnly":true,"type":"string","x-auditable":true},"schema_id":{"allOf":[{"$ref":"#/components/schemas/api-shield_schemas-uuid"},{"description":"A unique identifier of this schema","format":"uuid","readOnly":true,"type":"string"}],"type":"string","x-auditable":true},"source":{"description":"The raw schema, e.g., the OpenAPI schema, either as JSON or YAML","example":"\u003cschema file contents\u003e","readOnly":true,"type":"string","x-auditable":true},"validation_enabled":{"description":"An indicator if this schema is enabled","type":"boolean","x-auditable":true}},"required":["schema_id","name","kind","source","created_at"],"type":"object"},"api-shield_public_schema_success_result":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_public_schema"}},"required":["result"],"type":"object"}],"type":"object"},"api-shield_request_expression_templates_fallthrough":{"additionalProperties":false,"properties":{"hosts":{"description":"List of hosts to be targeted in the expression","example":["{zone}.domain1.tld","domain2.tld"],"items":{"type":"string","x-auditable":true},"type":"array"}},"required":["hosts"],"type":"object"},"api-shield_requests":{"description":"The estimated number of requests covered by these calculations.","readOnly":true,"type":"integer","x-auditable":true},"api-shield_response_expression_templates_fallthrough":{"properties":{"expression":{"description":"WAF Expression for fallthrough","example":"(cf.api_gateway.fallthrough_detected)","type":"string","x-auditable":true},"title":{"description":"Title for the expression","example":"Fallthrough Expression for [zone.domain.tld]","type":"string","x-auditable":true}},"required":["title","expression"],"type":"object"},"api-shield_rule-properties":{"properties":{"action":{"$ref":"#/components/schemas/api-shield_action"},"description":{"$ref":"#/components/schemas/api-shield_schemas-description"},"enabled":{"$ref":"#/components/schemas/api-shield_enabled"},"expression":{"$ref":"#/components/schemas/api-shield_expression"},"selector":{"$ref":"#/components/schemas/api-shield_selector"},"title":{"$ref":"#/components/schemas/api-shield_schemas-title"}},"type":"object"},"api-shield_schema-response-with-thresholds":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"properties":{"schemas":{"items":{"$ref":"#/components/schemas/api-shield_openapi-with-thresholds"},"type":"array"},"timestamp":{"type":"string","x-auditable":true}},"type":"object"}},"required":["result"],"type":"object"}]},"api-shield_schema_hosts":{"properties":{"created_at":{"$ref":"#/components/schemas/api-shield_schemas-timestamp"},"hosts":{"description":"Hosts serving the schema, e.g zone.host.com","items":{"type":"string"},"readOnly":true,"type":"array","x-auditable":true},"name":{"description":"Name of the schema","example":"petstore schema","readOnly":true,"type":"string","x-auditable":true},"schema_id":{"allOf":[{"$ref":"#/components/schemas/api-shield_schemas-uuid"},{"description":"A unique identifier of this schema","format":"uuid","readOnly":true,"type":"string"}],"type":"string","x-auditable":true}},"required":["schema_id","name","hosts","created_at"],"type":"object"},"api-shield_schema_issue_notification":{"properties":{"code":{"description":"A unique error code that describes the kind of issue with the schema","minimum":1000,"type":"integer"},"message":{"description":"A short text explaining the issue with the schema","type":"string"},"source":{"nullable":true,"properties":{"locations":{"description":"A list of JSON path expression(s) that describe the location(s) of the issue within the provided resource. See [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) for JSONPath specification.","items":{"example":".paths[\"/user/{username}\"].put","type":"string"},"type":"array"}},"type":"object"}},"required":["code","message"],"type":"object"},"api-shield_schema_response_discovery":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"properties":{"schemas":{"items":{"$ref":"#/components/schemas/api-shield_openapi"},"type":"array"},"timestamp":{"$ref":"#/components/schemas/api-shield_schemas-timestamp"}},"required":["timestamp","schemas"],"type":"object"}},"required":["result"],"type":"object"}]},"api-shield_schemas-description":{"description":"A human-readable description that gives more details than `title`.","example":"Long description for Token Validation Rule","maxLength":500,"type":"string","x-auditable":true},"api-shield_schemas-identifier":{"allOf":[{"$ref":"#/components/schemas/api-shield_identifier"},{"readOnly":true,"type":"string","x-auditable":true}]},"api-shield_schemas-timestamp":{"allOf":[{"$ref":"#/components/schemas/api-shield_timestamp"},{"readOnly":true,"type":"string","x-auditable":true}]},"api-shield_schemas-title":{"description":"A human-readable name for the rule.","example":"Example Token Validation Rule","maxLength":50,"type":"string","x-auditable":true},"api-shield_schemas-uuid":{"allOf":[{"minLength":36,"type":"string","x-auditable":true},{"$ref":"#/components/schemas/api-shield_uuid"}]},"api-shield_selector":{"description":"Select operations covered by this rule.\n\nFor details on selectors, see the [Cloudflare Docs](https://developers.cloudflare.com/api-shield/security/jwt-validation/).\n","properties":{"exclude":{"description":"Ignore operations that were otherwise included by `include`.","items":{"$ref":"#/components/schemas/api-shield_selector-exclude"},"nullable":true,"type":"array"},"include":{"description":"Select all matching operations.","items":{"$ref":"#/components/schemas/api-shield_selector-include"},"nullable":true,"type":"array"}},"type":"object"},"api-shield_selector-exclude":{"properties":{"operation_ids":{"description":"Excluded operation IDs.","example":["f9c5615e-fe15-48ce-bec6-cfc1946f1bec","56828eae-035a-4396-ba07-51c66d680a04"],"items":{"$ref":"#/components/schemas/api-shield_schemas-uuid"},"type":"array"}},"type":"object"},"api-shield_selector-include":{"properties":{"host":{"description":"Included hostnames.","example":["v1.example.com","v2.example.com"],"items":{"$ref":"#/components/schemas/api-shield_host"},"type":"array"}},"type":"object"},"api-shield_selector-operation-state":{"description":"Details how `selector` interacted with an operation:\n  - `included` operations are included by `selector` and will be covered by the Token Validation Rule\n  - `excluded` operations are excluded by `selector` and will not be covered by the Token Validation Rule\n  - `ignored` operations are not included by `selector` and will not be covered by the Token Validation Rule\n","enum":["included","excluded","ignored"],"example":"included","type":"string","x-auditable":true},"api-shield_single-operation-response":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/api-shield_operation"}]}},"required":["result"],"type":"object"}]},"api-shield_standard_operation":{"allOf":[{"$ref":"#/components/schemas/api-shield_basic_operation"},{"properties":{"last_updated":{"$ref":"#/components/schemas/api-shield_schemas-timestamp"},"operation_id":{"$ref":"#/components/schemas/api-shield_schemas-uuid"}},"required":["operation_id","last_updated"],"type":"object"}]},"api-shield_suggested_threshold":{"description":"The suggested threshold in requests done by the same auth_id or period_seconds.","readOnly":true,"type":"integer","x-auditable":true},"api-shield_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true},"api-shield_title":{"example":"Example Token Validation Configuration","maxLength":50,"type":"string","x-auditable":true},"api-shield_token_sources":{"example":["http.request.headers[\"x-auth\"][0]","http.request.cookies[\"Authorization\"][0]"],"items":{"anyOf":[{"$ref":"#/components/schemas/api-shield_header"},{"$ref":"#/components/schemas/api-shield_cookie"}]},"maxItems":4,"minItems":1,"type":"array"},"api-shield_token_type":{"enum":["JWT"],"example":"JWT","type":"string","x-auditable":true},"api-shield_traffic_stats":{"properties":{"traffic_stats":{"properties":{"last_updated":{"$ref":"#/components/schemas/api-shield_schemas-timestamp"},"period_seconds":{"description":"The period in seconds these statistics were computed over","example":3600,"readOnly":true,"type":"integer","x-auditable":true},"requests":{"description":"The average number of requests seen during this period","example":1987.06,"format":"float","readOnly":true,"type":"number","x-auditable":true}},"required":["period_seconds","requests","last_updated"],"type":"object"}},"readOnly":true,"type":"object"},"api-shield_uuid":{"description":"UUID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string","x-auditable":true},"argo-analytics_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/argo-analytics_messages"},"messages":{"$ref":"#/components/schemas/argo-analytics_messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"argo-analytics_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/argo-analytics_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/argo-analytics_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"argo-analytics_api-response-single":{"allOf":[{"$ref":"#/components/schemas/argo-analytics_api-response-common"},{"properties":{"result":{"anyOf":[{"nullable":true,"type":"object"},{"nullable":true,"type":"string"}]}}}],"type":"object"},"argo-analytics_identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"argo-analytics_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"argo-analytics_response_single":{"allOf":[{"$ref":"#/components/schemas/argo-analytics_api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"argo-config_api_response_common_failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/argo-config_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/argo-config_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Describes a failed API response.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"argo-config_api_response_single":{"properties":{"errors":{"$ref":"#/components/schemas/argo-config_messages"},"messages":{"$ref":"#/components/schemas/argo-config_messages"},"result":{"$ref":"#/components/schemas/argo-config_result_object"},"success":{"description":"Describes a successful API response.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"argo-config_editable":{"description":"Specifies if the setting is editable.","type":"boolean","x-auditable":true},"argo-config_identifier":{"description":"Specifies the zone associated with the API call.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"argo-config_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"argo-config_modified_on":{"description":"Specifies the time when the setting was last modified.","format":"date-time","type":"string","x-auditable":true},"argo-config_patch":{"description":"Configures the enablement of Argo Smart Routing.","properties":{"value":{"$ref":"#/components/schemas/argo-config_setting_value"}},"required":["value"],"type":"object"},"argo-config_result_object":{"properties":{"editable":{"$ref":"#/components/schemas/argo-config_editable"},"id":{"$ref":"#/components/schemas/argo-config_setting_id"},"modified_on":{"$ref":"#/components/schemas/argo-config_modified_on"},"value":{"$ref":"#/components/schemas/argo-config_setting_value"}},"required":["id","value","editable"],"type":"object"},"argo-config_setting_id":{"description":"Specifies the identifier of the Argo Smart Routing setting.","type":"string","x-auditable":true},"argo-config_setting_value":{"description":"Specifies the enablement value of Argo Smart Routing.","enum":["on","off"],"example":"on","type":"string","x-auditable":true},"bill-subs-api_account_subscription_response_collection":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/bill-subs-api_subscription"},"type":"array"}},"type":"object"}]},"bill-subs-api_account_subscription_response_single":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/bill-subs-api_subscription"}},"type":"object"}]},"bill-subs-api_action":{"description":"The billing item action.","example":"subscription","maxLength":30,"readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_amount":{"description":"The amount associated with this billing item.","example":20.99,"readOnly":true,"type":"number","x-auditable":true},"bill-subs-api_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-common"},{"properties":{"result":{"items":{},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/bill-subs-api_result_info"}}}],"type":"object"},"bill-subs-api_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/bill-subs-api_messages"},"messages":{"$ref":"#/components/schemas/bill-subs-api_messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"bill-subs-api_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"bill-subs-api_api-response-single":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-common"},{"properties":{"result":{"anyOf":[{"nullable":true,"type":"object"},{"nullable":true,"type":"string"}]}}}],"type":"object"},"bill-subs-api_available-rate-plan":{"properties":{"can_subscribe":{"$ref":"#/components/schemas/bill-subs-api_can_subscribe"},"currency":{"$ref":"#/components/schemas/bill-subs-api_currency"},"externally_managed":{"$ref":"#/components/schemas/bill-subs-api_externally_managed"},"frequency":{"$ref":"#/components/schemas/bill-subs-api_schemas-frequency"},"id":{"$ref":"#/components/schemas/bill-subs-api_identifier"},"is_subscribed":{"$ref":"#/components/schemas/bill-subs-api_is_subscribed"},"legacy_discount":{"$ref":"#/components/schemas/bill-subs-api_legacy_discount"},"legacy_id":{"$ref":"#/components/schemas/bill-subs-api_legacy_id"},"name":{"$ref":"#/components/schemas/bill-subs-api_schemas-name"},"price":{"$ref":"#/components/schemas/bill-subs-api_schemas-price"}},"type":"object"},"bill-subs-api_billing-history":{"properties":{"action":{"$ref":"#/components/schemas/bill-subs-api_action"},"amount":{"$ref":"#/components/schemas/bill-subs-api_amount"},"currency":{"$ref":"#/components/schemas/bill-subs-api_currency"},"description":{"$ref":"#/components/schemas/bill-subs-api_description"},"id":{"$ref":"#/components/schemas/bill-subs-api_components-schemas-identifier"},"occurred_at":{"$ref":"#/components/schemas/bill-subs-api_occurred_at"},"type":{"$ref":"#/components/schemas/bill-subs-api_type"},"zone":{"$ref":"#/components/schemas/bill-subs-api_schemas-zone"}},"required":["id","type","action","description","occurred_at","amount","currency","zone"],"type":"object"},"bill-subs-api_billing_history_collection":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/bill-subs-api_billing-history"},"type":"array"}}}]},"bill-subs-api_billing_response_single":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-single"},{"properties":{"result":{"properties":{"account_type":{"example":"type","type":"string"},"address":{"example":"123 Main Street","type":"string"},"address2":{"example":"Apt 1","type":"string"},"balance":{"example":0,"type":"string"},"card_expiry_month":{"example":12,"type":"integer"},"card_expiry_year":{"example":2099,"type":"integer"},"card_number":{"example":4242424242424242,"type":"string"},"city":{"example":"Anytown","type":"string"},"company":{"example":"Company","type":"string"},"country":{"example":"Anycountry","type":"string"},"created_on":{"example":"2014-03-01T12:21:59.3456Z","format":"date-time","type":"string"},"device_data":{"example":"sample_data","type":"string"},"edited_on":{"example":"2014-03-01T12:21:59.3456Z","format":"date-time","type":"string"},"enterprise_billing_email":{"example":"johndoe@gmail.com","type":"string","x-auditable":true},"enterprise_primary_email":{"example":"johndoe@gmail.com","type":"string","x-auditable":true},"first_name":{"example":"John","type":"string"},"id":{"$ref":"#/components/schemas/bill-subs-api_components-schemas-identifier"},"is_partner":{"example":false,"type":"boolean"},"last_name":{"example":"Doe","type":"string"},"next_bill_date":{"example":"2014-03-01T12:21:59.3456Z","format":"date-time","type":"string"},"payment_address":{"example":"123 Main Street","type":"string"},"payment_address2":{"example":"Apt 1","type":"string"},"payment_city":{"example":"Anytown","type":"string"},"payment_country":{"example":"Anycountry","type":"string"},"payment_email":{"example":"johndoe@gmail.com","type":"string"},"payment_first_name":{"example":"John","type":"string"},"payment_gateway":{"example":"gateway","type":"string"},"payment_last_name":{"example":"Doe","type":"string"},"payment_nonce":{"example":"abc123","type":"string"},"payment_state":{"example":"state","type":"string"},"payment_zipcode":{"example":12345,"type":"string"},"primary_email":{"example":"johndoe@gmail.com","type":"string","x-auditable":true},"state":{"example":"AnyState","type":"string"},"tax_id_type":{"example":"type","type":"string"},"telephone":{"example":1234567899,"type":"string"},"use_legacy":{"example":false,"type":"boolean"},"validation_code":{"example":1111,"type":"string"},"vat":{"example":"GB123456789","type":"string"},"zipcode":{"example":12345,"type":"string"}},"type":"object"}},"type":"object"}]},"bill-subs-api_can_subscribe":{"default":false,"description":"Indicates whether you can subscribe to this plan.","example":true,"type":"boolean","x-auditable":true},"bill-subs-api_component-value":{"properties":{"default":{"$ref":"#/components/schemas/bill-subs-api_default"},"name":{"$ref":"#/components/schemas/bill-subs-api_components-schemas-name"},"unit_price":{"$ref":"#/components/schemas/bill-subs-api_unit_price"}},"type":"object"},"bill-subs-api_component_value":{"description":"A component value for a subscription.","properties":{"default":{"description":"The default amount assigned.","example":5,"type":"number","x-auditable":true},"name":{"description":"The name of the component value.","example":"page_rules","type":"string","x-auditable":true},"price":{"description":"The unit price for the component value.","example":5,"type":"number","x-auditable":true},"value":{"description":"The amount of the component value assigned.","example":20,"type":"number","x-auditable":true}},"type":"object"},"bill-subs-api_component_values":{"description":"The list of add-ons subscribed to.","items":{"$ref":"#/components/schemas/bill-subs-api_component_value"},"type":"array"},"bill-subs-api_components-schemas-identifier":{"description":"Billing item identifier tag.","example":"b69a9f3492637782896352daae219e7d","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_components-schemas-name":{"description":"The unique component.","enum":["zones","page_rules","dedicated_certificates","dedicated_certificates_custom"],"example":"page_rules","x-auditable":true},"bill-subs-api_currency":{"description":"The monetary unit in which pricing information is displayed.","example":"USD","readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_current_period_end":{"description":"The end of the current period and also when the next billing is due.","example":"2014-03-31T12:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_current_period_start":{"description":"When the current billing period started. May match initial_period_start if this is the first period.","example":"2014-05-11T12:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_default":{"description":"The default amount allocated.","example":5,"type":"number","x-auditable":true},"bill-subs-api_description":{"description":"The billing item description.","example":"The billing item description","maxLength":255,"readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_duration":{"description":"The duration of the plan subscription.","example":1,"type":"number","x-auditable":true},"bill-subs-api_externally_managed":{"default":false,"description":"Indicates whether this plan is managed externally.","example":false,"type":"boolean","x-auditable":true},"bill-subs-api_frequency":{"description":"How often the subscription is renewed automatically.","enum":["weekly","monthly","quarterly","yearly"],"example":"monthly","type":"string","x-auditable":true},"bill-subs-api_identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_install_id":{"description":"app install id.","type":"string","x-auditable":true},"bill-subs-api_is_subscribed":{"default":false,"description":"Indicates whether you are currently subscribed to this plan.","example":false,"type":"boolean","x-auditable":true},"bill-subs-api_legacy_discount":{"default":false,"description":"Indicates whether this plan has a legacy discount applied.","example":false,"type":"boolean","x-auditable":true},"bill-subs-api_legacy_id":{"description":"The legacy identifier for this rate plan, if any.","example":"free","readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"bill-subs-api_name":{"description":"The domain name","example":"example.com","maxLength":253,"pattern":"^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$","readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_occurred_at":{"description":"When the billing item was created.","example":"2014-03-01T12:21:59.3456Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_plan_response_collection":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/bill-subs-api_schemas-rate-plan"},"type":"array"}},"type":"object"}]},"bill-subs-api_price":{"description":"The price of the subscription that will be billed, in US dollars.","example":20,"readOnly":true,"type":"number","x-auditable":true},"bill-subs-api_rate-plan":{"properties":{"components":{"$ref":"#/components/schemas/bill-subs-api_schemas-component_values"},"currency":{"$ref":"#/components/schemas/bill-subs-api_currency"},"duration":{"$ref":"#/components/schemas/bill-subs-api_duration"},"frequency":{"$ref":"#/components/schemas/bill-subs-api_schemas-frequency"},"id":{"$ref":"#/components/schemas/bill-subs-api_rate-plan_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/bill-subs-api_schemas-name"}},"type":"object"},"bill-subs-api_rate-plan_components-schemas-identifier":{"description":"Plan identifier tag.","example":"free","readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_rate_plan":{"description":"The rate plan applied to the subscription.","properties":{"currency":{"description":"The currency applied to the rate plan subscription.","example":"USD","type":"string","x-auditable":true},"externally_managed":{"description":"Whether this rate plan is managed externally from Cloudflare.","example":false,"type":"boolean","x-auditable":true},"id":{"description":"The ID of the rate plan.","example":"free","type":"string","x-auditable":true},"is_contract":{"description":"Whether a rate plan is enterprise-based (or newly adopted term contract).","example":false,"type":"boolean","x-auditable":true},"public_name":{"description":"The full name of the rate plan.","example":"Business Plan","type":"string","x-auditable":true},"scope":{"description":"The scope that this rate plan applies to.","example":"zone","type":"string","x-auditable":true},"sets":{"description":"The list of sets this rate plan applies to.","items":{"type":"string","x-auditable":true},"type":"array"}},"type":"object"},"bill-subs-api_result_info":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters","example":2000,"type":"number"}},"type":"object"},"bill-subs-api_schemas-component_values":{"description":"Array of available components values for the plan.","items":{"$ref":"#/components/schemas/bill-subs-api_component-value"},"type":"array"},"bill-subs-api_schemas-frequency":{"description":"The frequency at which you will be billed for this plan.","enum":["weekly","monthly","quarterly","yearly"],"example":"monthly","readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_schemas-identifier":{"description":"Subscription identifier tag.","example":"506e3185e9c882d175a2d0cb0093d9f2","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_schemas-name":{"description":"The plan name.","example":"Free Plan","maxLength":80,"readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_schemas-price":{"description":"The amount you will be billed for this plan.","example":0,"type":"number","x-auditable":true},"bill-subs-api_schemas-rate-plan":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_rate-plan"}],"type":"object"},"bill-subs-api_schemas-zone":{"properties":{"name":{"readOnly":true,"type":"string","x-auditable":true}},"type":"object"},"bill-subs-api_state":{"description":"The state that the subscription is in.","enum":["Trial","Provisioned","Paid","AwaitingPayment","Cancelled","Failed","Expired"],"example":"Paid","readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_subscription":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_subscription-v2"}],"type":"object"},"bill-subs-api_subscription-v2":{"properties":{"app":{"properties":{"install_id":{"$ref":"#/components/schemas/bill-subs-api_install_id"}}},"component_values":{"$ref":"#/components/schemas/bill-subs-api_component_values"},"currency":{"$ref":"#/components/schemas/bill-subs-api_currency"},"current_period_end":{"$ref":"#/components/schemas/bill-subs-api_current_period_end"},"current_period_start":{"$ref":"#/components/schemas/bill-subs-api_current_period_start"},"frequency":{"$ref":"#/components/schemas/bill-subs-api_frequency"},"id":{"$ref":"#/components/schemas/bill-subs-api_schemas-identifier"},"price":{"$ref":"#/components/schemas/bill-subs-api_price"},"rate_plan":{"$ref":"#/components/schemas/bill-subs-api_rate_plan"},"state":{"$ref":"#/components/schemas/bill-subs-api_state"},"zone":{"$ref":"#/components/schemas/bill-subs-api_zone"}},"type":"object"},"bill-subs-api_type":{"description":"The billing item type.","example":"charge","maxLength":30,"readOnly":true,"type":"string","x-auditable":true},"bill-subs-api_unit_price":{"description":"The unit price of the addon.","example":1,"readOnly":true,"type":"number","x-auditable":true},"bill-subs-api_user_subscription_response_collection":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/bill-subs-api_subscription"},"type":"array"}},"type":"object"}]},"bill-subs-api_user_subscription_response_single":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"bill-subs-api_zone":{"description":"A simple zone object. May have null properties if not a zone subscription.","properties":{"id":{"$ref":"#/components/schemas/bill-subs-api_identifier"},"name":{"$ref":"#/components/schemas/bill-subs-api_name"}},"type":"object"},"bill-subs-api_zone_subscription_response_single":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/bill-subs-api_subscription"}},"type":"object"}]},"bot-management_ai_bots_protection":{"description":"Enable rule to block AI Scrapers and Crawlers. Please note the value `only_on_ad_pages` is currently not available for Enterprise customers.","enum":["block","disabled","only_on_ad_pages"],"example":"block","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/bot-management_messages"},"messages":{"$ref":"#/components/schemas/bot-management_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"bot-management_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/bot-management_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/bot-management_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"bot-management_api-response-single":{"allOf":[{"$ref":"#/components/schemas/bot-management_api-response-common"}],"type":"object"},"bot-management_auto_update_model":{"description":"Automatically update to the newest bot detection models created by Cloudflare as they are released. [Learn more.](https://developers.cloudflare.com/bots/reference/machine-learning-models#model-versions-and-release-notes)","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_base_config":{"allOf":[{"properties":{"ai_bots_protection":{"$ref":"#/components/schemas/bot-management_ai_bots_protection"},"cf_robots_variant":{"$ref":"#/components/schemas/bot-management_cf_robots_variant"},"crawler_protection":{"$ref":"#/components/schemas/bot-management_crawler_protection"},"enable_js":{"$ref":"#/components/schemas/bot-management_enable_js"},"is_robots_txt_managed":{"$ref":"#/components/schemas/bot-management_is_robots_txt_managed"},"using_latest_model":{"$ref":"#/components/schemas/bot-management_using_latest_model"}}}],"title":"Shared Config"},"bot-management_bm_cookie_enabled":{"description":"Indicates that the bot management cookie can be placed on end user devices accessing the site. Defaults to true","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_bm_subscription_config":{"allOf":[{"$ref":"#/components/schemas/bot-management_base_config"},{"properties":{"auto_update_model":{"$ref":"#/components/schemas/bot-management_auto_update_model"},"bm_cookie_enabled":{"$ref":"#/components/schemas/bot-management_bm_cookie_enabled"},"stale_zone_configuration":{"description":"A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.","properties":{"fight_mode":{"$ref":"#/components/schemas/bot-management_fight_mode_turned_on"},"optimize_wordpress":{"$ref":"#/components/schemas/bot-management_optimize_wordpress_turned_on"},"sbfm_definitely_automated":{"$ref":"#/components/schemas/bot-management_sbfm_definitely_automated_turned_on"},"sbfm_likely_automated":{"$ref":"#/components/schemas/bot-management_sbfm_likely_automated_turned_on"},"sbfm_static_resource_protection":{"$ref":"#/components/schemas/bot-management_sbfm_static_resource_protection_turned_on"},"sbfm_verified_bots":{"$ref":"#/components/schemas/bot-management_sbfm_verified_bots_turned_on"}},"readOnly":true,"title":"stale_zone_configuration","type":"object"},"suppress_session_score":{"$ref":"#/components/schemas/bot-management_suppress_session_score"}}}],"title":"BM Enterprise Subscription"},"bot-management_bot_fight_mode_config":{"allOf":[{"$ref":"#/components/schemas/bot-management_base_config"},{"properties":{"fight_mode":{"$ref":"#/components/schemas/bot-management_fight_mode"},"stale_zone_configuration":{"description":"A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.","properties":{"optimize_wordpress":{"$ref":"#/components/schemas/bot-management_optimize_wordpress_turned_on"},"sbfm_definitely_automated":{"$ref":"#/components/schemas/bot-management_sbfm_definitely_automated_turned_on"},"sbfm_likely_automated":{"$ref":"#/components/schemas/bot-management_sbfm_likely_automated_turned_on"},"sbfm_static_resource_protection":{"$ref":"#/components/schemas/bot-management_sbfm_static_resource_protection_turned_on"},"sbfm_verified_bots":{"$ref":"#/components/schemas/bot-management_sbfm_verified_bots_turned_on"},"suppress_session_score":{"$ref":"#/components/schemas/bot-management_suppress_session_score_turned_off"}},"readOnly":true,"title":"stale_zone_configuration","type":"object"}}}],"title":"Bot Fight Mode"},"bot-management_bot_management_response_body":{"allOf":[{"$ref":"#/components/schemas/bot-management_api-response-single"},{"properties":{"result":{"oneOf":[{"$ref":"#/components/schemas/bot-management_bot_fight_mode_config"},{"$ref":"#/components/schemas/bot-management_sbfm_definitely_config"},{"$ref":"#/components/schemas/bot-management_sbfm_likely_config"},{"$ref":"#/components/schemas/bot-management_bm_subscription_config"}]}},"type":"object"}]},"bot-management_cf_robots_variant":{"description":"Specifies the Robots Access Control License variant to use.","enum":["off","policy_only"],"example":"policy_only","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_config_single":{"oneOf":[{"$ref":"#/components/schemas/bot-management_bot_fight_mode_config"},{"$ref":"#/components/schemas/bot-management_sbfm_definitely_config"},{"$ref":"#/components/schemas/bot-management_sbfm_likely_config"},{"$ref":"#/components/schemas/bot-management_bm_subscription_config"}],"type":"object"},"bot-management_crawler_protection":{"description":"Enable rule to punish AI Scrapers and Crawlers via a link maze.","enum":["enabled","disabled"],"example":"enabled","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_enable_js":{"description":"Use lightweight, invisible JavaScript detections to improve Bot Management. [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/).","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_feedback_report":{"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"expression":{"description":"Wirefilter expression describing the traffic being reported.","type":"string"},"first_request_seen_at":{"format":"date-time","type":"string"},"last_request_seen_at":{"format":"date-time","type":"string"},"requests":{"format":"int64","type":"integer"},"requests_by_attribute":{"$ref":"#/components/schemas/bot-management_requests_by_attribute"},"requests_by_score":{"$ref":"#/components/schemas/bot-management_requests_by_score"},"requests_by_score_src":{"$ref":"#/components/schemas/bot-management_requests_by_score_src"},"subtype":{"type":"string"},"type":{"$ref":"#/components/schemas/bot-management_feedback_type"}},"required":["type","description","expression","first_request_seen_at","last_request_seen_at","requests","requests_by_score","requests_by_score_src","requests_by_attribute"],"type":"object"},"bot-management_feedback_type":{"description":"Type of feedback report.","enum":["false_positive","false_negative"],"example":"false_positive","type":"string"},"bot-management_fight_mode":{"description":"Whether to enable Bot Fight Mode.","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_fight_mode_turned_on":{"description":"Indicates that the zone's Bot Fight Mode is turned on.","title":"fight_mode","type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"bot-management_is_robots_txt_managed":{"default":false,"description":"Enable cloudflare managed robots.txt. If an existing robots.txt is detected, then managed robots.txt will be prepended to the existing robots.txt.","example":false,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"bot-management_metric_requests":{"properties":{"metric":{"type":"string"},"requests":{"format":"int64","type":"integer"}},"required":["metric","requests"],"type":"object"},"bot-management_optimize_wordpress":{"description":"Whether to optimize Super Bot Fight Mode protections for Wordpress.","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_optimize_wordpress_turned_on":{"description":"Indicates that the zone's wordpress optimization for SBFM is turned on.","title":"optimize_wordpress","type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_requests_by_attribute":{"additionalProperties":{"items":{"$ref":"#/components/schemas/bot-management_metric_requests"},"type":"array"},"description":"Top attributes contributing to the feedback sample. Keys include topASNs, topCountries, topHosts, topIPs, topJA3Hashes, topJA4s, topPaths, topUserAgents.","type":"object"},"bot-management_requests_by_score":{"additionalProperties":{"format":"int64","type":"integer"},"description":"Map of bot scores (1-99) to request counts. Sum must equal `requests`.","type":"object"},"bot-management_requests_by_score_src":{"additionalProperties":{"format":"int64","type":"integer"},"description":"Map of score source to request counts. Sum must equal `requests`.","type":"object"},"bot-management_sbfm_definitely_automated":{"description":"Super Bot Fight Mode (SBFM) action to take on definitely automated requests.","enum":["allow","block","managed_challenge"],"example":"allow","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_sbfm_definitely_automated_turned_on":{"description":"Indicates that the zone's definitely automated requests are being blocked or challenged.","title":"sbfm_definitely_automated","type":"string","x-auditable":true},"bot-management_sbfm_definitely_config":{"allOf":[{"$ref":"#/components/schemas/bot-management_base_config"},{"properties":{"optimize_wordpress":{"$ref":"#/components/schemas/bot-management_optimize_wordpress"},"sbfm_definitely_automated":{"$ref":"#/components/schemas/bot-management_sbfm_definitely_automated"},"sbfm_static_resource_protection":{"$ref":"#/components/schemas/bot-management_sbfm_static_resource_protection"},"sbfm_verified_bots":{"$ref":"#/components/schemas/bot-management_sbfm_verified_bots"},"stale_zone_configuration":{"description":"A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.","properties":{"fight_mode":{"$ref":"#/components/schemas/bot-management_fight_mode_turned_on"},"sbfm_likely_automated":{"$ref":"#/components/schemas/bot-management_sbfm_likely_automated_turned_on"}},"readOnly":true,"title":"stale_zone_configuration","type":"object"}}}],"title":"SBFM Pro Plan"},"bot-management_sbfm_likely_automated":{"description":"Super Bot Fight Mode (SBFM) action to take on likely automated requests.","enum":["allow","block","managed_challenge"],"example":"allow","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_sbfm_likely_automated_turned_on":{"description":"Indicates that the zone's likely automated requests are being blocked or challenged.","title":"sbfm_likely_automated","type":"string","x-auditable":true},"bot-management_sbfm_likely_config":{"allOf":[{"$ref":"#/components/schemas/bot-management_base_config"},{"properties":{"optimize_wordpress":{"$ref":"#/components/schemas/bot-management_optimize_wordpress"},"sbfm_definitely_automated":{"$ref":"#/components/schemas/bot-management_sbfm_definitely_automated"},"sbfm_likely_automated":{"$ref":"#/components/schemas/bot-management_sbfm_likely_automated"},"sbfm_static_resource_protection":{"$ref":"#/components/schemas/bot-management_sbfm_static_resource_protection"},"sbfm_verified_bots":{"$ref":"#/components/schemas/bot-management_sbfm_verified_bots"},"stale_zone_configuration":{"description":"A read-only field that shows which unauthorized settings are currently active on the zone. These settings typically result from upgrades or downgrades.","properties":{"fight_mode":{"$ref":"#/components/schemas/bot-management_fight_mode_turned_on"}},"readOnly":true,"title":"stale_zone_configuration","type":"object"}}}],"title":"SBFM Biz Plan"},"bot-management_sbfm_static_resource_protection":{"description":"Super Bot Fight Mode (SBFM) to enable static resource protection.\nEnable if static resources on your application need bot protection.\nNote: Static resource protection can also result in legitimate traffic being blocked.\n","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_sbfm_static_resource_protection_turned_on":{"description":"Indicates that the zone's static resource protection is turned on.","title":"sbfm_static_resource_protection","type":"string","x-auditable":true},"bot-management_sbfm_verified_bots":{"description":"Super Bot Fight Mode (SBFM) action to take on verified bots requests.","enum":["allow","block"],"example":"allow","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_sbfm_verified_bots_turned_on":{"description":"Indicates that the zone's verified bot requests are being blocked.","title":"sbfm_verified_bots","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_suppress_session_score":{"description":"Whether to disable tracking the highest bot score for a session in the Bot Management cookie.","example":false,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_suppress_session_score_turned_off":{"description":"Indicates that the zone's session score tracking is disabled.","title":"suppress_session_score","type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bot-management_using_latest_model":{"description":"A read-only field that indicates whether the zone currently is running the latest ML model.\n","example":true,"readOnly":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"brand-protection-api_Error":{"properties":{"code":{"description":"Error code","type":"integer"},"errors":{"additionalProperties":{},"description":"Errors","type":"object"},"message":{"description":"Error message","type":"string"},"status":{"description":"Error name","type":"string"}},"type":"object"},"brand-protection-api_ImageFile":{"properties":{"image":{"format":"binary","type":"string"}},"type":"object"},"brand-protection-api_Logo":{"properties":{"id":{"type":"integer"},"tag":{"type":"string"},"upload_path":{"type":"string"}},"type":"object"},"brand-protection-api_LogoMatch":{"properties":{"matches":{"items":{"additionalProperties":{},"type":"object"},"type":"array"},"total":{"type":"integer"}},"type":"object"},"brand-protection-api_PaginationMetadata":{"properties":{"first_page":{"type":"integer"},"last_page":{"type":"integer"},"next_page":{"type":"integer"},"page":{"type":"integer"},"previous_page":{"type":"integer"},"total":{"type":"integer"},"total_pages":{"type":"integer"}},"type":"object"},"brand-protection-api_Query":{"properties":{"max_time":{"format":"date-time","nullable":true,"type":"string"},"min_time":{"format":"date-time","nullable":true,"type":"string"},"scan":{"type":"boolean"},"string_matches":{},"tag":{"type":"string"}},"type":"object"},"brand-protection-api_QueryBulk":{"properties":{"queries":{"items":{"additionalProperties":{},"type":"object"},"type":"array"}},"type":"object"},"brand-protection-api_QueryMatch":{"properties":{"matches":{"items":{"additionalProperties":{},"type":"object"},"type":"array"},"total":{"type":"integer"}},"type":"object"},"brand-protection-api_URLInfo":{"properties":{"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array"}},"type":"object"},"brand-protection-api_URLSubmit":{"properties":{"skipped_urls":{"items":{"additionalProperties":{},"type":"object"},"type":"array"},"submitted_urls":{"items":{"additionalProperties":{},"type":"object"},"type":"array"}},"type":"object"},"builds_APIResponse":{"properties":{"errors":{"items":{"properties":{"code":{"example":12000,"type":"integer"},"message":{"example":"Not found","type":"string"}},"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"nullable":true,"type":"object"},"result_info":{"$ref":"#/components/schemas/builds_PaginationInfo"},"success":{"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"builds_BuildLogsResponse":{"properties":{"cursor":{"example":"eyJsaW5lIjoxMDAsInRpbWVzdGFtcCI6MTYzNjQ3MjQwMH0","nullable":true,"type":"string"},"lines":{"items":{"items":{"anyOf":[{"description":"Unix epoch timestamp","example":1636472400,"type":"number"},{"description":"Log message","example":"Building worker...","type":"string"}]},"maxItems":2,"minItems":2,"type":"array"},"type":"array"},"truncated":{"example":false,"type":"boolean"}},"type":"object"},"builds_BuildOutcome":{"enum":["success","fail","skipped","cancelled","terminated"],"example":"success","type":"string"},"builds_BuildResponse":{"properties":{"build_outcome":{"$ref":"#/components/schemas/builds_BuildOutcome"},"build_trigger_metadata":{"$ref":"#/components/schemas/builds_BuildTriggerMetadataResponse"},"build_uuid":{"format":"uuid","type":"string"},"created_on":{"format":"date-time","type":"string"},"initializing_on":{"format":"date-time","nullable":true,"type":"string"},"modified_on":{"format":"date-time","type":"string"},"pull_request":{"nullable":true,"properties":{"created_on":{"format":"date-time","type":"string"},"pull_request_url":{"example":"https://github.com/cloudflare/workers-sdk/pull/123","format":"uri","type":"string"}},"type":"object"},"running_on":{"format":"date-time","nullable":true,"type":"string"},"status":{"$ref":"#/components/schemas/builds_BuildStatus"},"stopped_on":{"format":"date-time","nullable":true,"type":"string"},"trigger":{"description":"Trigger information without build_token_uuid","properties":{"branch_excludes":{"items":{"type":"string"},"type":"array"},"branch_includes":{"items":{"type":"string"},"type":"array"},"build_caching_enabled":{"type":"boolean"},"build_command":{"example":"npm run build","type":"string"},"created_on":{"format":"date-time","type":"string"},"deleted_on":{"format":"date-time","nullable":true,"type":"string"},"deploy_command":{"example":"npm run deploy","type":"string"},"external_script_id":{"example":"my-worker","type":"string"},"modified_on":{"format":"date-time","type":"string"},"path_excludes":{"items":{"type":"string"},"type":"array"},"path_includes":{"items":{"type":"string"},"type":"array"},"repo_connection":{"$ref":"#/components/schemas/builds_UpsertRepoConnectionResponse"},"root_directory":{"example":"/","type":"string"},"trigger_name":{"example":"Production Deploy","type":"string"},"trigger_uuid":{"format":"uuid","type":"string"}},"type":"object"}},"type":"object"},"builds_BuildSeedRepoInput":{"properties":{"branch":{"example":"main","type":"string"},"files":{"items":{"$ref":"#/components/schemas/builds_BuildSeedRepoInputFile"},"maxItems":2,"type":"array"},"owner":{"example":"cloudflare","type":"string"},"path":{"example":"/","type":"string"},"provider":{"$ref":"#/components/schemas/builds_SCMProviderType"},"repository":{"example":"workers-sdk","type":"string"}},"required":["provider","owner","repository","branch","path"],"type":"object"},"builds_BuildSeedRepoInputFile":{"properties":{"content":{"example":"name = \"my-worker\"\nmain = \"src/index.js\"\n","type":"string"},"filename":{"example":"wrangler.toml","type":"string"},"isBase64":{"default":false,"type":"boolean"},"replace":{"description":"Text to replace in the file","type":"string"}},"required":["filename","content"],"type":"object"},"builds_BuildStatus":{"enum":["queued","initializing","running","stopped"],"example":"running","type":"string"},"builds_BuildTriggerMetadataResponse":{"properties":{"author":{"example":"developer@cloudflare.com","type":"string"},"branch":{"example":"main","type":"string"},"build_command":{"example":"npm run build","type":"string"},"build_token_name":{"example":"My Build Token","type":"string"},"build_token_uuid":{"format":"uuid","type":"string"},"build_trigger_source":{"$ref":"#/components/schemas/builds_BuildTriggerSource"},"commit_hash":{"example":"abc123def456","type":"string"},"commit_message":{"example":"Add new feature","type":"string"},"deploy_command":{"example":"npm run deploy","type":"string"},"environment_variables":{"additionalProperties":{"type":"string"},"type":"object"},"provider_account_name":{"example":"Cloudflare","type":"string"},"provider_type":{"$ref":"#/components/schemas/builds_SCMProviderType"},"repo_name":{"example":"workers-sdk","type":"string"},"root_directory":{"example":"/","type":"string"}},"type":"object"},"builds_BuildTriggerSource":{"enum":["push","pull_request","manual","api"],"example":"push","type":"string"},"builds_BuildsByVersionResponse":{"properties":{"builds":{"additionalProperties":{"$ref":"#/components/schemas/builds_BuildResponse"},"type":"object"}},"type":"object"},"builds_CanceledBuildResponse":{"properties":{"build_outcome":{"$ref":"#/components/schemas/builds_BuildOutcome"},"build_uuid":{"format":"uuid","type":"string"},"stopped_on":{"format":"date-time","type":"string"}},"type":"object"},"builds_ConfigAutofillResponse":{"properties":{"config_file":{"example":"wrangler.toml","nullable":true,"type":"string"},"default_worker_name":{"example":"my-worker","nullable":true,"type":"string"},"env_worker_names":{"additionalProperties":{"type":"string"},"example":{"production":"my-worker-prod","staging":"my-worker-staging"},"nullable":true,"type":"object"},"package_manager":{"allOf":[{"$ref":"#/components/schemas/builds_PackageManager"}],"nullable":true,"type":"string"},"scripts":{"additionalProperties":{"type":"string"},"example":{"build":"npm run build","test":"npm test"},"nullable":true,"type":"object"}},"type":"object"},"builds_CreateBuildRequest":{"anyOf":[{"required":["commit_hash"]},{"required":["branch"]}],"properties":{"branch":{"description":"Git branch name (required if commit_hash not provided)","example":"main","type":"string"},"commit_hash":{"description":"Git commit hash (required if branch not provided)","example":"abc123def456","type":"string"},"seed_repo":{"$ref":"#/components/schemas/builds_BuildSeedRepoInput"}},"type":"object"},"builds_CreateBuildTokenRequest":{"properties":{"build_token_name":{"example":"My Build Token","type":"string"},"build_token_secret":{"example":"super-secret-token","type":"string"},"cloudflare_token_id":{"example":"cf-token-123","type":"string"}},"required":["build_token_name","build_token_secret","cloudflare_token_id"],"type":"object"},"builds_CreateBuildTokenResponse":{"properties":{"build_token_name":{"example":"My Build Token","type":"string"},"build_token_uuid":{"format":"uuid","type":"string"},"cloudflare_token_id":{"example":"cf-token-123","type":"string"},"owner_type":{"example":"user","type":"string"}},"type":"object"},"builds_CreateTriggerRequest":{"properties":{"branch_excludes":{"example":[],"items":{"type":"string"},"type":"array"},"branch_includes":{"example":["main"],"items":{"type":"string"},"type":"array"},"build_caching_enabled":{"default":false,"type":"boolean"},"build_command":{"example":"npm run build","type":"string"},"build_token_uuid":{"format":"uuid","type":"string"},"deploy_command":{"example":"npx wrangler deploy","type":"string"},"external_script_id":{"example":"my-worker","type":"string"},"path_excludes":{"example":["*.md"],"items":{"type":"string"},"type":"array"},"path_includes":{"default":"*","example":["*"],"items":{"type":"string"},"type":"array"},"repo_connection_uuid":{"format":"uuid","type":"string"},"root_directory":{"example":"/","type":"string"},"trigger_name":{"example":"Production Deploy","type":"string"}},"required":["external_script_id","build_token_uuid","trigger_name","build_command","deploy_command","root_directory","branch_includes","branch_excludes","path_includes","path_excludes","repo_connection_uuid"],"type":"object"},"builds_EnvironmentVariablesRequest":{"additionalProperties":{"properties":{"is_secret":{"example":false,"type":"boolean"},"value":{"example":"production","nullable":true,"type":"string"}},"required":["is_secret"],"type":"object"},"example":{"API_KEY":{"is_secret":true,"value":"secret-key"},"NODE_ENV":{"is_secret":false,"value":"production"}},"type":"object"},"builds_EnvironmentVariablesResponse":{"additionalProperties":{"properties":{"created_on":{"format":"date-time","type":"string"},"is_secret":{"example":false,"type":"boolean"},"value":{"description":"Value is null for secret environment variables","nullable":true,"type":"string"}},"required":["is_secret","created_on"],"type":"object"},"example":{"API_KEY":{"created_on":"2023-01-01T00:00:00Z","is_secret":true,"value":null},"NODE_ENV":{"created_on":"2023-01-01T00:00:00Z","is_secret":false,"value":"production"}},"type":"object"},"builds_ErrorResponse":{"properties":{"errors":{"items":{"properties":{"code":{"example":12000,"type":"integer"},"message":{"example":"Not found","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"nullable":true,"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"builds_GetAccountLimitResponse":{"properties":{"build_minutes_refresh_on":{"description":"When build minutes will refresh (only for non-paid plans)","format":"date-time","nullable":true,"type":"string"},"has_reached_build_minutes_limit":{"description":"Whether build minutes limit has been reached (only for non-paid plans)","nullable":true,"type":"boolean"}},"type":"object"},"builds_InsertBuildResponse":{"properties":{"build_uuid":{"format":"uuid","type":"string"},"created_on":{"format":"date-time","type":"string"}},"type":"object"},"builds_LatestBuildsResponse":{"properties":{"builds":{"additionalProperties":{"$ref":"#/components/schemas/builds_BuildResponse"},"type":"object"}},"type":"object"},"builds_ListTokensResponse":{"properties":{"build_token_name":{"example":"My Build Token","type":"string"},"build_token_uuid":{"format":"uuid","type":"string"},"cloudflare_token_id":{"example":"cf-token-123","type":"string"},"owner_type":{"example":"user","type":"string"}},"type":"object"},"builds_PackageManager":{"enum":["npm","yarn","pnpm","bun","uv"],"example":"npm","type":"string"},"builds_PaginationInfo":{"properties":{"count":{"example":25,"type":"integer"},"page":{"example":1,"type":"integer"},"per_page":{"example":50,"type":"integer"},"total_count":{"example":150,"type":"integer"},"total_pages":{"example":3,"type":"integer"}},"type":"object"},"builds_SCMProviderType":{"enum":["github"],"example":"github","type":"string"},"builds_TriggerResponse":{"properties":{"branch_excludes":{"example":[],"items":{"type":"string"},"type":"array"},"branch_includes":{"example":["main"],"items":{"type":"string"},"type":"array"},"build_caching_enabled":{"example":false,"type":"boolean"},"build_command":{"example":"npm run build","type":"string"},"build_token_name":{"example":"My Build Token","type":"string"},"build_token_uuid":{"format":"uuid","type":"string"},"created_on":{"format":"date-time","type":"string"},"deleted_on":{"format":"date-time","nullable":true,"type":"string"},"deploy_command":{"example":"npm run deploy","type":"string"},"external_script_id":{"example":"my-worker","type":"string"},"modified_on":{"format":"date-time","type":"string"},"path_excludes":{"example":["*.md"],"items":{"type":"string"},"type":"array"},"path_includes":{"example":["src/**"],"items":{"type":"string"},"type":"array"},"repo_connection":{"$ref":"#/components/schemas/builds_UpsertRepoConnectionResponse"},"root_directory":{"example":"/","type":"string"},"trigger_name":{"example":"Production Deploy","type":"string"},"trigger_uuid":{"format":"uuid","type":"string"}},"type":"object"},"builds_UpdateTriggerRequest":{"properties":{"branch_excludes":{"example":[],"items":{"type":"string"},"type":"array"},"branch_includes":{"example":["main"],"items":{"type":"string"},"type":"array"},"build_caching_enabled":{"default":false,"type":"boolean"},"build_command":{"example":"npm run build","type":"string"},"build_token_uuid":{"format":"uuid","type":"string"},"deploy_command":{"example":"npm run deploy","type":"string"},"path_excludes":{"example":["*.md"],"items":{"type":"string"},"type":"array"},"path_includes":{"example":["src/**"],"items":{"type":"string"},"type":"array"},"root_directory":{"example":"/","type":"string"},"trigger_name":{"example":"Production Deploy","type":"string"}},"type":"object"},"builds_UpsertRepoConnectionRequest":{"properties":{"provider_account_id":{"example":"cloudflare","type":"string"},"provider_account_name":{"example":"Cloudflare","type":"string"},"provider_type":{"$ref":"#/components/schemas/builds_SCMProviderType"},"repo_id":{"example":"workers-sdk","type":"string"},"repo_name":{"example":"workers-sdk","type":"string"}},"required":["repo_id","repo_name","provider_type","provider_account_id","provider_account_name"],"type":"object"},"builds_UpsertRepoConnectionResponse":{"properties":{"created_on":{"format":"date-time","type":"string"},"deleted_on":{"format":"date-time","nullable":true,"type":"string"},"modified_on":{"format":"date-time","type":"string"},"provider_account_id":{"example":"cloudflare","type":"string"},"provider_account_name":{"example":"Cloudflare","type":"string"},"provider_type":{"$ref":"#/components/schemas/builds_SCMProviderType"},"repo_connection_uuid":{"format":"uuid","type":"string"},"repo_id":{"example":"workers-sdk","type":"string"},"repo_name":{"example":"workers-sdk","type":"string"}},"type":"object"},"cache-purge_Everything":{"properties":{"purge_everything":{"description":"For more information, please refer to [purge everything documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-everything/).","example":true,"type":"boolean","x-auditable":true}},"title":"Purge everything","type":"object"},"cache-purge_FlexPurgeByHostnames":{"properties":{"hosts":{"description":"For more information purging by hostnames, please refer to [purge by hostname documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-hostname/).","example":["www.example.com","images.example.com"],"items":{"type":"string","x-auditable":true},"type":"array"}},"title":"Purge by hostnames","type":"object"},"cache-purge_FlexPurgeByPrefixes":{"properties":{"prefixes":{"description":"For more information on purging by prefixes, please refer to [purge by prefix documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge_by_prefix/).","example":["www.example.com/foo","images.example.com/bar/baz"],"items":{"type":"string","x-auditable":true},"type":"array"}},"title":"Purge by prefixes","type":"object"},"cache-purge_FlexPurgeByTags":{"properties":{"tags":{"description":"For more information on cache tags and purging by tags, please refer to [purge by cache-tags documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-tags/).","example":["a-cache-tag","another-cache-tag"],"items":{"type":"string","x-auditable":true},"type":"array"}},"title":"Purge by tags","type":"object"},"cache-purge_SingleFile":{"properties":{"files":{"description":"For more information on purging files, please refer to [purge by single-file documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).","example":["http://www.example.com/css/styles.css","http://www.example.com/js/index.js"],"items":{"type":"string","x-auditable":true},"type":"array"}},"title":"Purge files","type":"object"},"cache-purge_SingleFileWithUrlAndHeaders":{"properties":{"files":{"description":"For more information on purging files with URL and headers, please refer to [purge by single-file documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).","example":[{"headers":{"Accept-Language":"zh-CN","CF-Device-Type":"desktop","CF-IPCountry":"US"},"url":"http://www.example.com/cat_picture.jpg"},{"headers":{"Accept-Language":"en-US","CF-Device-Type":"mobile","CF-IPCountry":"EU"},"url":"http://www.example.com/dog_picture.jpg"}],"items":{"properties":{"headers":{"additionalProperties":{"type":"string","x-auditable":true},"example":"\u003cHTTP header object\u003e","type":"object"},"url":{"example":"http://www.example.com/cat_picture.jpg","type":"string","x-auditable":true}},"type":"object"},"type":"array"}},"title":"Purge files with URL and headers","type":"object"},"cache-purge_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/cache-purge_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/cache-purge_messages"}],"example":[]},"result":{"nullable":true,"type":"object"},"success":{"description":"Indicates the API call's success or failure.","example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"cache-purge_api-response-single-id":{"properties":{"errors":{"$ref":"#/components/schemas/cache-purge_messages"},"messages":{"$ref":"#/components/schemas/cache-purge_messages"},"result":{"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/cache-purge_identifier"}},"required":["id"],"type":"object"},"success":{"description":"Indicates the API call's success or failure.","example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"cache-purge_identifier":{"example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string"},"cache-purge_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"cache-rules_aegis":{"allOf":[{"$ref":"#/components/schemas/cache-rules_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["aegis"],"example":"aegis","type":"string","x-auditable":true},"value":{"$ref":"#/components/schemas/cache-rules_aegis_value"}},"type":"object"}],"description":"Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses.","title":"Aegis","type":"object"},"cache-rules_aegis_response_value":{"properties":{"result":{"$ref":"#/components/schemas/cache-rules_aegis"}},"type":"object"},"cache-rules_aegis_value":{"description":"Value of the zone setting.","properties":{"enabled":{"description":"Whether the feature is enabled or not.","type":"boolean","x-auditable":true},"pool_id":{"description":"Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin.","example":"pool-id","type":"string","x-auditable":true}},"type":"object"},"cache-rules_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/cache-rules_messages"},"messages":{"$ref":"#/components/schemas/cache-rules_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"cache-rules_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/cache-rules_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"items":{"type":"object"},"minLength":1,"type":"array"},"messages":{"allOf":[{"$ref":"#/components/schemas/cache-rules_messages"}],"example":[],"items":{"type":"object"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"cache-rules_base":{"properties":{"id":{"description":"Identifier of the zone setting.","type":"string","x-auditable":true},"modified_on":{"description":"Last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string","x-auditable":true}},"required":["id"],"type":"object"},"cache-rules_cache_reserve":{"allOf":[{"$ref":"#/components/schemas/cache-rules_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["cache_reserve"],"example":"cache_reserve","type":"string","x-auditable":true}},"type":"object"}],"description":"Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.","title":"Cache Reserve","type":"object"},"cache-rules_cache_reserve_clear":{"allOf":[{"$ref":"#/components/schemas/cache-rules_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["cache_reserve_clear"],"example":"cache_reserve_clear","type":"string","x-auditable":true}},"type":"object"}],"description":"You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.","title":"Cache Reserve Clear","type":"object"},"cache-rules_cache_reserve_clear_end_ts":{"description":"The time that the latest Cache Reserve Clear operation completed.","example":"2023-10-02T12:00:00.12345Z","format":"date-time","type":"string","x-auditable":true},"cache-rules_cache_reserve_clear_response_value":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/cache-rules_cache_reserve_clear"},{"properties":{"end_ts":{"$ref":"#/components/schemas/cache-rules_cache_reserve_clear_end_ts"},"start_ts":{"$ref":"#/components/schemas/cache-rules_cache_reserve_clear_start_ts"},"state":{"$ref":"#/components/schemas/cache-rules_cache_reserve_clear_state"}},"required":["state","start_ts"],"type":"object"}],"type":"object"}},"type":"object"},"cache-rules_cache_reserve_clear_start_ts":{"description":"The time that the latest Cache Reserve Clear operation started.","example":"2023-10-02T10:00:00.12345Z","format":"date-time","type":"string","x-auditable":true},"cache-rules_cache_reserve_clear_state":{"description":"The current state of the Cache Reserve Clear operation.","enum":["In-progress","Completed"],"example":"In-progress","type":"string","x-auditable":true},"cache-rules_cache_reserve_response_value":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/cache-rules_cache_reserve"},{"properties":{"value":{"$ref":"#/components/schemas/cache-rules_cache_reserve_value"}},"required":["value"],"type":"object"}],"type":"object"}},"type":"object"},"cache-rules_cache_reserve_value":{"default":"off","description":"Value of the Cache Reserve zone setting.","enum":["on","off"],"type":"string","x-auditable":true},"cache-rules_editable":{"description":"Whether the setting is editable.","type":"boolean","x-auditable":true},"cache-rules_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"cache-rules_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"cache-rules_modified_on":{"description":"The time when the setting was last modified.","format":"date-time","type":"string","x-auditable":true},"cache-rules_origin_h2_max_streams":{"allOf":[{"$ref":"#/components/schemas/cache-rules_base"},{"properties":{"id":{"description":"Value of the zone setting.","enum":["origin_h2_max_streams"],"example":"origin_h2_max_streams","type":"string","x-auditable":true},"value":{"$ref":"#/components/schemas/cache-rules_origin_h2_max_streams_value"}},"type":"object"}],"description":"Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled.","title":"Origin H2 Max Streams","type":"object"},"cache-rules_origin_h2_max_streams_response_value":{"allOf":[{"$ref":"#/components/schemas/cache-rules_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cache-rules_origin_h2_max_streams"}},"type":"object"}]},"cache-rules_origin_h2_max_streams_value":{"description":"Value of the Origin H2 Max Streams Setting.","example":50,"maximum":1000,"minimum":1,"type":"integer","x-auditable":true},"cache-rules_origin_max_http_version":{"allOf":[{"$ref":"#/components/schemas/cache-rules_base"},{"properties":{"id":{"description":"Value of the zone setting.","enum":["origin_max_http_version"],"example":"origin_max_http_version","type":"string","x-auditable":true},"value":{"$ref":"#/components/schemas/cache-rules_origin_max_http_version_value"}},"type":"object"}],"description":"Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is \"2\" for all plan types except Enterprise where it is \"1\".","title":"Origin Max HTTP Version","type":"object"},"cache-rules_origin_max_http_version_response_value":{"properties":{"result":{"$ref":"#/components/schemas/cache-rules_origin_max_http_version"}},"type":"object"},"cache-rules_origin_max_http_version_value":{"description":"Value of the Origin Max HTTP Version Setting.","enum":["2","1"],"type":"string","x-auditable":true},"cache-rules_origin_post_quantum_encryption":{"allOf":[{"$ref":"#/components/schemas/cache-rules_base"},{"properties":{"id":{"description":"Value of the zone setting.","enum":["origin_pqe"],"example":"origin_pqe","type":"string","x-auditable":true}},"type":"object"}],"description":"Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised.","title":"Origin Post-Quantum Encryption","type":"object"},"cache-rules_origin_post_quantum_encryption_response_value":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/cache-rules_origin_post_quantum_encryption"},{"properties":{"value":{"$ref":"#/components/schemas/cache-rules_origin_post_quantum_encryption_value"}},"required":["value"],"type":"object"}],"type":"object"}},"type":"object"},"cache-rules_origin_post_quantum_encryption_value":{"default":"supported","description":"Value of the Origin Post Quantum Encryption Setting.","enum":["preferred","supported","off"],"type":"string","x-auditable":true},"cache-rules_patch":{"description":"Update enablement of Tiered Caching.","properties":{"value":{"$ref":"#/components/schemas/cache-rules_value"}},"required":["value"],"type":"object"},"cache-rules_regional_tiered_cache":{"allOf":[{"$ref":"#/components/schemas/cache-rules_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["tc_regional"],"example":"tc_regional","type":"string","x-auditable":true}},"type":"object"}],"description":"Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.","title":"Regional Tiered Cache","type":"object"},"cache-rules_regional_tiered_cache_response_value":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/cache-rules_regional_tiered_cache"},{"properties":{"value":{"$ref":"#/components/schemas/cache-rules_regional_tiered_cache_value"}},"required":["value"],"type":"object"}],"type":"object"}},"type":"object"},"cache-rules_regional_tiered_cache_value":{"default":"off","description":"Value of the Regional Tiered Cache zone setting.","enum":["on","off"],"type":"string","x-auditable":true},"cache-rules_result-object":{"properties":{"editable":{"$ref":"#/components/schemas/cache-rules_editable"},"id":{"$ref":"#/components/schemas/cache-rules_setting_id"},"modified_on":{"$ref":"#/components/schemas/cache-rules_modified_on"},"value":{"$ref":"#/components/schemas/cache-rules_setting_value"}},"required":["id","value","editable"],"type":"object"},"cache-rules_result-object-delete":{"properties":{"editable":{"$ref":"#/components/schemas/cache-rules_editable"},"id":{"$ref":"#/components/schemas/cache-rules_setting_id"},"modified_on":{"$ref":"#/components/schemas/cache-rules_modified_on"}},"required":["id","editable"],"type":"object"},"cache-rules_setting_id":{"description":"The identifier of the caching setting.","type":"string","x-auditable":true},"cache-rules_setting_value":{"description":"The value of the setting.","type":"string","x-auditable":true},"cache-rules_smart_tiered_cache":{"allOf":[{"$ref":"#/components/schemas/cache-rules_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["tiered_cache_smart_topology_enable"],"example":"tiered_cache_smart_topology_enable","type":"string","x-auditable":true}},"type":"object"}],"title":"Smart Tiered Cache","type":"object"},"cache-rules_smart_tiered_cache_patch":{"description":"Update enablement of Smart Tiered Cache.","properties":{"value":{"description":"Enable or disable the Smart Tiered Cache.","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"required":["value"],"type":"object"},"cache-rules_smart_tiered_cache_response_value":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/cache-rules_smart_tiered_cache"},{"properties":{"value":{"$ref":"#/components/schemas/cache-rules_smart_tiered_cache_value"}},"required":["value"],"type":"object"}],"type":"object"}},"type":"object"},"cache-rules_smart_tiered_cache_value":{"default":"off","description":"Value of the Smart Tiered Cache zone setting.","enum":["on","off"],"type":"string","x-auditable":true},"cache-rules_tiered_cache":{"allOf":[{"$ref":"#/components/schemas/cache-rules_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["tiered_caching"],"example":"tiered_caching","type":"string","x-auditable":true}},"type":"object"}],"title":"Tiered Cache","type":"object"},"cache-rules_tiered_cache_response_value":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/cache-rules_tiered_cache"},{"properties":{"value":{"$ref":"#/components/schemas/cache-rules_tiered_cache_value"}},"required":["value"],"type":"object"}],"type":"object"}},"type":"object"},"cache-rules_tiered_cache_value":{"default":"off","description":"Value of the Tiered Cache zone setting.","enum":["on","off"],"type":"string","x-auditable":true},"cache-rules_value":{"description":"Enables Tiered Caching.","enum":["on","off"],"example":"on","type":"string","x-auditable":true},"cache-rules_variants":{"allOf":[{"$ref":"#/components/schemas/cache-rules_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["variants"],"example":"variants","type":"string","x-auditable":true}},"type":"object"}],"description":"Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.","title":"Variants Caching","type":"object"},"cache-rules_variants_response_value":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/cache-rules_variants"},{"properties":{"value":{"$ref":"#/components/schemas/cache-rules_variants_value"}},"required":["value"],"type":"object"}],"type":"object"}},"type":"object"},"cache-rules_variants_value":{"description":"Value of the zone setting.","properties":{"avif":{"description":"List of strings with the MIME types of all the variants that should be served for avif.","example":["image/webp","image/jpeg"],"items":{"type":"string","x-auditable":true},"type":"array","uniqueItems":true},"bmp":{"description":"List of strings with the MIME types of all the variants that should be served for bmp.","example":["image/webp","image/jpeg"],"items":{"type":"string","x-auditable":true},"type":"array","uniqueItems":true},"gif":{"description":"List of strings with the MIME types of all the variants that should be served for gif.","example":["image/webp","image/jpeg"],"items":{"type":"string","x-auditable":true},"type":"array","uniqueItems":true},"jp2":{"description":"List of strings with the MIME types of all the variants that should be served for jp2.","example":["image/webp","image/avif"],"items":{"type":"string","x-auditable":true},"type":"array","uniqueItems":true},"jpeg":{"description":"List of strings with the MIME types of all the variants that should be served for jpeg.","example":["image/webp","image/avif"],"items":{"type":"string","x-auditable":true},"type":"array","uniqueItems":true},"jpg":{"description":"List of strings with the MIME types of all the variants that should be served for jpg.","example":["image/webp","image/avif"],"items":{"type":"string","x-auditable":true},"type":"array","uniqueItems":true},"jpg2":{"description":"List of strings with the MIME types of all the variants that should be served for jpg2.","example":["image/webp","image/avif"],"items":{"type":"string","x-auditable":true},"type":"array","uniqueItems":true},"png":{"description":"List of strings with the MIME types of all the variants that should be served for png.","example":["image/webp","image/avif"],"items":{"type":"string","x-auditable":true},"type":"array","uniqueItems":true},"tif":{"description":"List of strings with the MIME types of all the variants that should be served for tif.","example":["image/webp","image/avif"],"items":{"type":"string","x-auditable":true},"type":"array","uniqueItems":true},"tiff":{"description":"List of strings with the MIME types of all the variants that should be served for tiff.","example":["image/webp","image/avif"],"items":{"type":"string","x-auditable":true},"type":"array","uniqueItems":true},"webp":{"description":"List of strings with the MIME types of all the variants that should be served for webp.","example":["image/jpeg","image/avif"],"items":{"type":"string","x-auditable":true},"type":"array","uniqueItems":true}},"type":"object"},"cache-rules_zone_cache_settings_delete_response_single":{"allOf":[{"$ref":"#/components/schemas/cache-rules_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cache-rules_result-object-delete"}},"type":"object"}],"type":"object"},"cache-rules_zone_cache_settings_response_single":{"allOf":[{"$ref":"#/components/schemas/cache-rules_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cache-rules_result-object"}},"type":"object"}],"type":"object"},"cache_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/cache_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/cache_messages"}],"example":[]},"result":{"$ref":"#/components/schemas/cache_result"},"success":{"description":"Indicates the API call's success or failure.","example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"cache_api-response-single-id":{"properties":{"errors":{"$ref":"#/components/schemas/cache_messages"},"messages":{"$ref":"#/components/schemas/cache_messages"},"result":{"$ref":"#/components/schemas/cache_result"},"success":{"description":"Indicates the API call's success or failure.","example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"cache_identifier":{"example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string"},"cache_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"cache_result":{"properties":{"editable":{"description":"Whether this setting can be updated or not.","readOnly":true,"type":"boolean"},"id":{"example":"ssl_automatic_mode","readOnly":true,"type":"string"},"modified_on":{"description":"Last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"next_scheduled_scan":{"description":"Next time this zone will be scanned by the Automatic SSL/TLS.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"value":{"description":"Current setting of the automatic SSL/TLS.","enum":["auto","custom"],"example":"auto","readOnly":true,"type":"string"}},"required":["id","modified_on","value","editable"],"type":"object"},"cache_schemas_patch":{"description":"Update enablement of Automatic SSL/TLS.","properties":{"value":{"$ref":"#/components/schemas/cache_schemas_value"}},"required":["value"],"type":"object"},"cache_schemas_value":{"description":"Controls enablement of Automatic SSL/TLS.","enum":["auto","custom"],"example":"auto","type":"string"},"calls_account_identifier":{"description":"The account identifier tag.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"calls_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/calls_messages"},"messages":{"$ref":"#/components/schemas/calls_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"calls_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/calls_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/calls_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"calls_api-response-single":{"allOf":[{"$ref":"#/components/schemas/calls_api-response-common"}],"type":"object"},"calls_app":{"properties":{"created":{"$ref":"#/components/schemas/calls_created"},"modified":{"$ref":"#/components/schemas/calls_modified"},"name":{"$ref":"#/components/schemas/calls_name"},"uid":{"$ref":"#/components/schemas/calls_identifier"}},"type":"object"},"calls_app_editable_fields":{"properties":{"name":{"$ref":"#/components/schemas/calls_name"}},"type":"object"},"calls_app_response_collection":{"allOf":[{"$ref":"#/components/schemas/calls_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/calls_app"},"type":"array"}}}]},"calls_app_response_single":{"allOf":[{"$ref":"#/components/schemas/calls_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/calls_app"}}}]},"calls_app_response_single_with_secret":{"allOf":[{"$ref":"#/components/schemas/calls_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/calls_app_with_secret"}}}]},"calls_app_with_secret":{"properties":{"created":{"$ref":"#/components/schemas/calls_created"},"modified":{"$ref":"#/components/schemas/calls_modified"},"name":{"$ref":"#/components/schemas/calls_name"},"secret":{"$ref":"#/components/schemas/calls_secret"},"uid":{"$ref":"#/components/schemas/calls_identifier"}},"type":"object"},"calls_created":{"description":"The date and time the item was created.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string"},"calls_identifier":{"description":"A Cloudflare-generated unique identifier for a item.","example":"2a95132c15732412d22c1476fa83f27a","maxLength":32,"minLength":32,"type":"string","x-auditable":true},"calls_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"calls_modified":{"description":"The date and time the item was last modified.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string"},"calls_name":{"default":"","description":"A short description of Calls app, not shown to end users.","example":"production-realtime-app","type":"string","x-auditable":true},"calls_secret":{"description":"Bearer token","example":"66bcf64aa8907b9f9d90ac17746a77ce394c393b92b3916633dc02846e608ad4","maxLength":64,"minLength":64,"type":"string","x-sensitive":true},"calls_turn_key":{"description":"Bearer token","example":"66bcf64aa8907b9f9d90ac17746a77ce394c393b92b3916633dc02846e608ad4","maxLength":64,"minLength":64,"type":"string","x-sensitive":true},"calls_turn_key_collection":{"allOf":[{"$ref":"#/components/schemas/calls_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/calls_turn_key_object"},"type":"array"}}}]},"calls_turn_key_editable_fields":{"properties":{"name":{"$ref":"#/components/schemas/calls_turn_key_name"}},"type":"object"},"calls_turn_key_name":{"default":"","description":"A short description of a TURN key, not shown to end users.","example":"my-turn-key","type":"string","x-auditable":true},"calls_turn_key_object":{"properties":{"created":{"$ref":"#/components/schemas/calls_created"},"modified":{"$ref":"#/components/schemas/calls_modified"},"name":{"$ref":"#/components/schemas/calls_name"},"uid":{"$ref":"#/components/schemas/calls_identifier"}},"type":"object"},"calls_turn_key_response_collection":{"allOf":[{"$ref":"#/components/schemas/calls_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/calls_turn_key_object"},"type":"array"}}}]},"calls_turn_key_response_single":{"allOf":[{"$ref":"#/components/schemas/calls_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/calls_turn_key_object"}}}]},"calls_turn_key_single_with_secret":{"allOf":[{"$ref":"#/components/schemas/calls_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/calls_turn_key_with_key"}}}]},"calls_turn_key_with_key":{"properties":{"created":{"$ref":"#/components/schemas/calls_created"},"key":{"$ref":"#/components/schemas/calls_turn_key"},"modified":{"$ref":"#/components/schemas/calls_modified"},"name":{"$ref":"#/components/schemas/calls_turn_key_name"},"uid":{"$ref":"#/components/schemas/calls_identifier"}},"type":"object"},"cloud-connector_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/cloud-connector_messages"},"messages":{"$ref":"#/components/schemas/cloud-connector_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"cloud-connector_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/cloud-connector_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/cloud-connector_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"cloud-connector_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"cloud-connector_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"cloud-connector_provider":{"description":"Cloud Provider type","enum":["aws_s3","cloudflare_r2","gcp_storage","azure_storage"],"example":"aws_s3","type":"string","x-auditable":true},"cloud-connector_rule":{"properties":{"description":{"example":"Rule description","type":"string","x-auditable":true},"enabled":{"example":true,"type":"boolean","x-auditable":true},"expression":{"example":"http.cookie eq \"a=b\"","type":"string","x-auditable":true},"id":{"example":"95c365e17e1b46599cd99e5b231fac4e","type":"string","x-auditable":true},"parameters":{"description":"Parameters of Cloud Connector Rule","properties":{"host":{"description":"Host to perform Cloud Connection to","example":"examplebucket.s3.eu-north-1.amazonaws.com","type":"string","x-auditable":true}},"type":"object"},"provider":{"$ref":"#/components/schemas/cloud-connector_provider"}},"type":"object"},"cloud-connector_rules":{"description":"List of Cloud Connector rules","items":{"$ref":"#/components/schemas/cloud-connector_rule"},"type":"array"},"cloud-connector_zone_identifier":{"$ref":"#/components/schemas/cloud-connector_identifier"},"cloudflare-pipelines_ConnectionSchema":{"properties":{"fields":{"items":{"$ref":"#/components/schemas/cloudflare-pipelines_SourceField"},"type":"array"},"format":{"allOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_Format"}]},"inferred":{"nullable":true,"type":"boolean"}},"type":"object"},"cloudflare-pipelines_DecimalEncoding":{"enum":["number","string","bytes"],"type":"string"},"cloudflare-pipelines_FieldType":{"discriminator":{"propertyName":"type"},"oneOf":[{"properties":{"type":{"enum":["int32"],"type":"string"}},"required":["type"],"title":"Int32","type":"object"},{"properties":{"type":{"enum":["int64"],"type":"string"}},"required":["type"],"title":"Int64","type":"object"},{"properties":{"type":{"enum":["float32"],"type":"string"}},"required":["type"],"title":"Float32","type":"object"},{"properties":{"type":{"enum":["float64"],"type":"string"}},"required":["type"],"title":"Float64","type":"object"},{"properties":{"type":{"enum":["bool"],"type":"string"}},"required":["type"],"title":"Bool","type":"object"},{"properties":{"type":{"enum":["string"],"type":"string"}},"required":["type"],"title":"String","type":"object"},{"properties":{"type":{"enum":["binary"],"type":"string"}},"required":["type"],"title":"Binary","type":"object"},{"allOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_TimestampField"},{"properties":{"type":{"enum":["timestamp"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Timestamp"},{"properties":{"type":{"enum":["json"],"type":"string"}},"required":["type"],"title":"Json","type":"object"},{"allOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_StructField"},{"properties":{"type":{"enum":["struct"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Struct"},{"allOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_ListField"},{"properties":{"type":{"enum":["list"],"type":"string"}},"required":["type"],"type":"object"}],"title":"List"}]},"cloudflare-pipelines_Format":{"discriminator":{"propertyName":"type"},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_JsonFormat"},{"properties":{"type":{"enum":["json"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Json"},{"allOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_ParquetFormat"},{"properties":{"type":{"enum":["parquet"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Parquet"}]},"cloudflare-pipelines_JsonFormat":{"properties":{"decimal_encoding":{"$ref":"#/components/schemas/cloudflare-pipelines_DecimalEncoding"},"timestamp_format":{"$ref":"#/components/schemas/cloudflare-pipelines_TimestampFormat"},"unstructured":{"type":"boolean"}},"type":"object"},"cloudflare-pipelines_ListField":{"properties":{"items":{"$ref":"#/components/schemas/cloudflare-pipelines_SourceField"}},"required":["items"],"type":"object"},"cloudflare-pipelines_ParquetCompression":{"enum":["uncompressed","snappy","gzip","zstd","lz4"],"type":"string"},"cloudflare-pipelines_ParquetFormat":{"properties":{"compression":{"$ref":"#/components/schemas/cloudflare-pipelines_ParquetCompression"},"row_group_bytes":{"format":"int64","minimum":0,"nullable":true,"type":"integer"}},"type":"object"},"cloudflare-pipelines_PipelineEdge":{"properties":{"dest_id":{"format":"int32","minimum":0,"type":"integer"},"edge_type":{"type":"string"},"key_type":{"type":"string"},"src_id":{"format":"int32","minimum":0,"type":"integer"},"value_type":{"type":"string"}},"required":["src_id","dest_id","key_type","value_type","edge_type"],"type":"object"},"cloudflare-pipelines_PipelineGraph":{"properties":{"edges":{"items":{"$ref":"#/components/schemas/cloudflare-pipelines_PipelineEdge"},"type":"array"},"nodes":{"items":{"$ref":"#/components/schemas/cloudflare-pipelines_PipelineNode"},"type":"array"}},"required":["nodes","edges"],"type":"object"},"cloudflare-pipelines_PipelineNode":{"properties":{"description":{"type":"string"},"node_id":{"format":"int32","minimum":0,"type":"integer"},"operator":{"type":"string"},"parallelism":{"format":"int32","minimum":0,"type":"integer"}},"required":["node_id","operator","description","parallelism"],"type":"object"},"cloudflare-pipelines_SourceField":{"allOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_FieldType"},{"properties":{"metadata_key":{"nullable":true,"type":"string"},"name":{"type":"string"},"required":{"type":"boolean"},"sql_name":{"type":"string"}},"required":["name"],"type":"object"}]},"cloudflare-pipelines_StructField":{"properties":{"fields":{"items":{"$ref":"#/components/schemas/cloudflare-pipelines_SourceField"},"type":"array"},"name":{"nullable":true,"type":"string"}},"required":["fields"],"type":"object"},"cloudflare-pipelines_TimestampField":{"properties":{"unit":{"$ref":"#/components/schemas/cloudflare-pipelines_TimestampUnit"}},"type":"object"},"cloudflare-pipelines_TimestampFormat":{"enum":["rfc3339","unix_millis"],"type":"string"},"cloudflare-pipelines_TimestampUnit":{"enum":["second","millisecond","microsecond","nanosecond"],"type":"string"},"cloudflare-pipelines_r2Table":{"additionalProperties":false,"properties":{"account_id":{"description":"Cloudflare Account ID for the bucket","title":"Account ID","type":"string"},"bucket":{"description":"R2 Bucket to write to","title":"Bucket","type":"string"},"credentials":{"additionalProperties":false,"properties":{"access_key_id":{"description":"Cloudflare Account ID for the bucket","format":"var-str","title":"Access Key ID","type":"string"},"secret_access_key":{"description":"Cloudflare Account ID for the bucket","format":"var-str","title":"Access Key ID","type":"string"}},"required":["access_key_id","secret_access_key"],"title":"R2 Credentials","type":"object"},"file_naming":{"additionalProperties":false,"description":"Controls filename prefix/suffix and strategy.","properties":{"prefix":{"description":"The prefix to use in file name. i.e prefix-\u003cuuid\u003e.parquet","title":"Filename Prefix","type":"string"},"strategy":{"description":"Filename generation strategy.","enum":["serial","uuid","uuid_v7","ulid"],"title":"Filename Strategy","type":"string"},"suffix":{"description":"This will overwrite the default file suffix. i.e .parquet, use with caution","title":"Filename Suffix","type":"string"}},"title":"File Naming","type":"object"},"jurisdiction":{"description":"Jurisdiction this bucket is hosted in","title":"Jurisdiction","type":"string"},"partitioning":{"additionalProperties":false,"description":"Data-layout partitioning for sinks.","properties":{"time_pattern":{"description":"The pattern of the date string","example":"year=%Y/month=%m/day=%d/hour=%H","title":"Time Partition Pattern","type":"string"}},"title":"Partitioning Configuration","type":"object"},"path":{"description":"Subpath within the bucket to write to","title":"Path","type":"string"},"rolling_policy":{"additionalProperties":false,"description":"Rolling policy for file sinks (when \u0026 why to close a file and open a new one).","properties":{"file_size_bytes":{"description":"Files will be rolled after reaching this number of bytes","format":"uint64","minimum":0,"title":"File Size","type":"integer"},"inactivity_seconds":{"description":"Number of seconds of inactivity to wait before rolling over to a new file","format":"uint64","minimum":1,"title":"Inactivity Seconds","type":"integer"},"interval_seconds":{"description":"Number of seconds to wait before rolling over to a new file","format":"uint64","minimum":1,"title":"Interval Seconds","type":"integer"}},"title":"File Rolling Policy","type":"object"}},"required":["account_id","bucket","credentials"],"title":"R2 Sink","type":"object"},"cloudflare-pipelines_r2_data_catalogTable":{"additionalProperties":false,"description":"R2 Data Catalog Sink","properties":{"account_id":{"description":"Cloudflare Account ID","example":"6791973bbe876d621f9e557f891e90b3","format":"uri","type":"string"},"bucket":{"description":"The R2 Bucket that hosts this catalog","example":"my-bucket","type":"string"},"namespace":{"description":"Table namespace","title":"Namespace","type":"string"},"rolling_policy":{"additionalProperties":false,"description":"Rolling policy for file sinks (when \u0026 why to close a file and open a new one).","properties":{"file_size_bytes":{"description":"Files will be rolled after reaching this number of bytes","format":"uint64","minimum":0,"title":"File Size","type":"integer"},"inactivity_seconds":{"description":"Number of seconds of inactivity to wait before rolling over to a new file","format":"uint64","minimum":1,"title":"Inactivity Seconds","type":"integer"},"interval_seconds":{"description":"Number of seconds to wait before rolling over to a new file","format":"uint64","minimum":1,"title":"Interval Seconds","type":"integer"}},"title":"File Rolling Policy","type":"object"},"table_name":{"description":"Table name","title":"Table Name","type":"string"},"token":{"description":"Authentication token","example":"\"asdfkj2h34kjhkj\"","format":"var-str","type":"string"}},"required":["account_id","bucket","token","table_name"],"title":"R2DataCatalogSinkTable","type":"object"},"cloudflare-pipelines_worker-pipelines-common-success":{"description":"Indicates whether the API call was successful.","example":true,"type":"boolean"},"cloudflare-pipelines_workers-pipelines-account-id":{"description":"Specifies the public ID of the account.","example":"0123105f4ecef8ad9ca31a8372d0c353","type":"string"},"cloudflare-pipelines_workers-pipelines-pipeline":{"deprecated":true,"description":"[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.","properties":{"destination":{"properties":{"batch":{"properties":{"max_bytes":{"default":100000000,"description":"Specifies rough maximum size of files.","maximum":100000000,"minimum":1000,"type":"integer"},"max_duration_s":{"default":300,"description":"Specifies duration to wait to aggregate batches files.","maximum":300,"minimum":0.25,"type":"number"},"max_rows":{"default":10000000,"description":"Specifies rough maximum number of rows per file.","maximum":10000000,"minimum":100,"type":"integer"}},"required":["max_rows","max_bytes","max_duration_s"],"type":"object"},"compression":{"properties":{"type":{"default":"gzip","description":"Specifies the desired compression algorithm and format.","enum":["none","gzip","deflate"],"example":"gzip","type":"string"}},"required":["type"],"type":"object"},"format":{"description":"Specifies the format of data to deliver.","enum":["json"],"type":"string"},"path":{"example":{"bucket":"bucket","prefix":"base"},"properties":{"bucket":{"description":"Specifies the R2 Bucket to store files.","example":"bucket","type":"string"},"filename":{"allOf":[{"type":"string"},{"type":"string"}],"description":"Specifies the name pattern to for individual data files.","example":"${slug}${extension}"},"filepath":{"description":"Specifies the name pattern for directory.","example":"${date}/${hour}","type":"string"},"prefix":{"description":"Specifies the base directory within the bucket.","example":"base","type":"string"}},"required":["bucket"],"type":"object"},"type":{"description":"Specifies the type of destination.","enum":["r2"],"type":"string"}},"required":["type","format","batch","compression","path"],"type":"object"},"endpoint":{"description":"Indicates the endpoint URL to send traffic.","example":"https://123f8a8258064ed892a347f173372359.pipelines.cloudflare.com","type":"string"},"id":{"description":"Specifies the pipeline identifier.","example":"123f8a8258064ed892a347f173372359","type":"string"},"name":{"description":"Defines the name of the pipeline.","example":"sample_pipeline","maxLength":128,"minLength":1,"type":"string"},"source":{"items":{"discriminator":{"mapping":{"binding":"#/components/schemas/cloudflare-pipelines_workers_pipelines_binding_source","http":"#/components/schemas/cloudflare-pipelines_workers_pipelines_http_source"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_workers_pipelines_http_source"},{"$ref":"#/components/schemas/cloudflare-pipelines_workers_pipelines_binding_source"}]},"minItems":1,"type":"array"},"version":{"description":"Indicates the version number of last saved configuration.","example":2,"type":"number"}},"required":["name","source","destination","id","version","endpoint"],"type":"object"},"cloudflare-pipelines_workers-pipelines-pipeline-id":{"description":"Specifies the public ID of the pipeline.","example":"043e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"minLength":32,"type":"string"},"cloudflare-pipelines_workers-pipelines-sink-id":{"description":"Specifies the publid ID of the sink.","example":"0223105f4ecef8ad9ca31a8372d0c353","maxLength":32,"minLength":32,"type":"string"},"cloudflare-pipelines_workers-pipelines-stream-id":{"description":"Specifies the public ID of the stream.","example":"033e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"minLength":32,"type":"string"},"cloudflare-pipelines_workers_pipelines_binding_source":{"deprecated":true,"description":"[DEPRECATED] Worker binding source configuration. Use the new streams API instead.","properties":{"format":{"description":"Specifies the format of source data.","enum":["json"],"type":"string"},"type":{"type":"string"}},"required":["type","format"],"type":"object"},"cloudflare-pipelines_workers_pipelines_http_source":{"deprecated":true,"description":"[DEPRECATED] HTTP source configuration. Use the new streams API instead.","properties":{"authentication":{"description":"Specifies whether authentication is required to send to this pipeline via HTTP.","type":"boolean"},"cors":{"properties":{"origins":{"description":"Specifies allowed origins to allow Cross Origin HTTP Requests.","example":["*"],"items":{"type":"string"},"maxItems":5,"type":"array"}},"type":"object"},"format":{"description":"Specifies the format of source data.","enum":["json"],"type":"string"},"type":{"type":"string"}},"required":["type","format"],"type":"object"},"cloudforce-one-port-scan-api_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_messages"},"messages":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"cloudforce-one-port-scan-api_api-response-common-failure":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_api-response-common"},{"properties":{"errors":{"example":{"code":10433,"message":"request error"},"type":"object"},"success":{"example":false,"type":"boolean"}}}]},"cloudforce-one-port-scan-api_frequency":{"description":"Defines the number of days between each scan (0 = One-off scan).","example":7,"title":"Frequency","type":"number"},"cloudforce-one-port-scan-api_ips":{"description":"Defines a list of IP addresses or CIDR blocks to scan. The maximum number of total IP addresses allowed is 5000.","example":["1.1.1.1","2606:4700:4700::1111"],"items":{"description":"Defines a list of IP addresses or CIDR blocks to scan. The maximum number of total IP addresses allowed is 5000.","type":"string"},"title":"IP List","type":"array"},"cloudforce-one-port-scan-api_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"cloudforce-one-port-scan-api_port":{"properties":{"number":{"example":8080,"type":"number"},"proto":{"example":"tcp","type":"string"},"status":{"example":"open","type":"string"}},"required":["account_id","ips","frequency"],"title":"Port","type":"object"},"cloudforce-one-port-scan-api_ports":{"description":"Defines a list of ports to scan. Valid values are:\"default\", \"all\", or a comma-separated list of ports or range of ports (e.g. [\"1-80\", \"443\"]). \"default\" scans the 100 most commonly open ports.","example":["default"],"items":{"description":"Defines a list of ports to scan. Valid values are:\"default\", \"all\", or a comma-separated list of ports or range of ports (e.g. [\"1-80\", \"443\"]). \"default\" scans the 100 most commonly open ports.","type":"string"},"title":"Port List","type":"array"},"cloudforce-one-port-scan-api_scan-config":{"properties":{"account_id":{"example":"abcd1234abcd1234abcd1234abcd1234","type":"string"},"frequency":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_frequency"},"id":{"description":"Defines the Config ID.","example":"uuid","type":"string"},"ips":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_ips"},"ports":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_ports"}},"required":["id","account_id","ips","frequency","ports"],"title":"Config","type":"object"},"cloudforce-one-requests_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/cloudforce-one-requests_messages"},"messages":{"$ref":"#/components/schemas/cloudforce-one-requests_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"cloudforce-one-requests_api-response-common-failure":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"errors":{"properties":{"code":{"example":10433,"type":"integer"},"message":{"example":"request error","type":"string"}},"type":"object"},"success":{"example":false,"type":"boolean"}},"type":"object"}]},"cloudforce-one-requests_asset-content":{"description":"Asset file to upload.","example":"@/Users/me/example.docx","type":"string"},"cloudforce-one-requests_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string"},"cloudforce-one-requests_labels":{"description":"List of labels.","example":["DoS","CVE"],"items":{"type":"string"},"title":"Labels","type":"array","x-auditable":true},"cloudforce-one-requests_message-content":{"description":"Content of message.","example":"Can you elaborate on the type of DoS that occurred?","type":"string","x-auditable":true},"cloudforce-one-requests_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"cloudforce-one-requests_priority":{"enum":["routine","high","urgent"],"title":"Request Priority","type":"string","x-auditable":true},"cloudforce-one-requests_priority-edit":{"properties":{"labels":{"$ref":"#/components/schemas/cloudforce-one-requests_labels"},"priority":{"description":"Priority.","example":1,"type":"integer","x-auditable":true},"requirement":{"description":"Requirement.","example":"DoS attacks carried out by CVEs","type":"string","x-auditable":true},"tlp":{"$ref":"#/components/schemas/cloudforce-one-requests_tlp"}},"required":["labels","priority","requirement","tlp"],"title":"Priority Editable Attributes","type":"object"},"cloudforce-one-requests_priority-item":{"properties":{"created":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Priority creation time."},"id":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"},"labels":{"$ref":"#/components/schemas/cloudforce-one-requests_labels"},"priority":{"description":"Priority.","example":1,"type":"integer","x-auditable":true},"requirement":{"description":"Requirement.","example":"DoS attacks carried out by CVEs","type":"string","x-auditable":true},"tlp":{"$ref":"#/components/schemas/cloudforce-one-requests_tlp"},"updated":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Priority last updated time."}},"required":["id","created","updated","labels","priority","requirement","tlp"],"title":"Priority Item","type":"object"},"cloudforce-one-requests_priority-list":{"properties":{"page":{"description":"Page number of results.","type":"integer"},"per_page":{"description":"Number of results per page.","example":10,"type":"integer"}},"required":["page","per_page"],"title":"Priority List Parameters","type":"object"},"cloudforce-one-requests_quota":{"properties":{"anniversary_date":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Anniversary date is when annual quota limit is refreshed.","example":"2022-04-01T00:00:00Z"},"quarter_anniversary_date":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Quarter anniversary date is when quota limit is refreshed each quarter.","example":"2022-04-01T00:00:00Z"},"quota":{"description":"Tokens for the quarter.","example":120,"type":"integer","x-auditable":true},"remaining":{"description":"Tokens remaining for the quarter.","example":64,"type":"integer","x-auditable":true}},"title":"Quota","type":"object"},"cloudforce-one-requests_request-asset-edit":{"properties":{"source":{"$ref":"#/components/schemas/cloudforce-one-requests_asset-content"}},"title":"Request Asset Editable Attributes","type":"object"},"cloudforce-one-requests_request-asset-item":{"properties":{"created":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Defines the asset creation time.","example":"2022-01-01T00:00:00Z"},"description":{"description":"Asset description.","example":"example description","type":"string","x-auditable":true},"file_type":{"description":"Asset file type.","example":"docx","type":"string","x-auditable":true},"id":{"description":"Asset ID.","type":"integer","x-auditable":true},"name":{"description":"Asset name.","example":"example.docx","type":"string","x-auditable":true}},"required":["id","name"],"title":"Request Asset Item","type":"object"},"cloudforce-one-requests_request-asset-list":{"properties":{"page":{"description":"Page number of results.","type":"integer"},"per_page":{"description":"Number of results per page.","example":10,"type":"integer"}},"required":["page","per_page"],"title":"Request Asset List Parameters","type":"object"},"cloudforce-one-requests_request-constants":{"properties":{"priority":{"example":["routine","high","urgent"],"items":{"$ref":"#/components/schemas/cloudforce-one-requests_priority"},"type":"array"},"status":{"example":["open","accepted","reported","approved","completed","declined"],"items":{"$ref":"#/components/schemas/cloudforce-one-requests_request-status"},"type":"array"},"tlp":{"example":["clear","green","amber","amber-strict","red"],"items":{"$ref":"#/components/schemas/cloudforce-one-requests_tlp"},"type":"array"}},"title":"Request Constants","type":"object"},"cloudforce-one-requests_request-content":{"description":"Request content.","example":"What regions were most effected by the recent DoS?","type":"string"},"cloudforce-one-requests_request-edit":{"properties":{"content":{"$ref":"#/components/schemas/cloudforce-one-requests_request-content"},"priority":{"description":"Priority for analyzing the request.","example":"routine","type":"string","x-auditable":true},"request_type":{"$ref":"#/components/schemas/cloudforce-one-requests_request-type"},"summary":{"$ref":"#/components/schemas/cloudforce-one-requests_request-summary"},"tlp":{"$ref":"#/components/schemas/cloudforce-one-requests_tlp"}},"title":"Request Editable Parameters","type":"object"},"cloudforce-one-requests_request-item":{"properties":{"completed":{"$ref":"#/components/schemas/cloudforce-one-requests_time"},"content":{"$ref":"#/components/schemas/cloudforce-one-requests_request-content"},"created":{"$ref":"#/components/schemas/cloudforce-one-requests_time"},"id":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"},"message_tokens":{"description":"Tokens for the request messages.","example":1,"type":"integer","x-auditable":true},"priority":{"$ref":"#/components/schemas/cloudforce-one-requests_time"},"readable_id":{"$ref":"#/components/schemas/cloudforce-one-requests_request-readable-id"},"request":{"$ref":"#/components/schemas/cloudforce-one-requests_request-type"},"status":{"$ref":"#/components/schemas/cloudforce-one-requests_request-status"},"summary":{"$ref":"#/components/schemas/cloudforce-one-requests_request-summary"},"tlp":{"$ref":"#/components/schemas/cloudforce-one-requests_tlp"},"tokens":{"description":"Tokens for the request.","example":16,"type":"integer","x-auditable":true},"updated":{"$ref":"#/components/schemas/cloudforce-one-requests_time"}},"required":["id","created","updated","content","priority","request","summary","tlp"],"title":"Request Item","type":"object"},"cloudforce-one-requests_request-list":{"properties":{"completed_after":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Retrieve requests completed after this time.","example":"2022-01-01T00:00:00Z"},"completed_before":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Retrieve requests completed before this time.","example":"2024-01-01T00:00:00Z"},"created_after":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Retrieve requests created after this time.","example":"2022-01-01T00:00:00Z"},"created_before":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Retrieve requests created before this time.","example":"2024-01-01T00:00:00Z"},"page":{"description":"Page number of results.","type":"integer"},"per_page":{"description":"Number of results per page.","example":10,"type":"integer"},"request_type":{"$ref":"#/components/schemas/cloudforce-one-requests_request-type"},"sort_by":{"description":"Field to sort results by.","example":"created","type":"string"},"sort_order":{"description":"Sort order (asc or desc).","enum":["asc","desc"],"type":"string"},"status":{"$ref":"#/components/schemas/cloudforce-one-requests_request-status"}},"required":["page","per_page"],"title":"Request List Parameters","type":"object"},"cloudforce-one-requests_request-list-item":{"properties":{"completed":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Request completion time.","example":"2024-01-01T00:00:00Z"},"created":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Request creation time.","example":"2022-04-01T00:00:00Z"},"id":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"},"message_tokens":{"description":"Tokens for the request messages.","example":16,"type":"integer","x-auditable":true},"priority":{"$ref":"#/components/schemas/cloudforce-one-requests_priority"},"readable_id":{"$ref":"#/components/schemas/cloudforce-one-requests_request-readable-id"},"request":{"$ref":"#/components/schemas/cloudforce-one-requests_request-type"},"status":{"$ref":"#/components/schemas/cloudforce-one-requests_request-status"},"summary":{"$ref":"#/components/schemas/cloudforce-one-requests_request-summary"},"tlp":{"$ref":"#/components/schemas/cloudforce-one-requests_tlp"},"tokens":{"description":"Tokens for the request.","type":"integer","x-auditable":true},"updated":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Request last updated time.","example":"2022-04-01T00:00:00Z"}},"required":["id","created","updated","priority","request","summary","tlp"],"title":"Request List Item","type":"object"},"cloudforce-one-requests_request-message-edit":{"properties":{"content":{"$ref":"#/components/schemas/cloudforce-one-requests_message-content"}},"title":"Request Message Editable Attributes","type":"object"},"cloudforce-one-requests_request-message-item":{"properties":{"author":{"description":"Author of message.","example":"user@domain.com","type":"string","x-auditable":true},"content":{"$ref":"#/components/schemas/cloudforce-one-requests_message-content"},"created":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Defines the message creation time.","example":"2022-01-01T00:00:00Z"},"id":{"description":"Message ID.","type":"integer","x-auditable":true},"is_follow_on_request":{"description":"Whether the message is a follow-on request.","type":"boolean","x-auditable":true},"updated":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Defines the message last updated time.","example":"2022-01-01T00:00:00Z"}},"required":["id","updated","content","author","is_follow_on_request"],"title":"Request Message Item","type":"object"},"cloudforce-one-requests_request-message-list":{"properties":{"after":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Retrieve mes  ges created after this time.","example":"2022-01-01T00:00:Z"},"before":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_time"}],"description":"Retrieve messages created before this time.","example":"2024-01-01T00:00:00Z"},"page":{"description":"Page number of results.","type":"integer"},"per_page":{"description":"Number of results per page.","example":10,"type":"integer"},"sort_by":{"description":"Field to sort results by.","example":"created","type":"string"},"sort_order":{"description":"Sort order (asc or desc).","enum":["asc","desc"],"type":"string"}},"required":["page","per_page"],"title":"Request Message List Parameters","type":"object"},"cloudforce-one-requests_request-readable-id":{"description":"Readable Request ID.","example":"RFI-2022-000001","title":"Request Readable ID","type":"string","x-auditable":true},"cloudforce-one-requests_request-status":{"description":"Request Status.","enum":["open","accepted","reported","approved","completed","declined"],"title":"Request Status","type":"string","x-auditable":true},"cloudforce-one-requests_request-summary":{"description":"Brief description of the request.","example":"DoS attack","type":"string","x-auditable":true},"cloudforce-one-requests_request-type":{"description":"Requested information from request.","example":"Victomology","type":"string","x-auditable":true},"cloudforce-one-requests_request-types":{"example":["Indicators of Compromise","Victomology"],"items":{"description":"Request Types.","type":"string","x-auditable":true},"title":"Request Types","type":"array"},"cloudforce-one-requests_time":{"example":"2022-04-01T05:20:00Z","format":"date-time","type":"string","x-auditable":true},"cloudforce-one-requests_tlp":{"description":"The CISA defined Traffic Light Protocol (TLP).","enum":["clear","amber","amber-strict","green","red"],"title":"TLP","type":"string","x-auditable":true},"cloudforce-one-requests_uuid":{"description":"UUID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string"},"cloudforce-one-whois_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/cloudforce-one-whois_schemas-messages"},"messages":{"$ref":"#/components/schemas/cloudforce-one-whois_schemas-messages"},"success":{"description":"Returns a boolean for the success/failure of the API call.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"cloudforce-one-whois_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-whois_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-whois_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Returns a boolean for the success/failure of the API call.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"cloudforce-one-whois_api-response-single":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-whois_api-response-common"}],"type":"object"},"cloudforce-one-whois_domain_name":{"example":"cloudflare.com","type":"string"},"cloudforce-one-whois_identifier":{"description":"Use to uniquely identify or reference the resource.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"cloudforce-one-whois_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"cloudforce-one-whois_schemas-messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"cloudforce-one-whois_schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-whois_api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-whois_whois"}]}},"type":"object"}]},"cloudforce-one-whois_whois":{"properties":{"administrative_city":{"type":"string"},"administrative_country":{"type":"string"},"administrative_email":{"type":"string"},"administrative_fax":{"type":"string"},"administrative_fax_ext":{"type":"string"},"administrative_id":{"type":"string"},"administrative_name":{"type":"string"},"administrative_org":{"type":"string"},"administrative_phone":{"type":"string"},"administrative_phone_ext":{"type":"string"},"administrative_postal_code":{"type":"string"},"administrative_province":{"type":"string"},"administrative_referral_url":{"type":"string"},"administrative_street":{"type":"string"},"billing_city":{"type":"string"},"billing_country":{"type":"string"},"billing_email":{"type":"string"},"billing_fax":{"type":"string"},"billing_fax_ext":{"type":"string"},"billing_id":{"type":"string"},"billing_name":{"type":"string"},"billing_org":{"type":"string"},"billing_phone":{"type":"string"},"billing_phone_ext":{"type":"string"},"billing_postal_code":{"type":"string"},"billing_province":{"type":"string"},"billing_referral_url":{"type":"string"},"billing_street":{"type":"string"},"created_date":{"example":"2009-02-17T22:07:54.000Z","format":"date-time","type":"string"},"created_date_raw":{"example":"2009-02-17T22:07:54Z","type":"string"},"dnssec":{"example":true,"type":"boolean"},"domain":{"$ref":"#/components/schemas/cloudforce-one-whois_domain_name"},"expiration_date":{"example":"2033-02-17T22:07:54.000Z","format":"date-time","type":"string"},"expiration_date_raw":{"example":"2033-02-17T22:07:54Z","type":"string"},"extension":{"example":"com","type":"string"},"found":{"example":true,"type":"boolean"},"id":{"example":"1542998887_DOMAIN_COM-VRSN","type":"string"},"nameservers":{"example":["ns3.cloudflare.com","ns4.cloudflare.com","ns5.cloudflare.com","ns6.cloudflare.com","ns7.cloudflare.com"],"items":{"type":"string"},"type":"array"},"punycode":{"example":"cloudflare.com","type":"string"},"registrant":{"type":"string"},"registrant_city":{"type":"string"},"registrant_country":{"type":"string"},"registrant_email":{"type":"string"},"registrant_fax":{"type":"string"},"registrant_fax_ext":{"type":"string"},"registrant_id":{"type":"string"},"registrant_name":{"type":"string"},"registrant_org":{"type":"string"},"registrant_phone":{"type":"string"},"registrant_phone_ext":{"type":"string"},"registrant_postal_code":{"type":"string"},"registrant_province":{"type":"string"},"registrant_referral_url":{"type":"string"},"registrant_street":{"type":"string"},"registrar":{"example":"Cloudflare, Inc.","type":"string"},"registrar_city":{"type":"string"},"registrar_country":{"type":"string"},"registrar_email":{"type":"string"},"registrar_fax":{"type":"string"},"registrar_fax_ext":{"type":"string"},"registrar_id":{"type":"string"},"registrar_name":{"type":"string"},"registrar_org":{"type":"string"},"registrar_phone":{"type":"string"},"registrar_phone_ext":{"type":"string"},"registrar_postal_code":{"type":"string"},"registrar_province":{"type":"string"},"registrar_referral_url":{"type":"string"},"registrar_street":{"type":"string"},"status":{"example":["clientdeleteprohibited","clienttransferprohibited","clientupdateprohibited","serverdeleteprohibited","servertransferprohibited","serverupdateprohibited"],"items":{"type":"string"},"type":"array"},"technical_city":{"type":"string"},"technical_country":{"type":"string"},"technical_email":{"type":"string"},"technical_fax":{"type":"string"},"technical_fax_ext":{"type":"string"},"technical_id":{"type":"string"},"technical_name":{"type":"string"},"technical_org":{"type":"string"},"technical_phone":{"type":"string"},"technical_phone_ext":{"type":"string"},"technical_postal_code":{"type":"string"},"technical_province":{"type":"string"},"technical_referral_url":{"type":"string"},"technical_street":{"type":"string"},"updated_date":{"example":"2024-01-09T16:45:28.000Z","format":"date-time","type":"string"},"updated_date_raw":{"example":"2024-01-09T16:45:28Z","type":"string"},"whois_server":{"example":"whois.cloudflare.com","type":"string"}},"required":["found","domain","dnssec","extension","nameservers","punycode","registrar","registrant"],"type":"object"},"custom-indicator-feeds_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/custom-indicator-feeds_schemas-messages"},"messages":{"$ref":"#/components/schemas/custom-indicator-feeds_schemas-messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"custom-indicator-feeds_api-response-single":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_api-response-common"}],"type":"object"},"custom-indicator-feeds_api_response_common_failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"custom-indicator-feeds_create_feed":{"example":{"description":"example feed description","name":"example_feed_1"},"properties":{"description":{"$ref":"#/components/schemas/custom-indicator-feeds_description"},"name":{"$ref":"#/components/schemas/custom-indicator-feeds_name"}}},"custom-indicator-feeds_create_feed_response":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/custom-indicator-feeds_indicator_feed_item"}}}]},"custom-indicator-feeds_description":{"description":"The description of the example test","type":"string","x-auditable":true},"custom-indicator-feeds_feed_id":{"description":"Indicator feed ID","example":12,"type":"integer","x-auditable":true},"custom-indicator-feeds_id":{"description":"The unique identifier for the indicator feed","type":"integer","x-auditable":true},"custom-indicator-feeds_identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"custom-indicator-feeds_indicator_feed_item":{"example":{"created_on":"2023-05-12T12:21:56.777653Z","description":"example feed description","id":1,"is_attributable":false,"is_downloadable":false,"is_public":false,"modified_on":"2023-06-18T03:13:34.123321Z","name":"example_feed_1"},"properties":{"created_on":{"description":"The date and time when the data entry was created","format":"date-time","type":"string","x-auditable":true},"description":{"$ref":"#/components/schemas/custom-indicator-feeds_description"},"id":{"$ref":"#/components/schemas/custom-indicator-feeds_id"},"is_attributable":{"$ref":"#/components/schemas/custom-indicator-feeds_is_attributable"},"is_downloadable":{"$ref":"#/components/schemas/custom-indicator-feeds_is_downloadable"},"is_public":{"$ref":"#/components/schemas/custom-indicator-feeds_is_public"},"modified_on":{"description":"The date and time when the data entry was last modified","format":"date-time","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/custom-indicator-feeds_name"}}},"custom-indicator-feeds_indicator_feed_metadata":{"example":{"created_on":"2023-05-12T12:21:56.777653Z","description":"example feed description","id":1,"is_attributable":false,"is_downloadable":false,"is_public":false,"latest_upload_status":"Complete","modified_on":"2023-06-18T03:13:34.123321Z","name":"example_feed_1"},"properties":{"created_on":{"description":"The date and time when the data entry was created","format":"date-time","type":"string","x-auditable":true},"description":{"$ref":"#/components/schemas/custom-indicator-feeds_description"},"id":{"$ref":"#/components/schemas/custom-indicator-feeds_id"},"is_attributable":{"$ref":"#/components/schemas/custom-indicator-feeds_is_attributable"},"is_downloadable":{"$ref":"#/components/schemas/custom-indicator-feeds_is_downloadable"},"is_public":{"$ref":"#/components/schemas/custom-indicator-feeds_is_public"},"latest_upload_status":{"description":"Status of the latest snapshot uploaded","enum":["Mirroring","Unifying","Loading","Provisioning","Complete","Error"],"type":"string","x-auditable":true},"modified_on":{"description":"The date and time when the data entry was last modified","format":"date-time","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/custom-indicator-feeds_name"},"provider_id":{"$ref":"#/components/schemas/custom-indicator-feeds_provider_id"},"provider_name":{"$ref":"#/components/schemas/custom-indicator-feeds_provider_name"}}},"custom-indicator-feeds_indicator_feed_metadata_response":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/custom-indicator-feeds_indicator_feed_metadata"}}}]},"custom-indicator-feeds_indicator_feed_response":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_api-response-common"},{"properties":{"result":{"example":[{"created_on":"2023-05-12T12:21:56.777653Z","description":"user specified description 1","id":1,"modified_on":"2023-06-18T03:13:34.123321Z","name":"user_specified_name_1"},{"created_on":"2023-05-21T21:43:52.867525Z","description":"User specified description 2","id":2,"modified_on":"2023-06-28T18:46:18.764425Z","name":"user_specified_name_2"}],"items":{"$ref":"#/components/schemas/custom-indicator-feeds_indicator_feed_item"},"type":"array"}}}]},"custom-indicator-feeds_indicator_feed_response_single":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/custom-indicator-feeds_indicator_feed_item"}}}]},"custom-indicator-feeds_is_attributable":{"description":"Whether the indicator feed can be attributed to a provider","type":"boolean","x-auditable":true},"custom-indicator-feeds_is_downloadable":{"description":"Whether the indicator feed can be downloaded","type":"boolean","x-auditable":true},"custom-indicator-feeds_is_public":{"description":"Whether the indicator feed is exposed to customers","type":"boolean","x-auditable":true},"custom-indicator-feeds_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"custom-indicator-feeds_name":{"description":"The name of the indicator feed","type":"string","x-auditable":true},"custom-indicator-feeds_permission_list_item":{"properties":{"description":{"$ref":"#/components/schemas/custom-indicator-feeds_description"},"id":{"$ref":"#/components/schemas/custom-indicator-feeds_id"},"is_attributable":{"$ref":"#/components/schemas/custom-indicator-feeds_is_attributable"},"is_downloadable":{"$ref":"#/components/schemas/custom-indicator-feeds_is_downloadable"},"is_public":{"$ref":"#/components/schemas/custom-indicator-feeds_is_public"},"name":{"$ref":"#/components/schemas/custom-indicator-feeds_name"}}},"custom-indicator-feeds_permission_list_item_response":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_api-response-common"},{"properties":{"result":{"example":[{"description":"An important indicator list","id":1,"is_attributable":false,"is_downloadable":false,"is_public":false,"name":"indicator_list_1"},{"description":"An even more important indicator list","id":2,"is_attributable":true,"is_downloadable":false,"is_public":true,"name":"indicator_list_2"}],"items":{"$ref":"#/components/schemas/custom-indicator-feeds_permission_list_item"},"type":"array"}}}]},"custom-indicator-feeds_permissions_request":{"properties":{"account_tag":{"description":"The Cloudflare account tag of the account to change permissions on","example":"823f45f16fd2f7e21e1e054aga4d2859","type":"string","x-auditable":true},"feed_id":{"description":"The ID of the feed to add/remove permissions on","example":1,"type":"integer","x-auditable":true}}},"custom-indicator-feeds_permissions_response":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/custom-indicator-feeds_permissions_update"}}}]},"custom-indicator-feeds_permissions_update":{"properties":{"success":{"description":"Whether the update succeeded or not","type":"boolean","x-auditable":true}}},"custom-indicator-feeds_provider_id":{"description":"The unique identifier for the provider","type":"string","x-auditable":true},"custom-indicator-feeds_provider_name":{"description":"The provider of the indicator feed","type":"string","x-auditable":true},"custom-indicator-feeds_schemas-messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"custom-indicator-feeds_update_feed":{"properties":{"file_id":{"description":"Feed id","example":1,"type":"integer","x-auditable":true},"filename":{"description":"Name of the file unified in our system","example":"snapshot_file.unified","type":"string","x-auditable":true},"status":{"description":"Current status of upload, should be unified","example":"unified","type":"string","x-auditable":true}}},"custom-indicator-feeds_update_feed_response":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/custom-indicator-feeds_update_feed"}}}]},"custom-indicator-feeds_update_public_field_request":{"properties":{"description":{"description":"The new description of the feed","example":"This is an example description","type":"string","x-auditable":true},"is_attributable":{"description":"The new is_attributable value of the feed","example":true,"type":"boolean","x-auditable":true},"is_downloadable":{"description":"The new is_downloadable value of the feed","example":true,"type":"boolean","x-auditable":true},"is_public":{"description":"The new is_public value of the feed","example":true,"type":"boolean","x-auditable":true},"name":{"description":"The new name of the feed","example":"indicator_list","type":"string","x-auditable":true}}},"custom-indicator-feeds_update_public_field_response":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/custom-indicator-feeds_indicator_feed_item"}}}]},"custom-pages_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/custom-pages_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"custom-pages_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/custom-pages_messages"},"messages":{"$ref":"#/components/schemas/custom-pages_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"custom-pages_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/custom-pages_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/custom-pages_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"custom-pages_api-response-single":{"allOf":[{"$ref":"#/components/schemas/custom-pages_api-response-common"}],"type":"object"},"custom-pages_custom_page":{"properties":{"created_on":{"$ref":"#/components/schemas/custom-pages_timestamp"},"description":{"example":"Basic Challenge","type":"string","x-auditable":true},"id":{"example":"basic_challenge","type":"string","x-auditable":true},"modified_on":{"$ref":"#/components/schemas/custom-pages_timestamp"},"preview_target":{"example":"block:basic-sec-captcha","type":"string","x-auditable":true},"required_tokens":{"example":["::CAPTCHA_BOX::"],"items":{"type":"string"},"type":"array","x-auditable":true},"state":{"$ref":"#/components/schemas/custom-pages_state"},"url":{"$ref":"#/components/schemas/custom-pages_url"}},"type":"object"},"custom-pages_custom_page_result":{"allOf":[{"$ref":"#/components/schemas/custom-pages_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/custom-pages_custom_page"}}}]},"custom-pages_custom_page_result_list":{"allOf":[{"$ref":"#/components/schemas/custom-pages_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/custom-pages_custom_page"},"type":"array"}}}]},"custom-pages_error_page_type":{"description":"Error Page Types","enum":["1000_errors","500_errors","basic_challenge","country_challenge","ip_block","managed_challenge","ratelimit_block","under_attack","waf_block"],"example":"ratelimit_block","type":"string","x-auditable":true},"custom-pages_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"custom-pages_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"custom-pages_state":{"description":"The custom page state.","enum":["default","customized"],"example":"default","type":"string","x-auditable":true},"custom-pages_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true},"custom-pages_url":{"default":"","description":"The URL associated with the custom page.","example":"http://www.example.com","format":"uri","type":"string","x-auditable":true},"d1_account-identifier":{"description":"Account identifier tag.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"d1_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/d1_messages"},"messages":{"$ref":"#/components/schemas/d1_messages"},"result":{"type":"object"},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"d1_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/d1_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/d1_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"d1_batch-query":{"description":"A single query object or a batch query object","oneOf":[{"$ref":"#/components/schemas/d1_single-query"},{"properties":{"batch":{"items":{"$ref":"#/components/schemas/d1_single-query"},"type":"array"}},"title":"multiple queries","type":"object"}]},"d1_created-at":{"description":"Specifies the timestamp the resource was created as an ISO8601 string.","example":"2022-11-15T18:25:44.442097Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"d1_database-details-response":{"description":"The details of the D1 database.","properties":{"created_at":{"$ref":"#/components/schemas/d1_created-at"},"file_size":{"$ref":"#/components/schemas/d1_file-size"},"name":{"$ref":"#/components/schemas/d1_database-name"},"num_tables":{"$ref":"#/components/schemas/d1_table-count"},"read_replication":{"$ref":"#/components/schemas/d1_read-replication-details"},"uuid":{"$ref":"#/components/schemas/d1_database-identifier"},"version":{"$ref":"#/components/schemas/d1_database-version"}},"type":"object"},"d1_database-identifier":{"description":"D1 database identifier (UUID).","example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","readOnly":true,"type":"string","x-auditable":true},"d1_database-name":{"description":"D1 database name.","example":"my-database","pattern":"^[a-z0-9][a-z0-9-_]*$","type":"string","x-auditable":true},"d1_database-response":{"properties":{"created_at":{"$ref":"#/components/schemas/d1_created-at"},"name":{"$ref":"#/components/schemas/d1_database-name"},"uuid":{"$ref":"#/components/schemas/d1_database-identifier"},"version":{"$ref":"#/components/schemas/d1_database-version"}},"type":"object"},"d1_database-update-partial-request-body":{"properties":{"read_replication":{"description":"Configuration for D1 read replication.","properties":{"mode":{"$ref":"#/components/schemas/d1_read-replication-mode"}},"required":["mode"],"type":"object"}},"type":"object"},"d1_database-update-request-body":{"properties":{"read_replication":{"description":"Configuration for D1 read replication.","properties":{"mode":{"$ref":"#/components/schemas/d1_read-replication-mode"}},"required":["mode"],"type":"object"}},"required":["read_replication"],"type":"object"},"d1_database-version":{"example":"production","pattern":"^(alpha|beta|production)$","type":"string","x-auditable":true},"d1_file-size":{"description":"The D1 database's size, in bytes.","example":12,"type":"number","x-auditable":true},"d1_jurisdiction":{"description":"Specify the location to restrict the D1 database to run and store data. If this option is present, the location hint is ignored.","enum":["eu","fedramp"],"example":"eu","type":"string","x-auditable":true},"d1_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"d1_params":{"example":["firstParam","secondParam"],"items":{"type":"string"},"type":"array"},"d1_primary-location-hint":{"description":"Specify the region to create the D1 primary, if available. If this option is omitted, the D1 will be created as close as possible to the current user.","enum":["wnam","enam","weur","eeur","apac","oc"],"example":"wnam","type":"string","x-auditable":true},"d1_query-meta":{"properties":{"changed_db":{"description":"Denotes if the database has been altered in some way, like deleting rows.","type":"boolean","x-auditable":true},"changes":{"description":"Rough indication of how many rows were modified by the query, as provided by SQLite's `sqlite3_total_changes()`.","type":"number","x-auditable":true},"duration":{"description":"The duration of the SQL query execution inside the database. Does not include any network communication.","type":"number","x-auditable":true},"last_row_id":{"description":"The row ID of the last inserted row in a table with an `INTEGER PRIMARY KEY` as provided by SQLite. Tables created with `WITHOUT ROWID` do not populate this.","type":"number","x-auditable":true},"rows_read":{"description":"Number of rows read during the SQL query execution, including indices (not all rows are necessarily returned).","type":"number","x-auditable":true},"rows_written":{"description":"Number of rows written during the SQL query execution, including indices.","type":"number","x-auditable":true},"served_by_primary":{"description":"Denotes if the query has been handled by the database primary instance.","type":"boolean","x-auditable":true},"served_by_region":{"$ref":"#/components/schemas/d1_served-by-region"},"size_after":{"description":"Size of the database after the query committed, in bytes.","type":"number","x-auditable":true},"timings":{"description":"Various durations for the query.","properties":{"sql_duration_ms":{"description":"The duration of the SQL query execution inside the database. Does not include any network communication.","type":"number","x-auditable":true}},"type":"object"}},"type":"object"},"d1_query-result-response":{"properties":{"meta":{"$ref":"#/components/schemas/d1_query-meta"},"results":{"items":{"type":"object"},"type":"array"},"success":{"type":"boolean"}},"type":"object"},"d1_raw-result-response":{"properties":{"meta":{"$ref":"#/components/schemas/d1_query-meta"},"results":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"rows":{"items":{"items":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"object"}]},"type":"array"},"type":"array"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"},"d1_read-replication-details":{"description":"Configuration for D1 read replication.","properties":{"mode":{"$ref":"#/components/schemas/d1_read-replication-mode"}},"required":["mode"],"type":"object"},"d1_read-replication-mode":{"description":"The read replication mode for the database. Use 'auto' to create replicas and allow D1 automatically place them around the world, or 'disabled' to not use any database replicas (it can take a few hours for all replicas to be deleted).","enum":["auto","disabled"],"example":"auto","type":"string","x-auditable":true},"d1_served-by-region":{"description":"Region location hint of the database instance that handled the query.","enum":["WNAM","ENAM","WEUR","EEUR","APAC","OC"],"example":"EEUR","type":"string","x-auditable":true},"d1_single-query":{"description":"A single query with or without parameters","properties":{"params":{"$ref":"#/components/schemas/d1_params"},"sql":{"$ref":"#/components/schemas/d1_sql"}},"required":["sql"],"title":"single query","type":"object"},"d1_sql":{"description":"Your SQL query. Supports multiple statements, joined by semicolons, which will be executed as a batch.","example":"SELECT * FROM myTable WHERE field = ? OR field = ?;","type":"string"},"d1_table-count":{"example":12,"type":"number","x-auditable":true},"digital-experience-monitoring_account_identifier":{"example":"01a7362d577a6c3019a474fd6f485823","maxLength":32,"readOnly":true,"type":"string"},"digital-experience-monitoring_aggregate_stat":{"properties":{"avgMs":{"nullable":true,"type":"integer"},"deltaPct":{"format":"float","nullable":true,"type":"number"},"timePeriod":{"$ref":"#/components/schemas/digital-experience-monitoring_aggregate_time_period"}},"required":["timePeriod"],"type":"object"},"digital-experience-monitoring_aggregate_time_period":{"properties":{"units":{"enum":["hours","days","testRuns"],"type":"string"},"value":{"type":"integer"}},"required":["value","units"],"type":"object"},"digital-experience-monitoring_aggregate_time_slot":{"properties":{"avgMs":{"type":"integer"},"timestamp":{"type":"string"}},"required":["timestamp","avgMs"],"type":"object"},"digital-experience-monitoring_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"digital-experience-monitoring_api-response-collection-common":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common"},{"properties":{"result":{"items":{},"nullable":true,"type":"array"}}}],"type":"object"},"digital-experience-monitoring_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/digital-experience-monitoring_messages"},"messages":{"$ref":"#/components/schemas/digital-experience-monitoring_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"digital-experience-monitoring_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"digital-experience-monitoring_api-response-single":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common"}],"type":"object"},"digital-experience-monitoring_colo":{"description":"Cloudflare colo","example":"SJC","type":"string"},"digital-experience-monitoring_colos_response":{"description":"array of colos.","items":{"required":["airportCode","countryCode","city"],"type":"object"},"properties":{"airportCode":{"description":"Airport code","example":"SFO","type":"string"},"city":{"description":"City","example":"San Francisco","type":"string"},"countryCode":{"description":"Country code","example":"US","type":"string"}},"type":"array"},"digital-experience-monitoring_command_id":{"description":"Unique identifier for a command","example":"5758fefe-ae7e-4538-a39b-1fef6abcb909","type":"string"},"digital-experience-monitoring_commands_devices_response":{"properties":{"devices":{"description":"List of eligible devices","items":{"properties":{"deviceId":{"description":"Device identifier (UUID v4)","type":"string"},"deviceName":{"description":"Device identifier (human readable)","type":"string"},"eligible":{"description":"Whether the device is eligible for remote captures","type":"boolean"},"ineligibleReason":{"description":"If the device is not eligible, the reason why.","type":"string"},"personEmail":{"description":"User contact email address","type":"string"},"platform":{"$ref":"#/components/schemas/digital-experience-monitoring_platform"},"status":{"$ref":"#/components/schemas/digital-experience-monitoring_status"},"timestamp":{"$ref":"#/components/schemas/digital-experience-monitoring_timestamp"},"version":{"$ref":"#/components/schemas/digital-experience-monitoring_version"}},"type":"object"},"type":"array"}},"type":"object"},"digital-experience-monitoring_commands_users_response":{"properties":{"userEmails":{"description":"List of user emails","items":{"example":"user@cloudflare.com","type":"string"},"type":"array"}},"type":"object"},"digital-experience-monitoring_cpu_pct_by_app":{"items":{"properties":{"cpu_pct":{"format":"float","type":"number"},"name":{"type":"string"}},"type":"object"},"type":"array"},"digital-experience-monitoring_device":{"properties":{"alwaysOn":{"nullable":true,"type":"boolean"},"batteryCharging":{"nullable":true,"type":"boolean"},"batteryCycles":{"format":"int64","nullable":true,"type":"integer"},"batteryPct":{"format":"float","nullable":true,"type":"number"},"colo":{"$ref":"#/components/schemas/digital-experience-monitoring_colo"},"connectionType":{"nullable":true,"type":"string"},"cpuPct":{"format":"float","nullable":true,"type":"number"},"cpuPctByApp":{"items":{"$ref":"#/components/schemas/digital-experience-monitoring_cpu_pct_by_app"},"nullable":true,"type":"array"},"deviceId":{"description":"Device identifier (UUID v4)","type":"string"},"deviceIpv4":{"$ref":"#/components/schemas/digital-experience-monitoring_ip_info"},"deviceIpv6":{"$ref":"#/components/schemas/digital-experience-monitoring_ip_info"},"deviceName":{"description":"Device identifier (human readable)","type":"string"},"diskReadBps":{"format":"int64","nullable":true,"type":"integer"},"diskUsagePct":{"format":"float","nullable":true,"type":"number"},"diskWriteBps":{"format":"int64","nullable":true,"type":"integer"},"dohSubdomain":{"nullable":true,"type":"string"},"estimatedLossPct":{"format":"float","nullable":true,"type":"number"},"firewallEnabled":{"nullable":true,"type":"boolean"},"gatewayIpv4":{"$ref":"#/components/schemas/digital-experience-monitoring_ip_info"},"gatewayIpv6":{"$ref":"#/components/schemas/digital-experience-monitoring_ip_info"},"handshakeLatencyMs":{"format":"int64","nullable":true,"type":"number"},"ispIpv4":{"$ref":"#/components/schemas/digital-experience-monitoring_ip_info"},"ispIpv6":{"$ref":"#/components/schemas/digital-experience-monitoring_ip_info"},"metal":{"nullable":true,"type":"string"},"mode":{"$ref":"#/components/schemas/digital-experience-monitoring_mode"},"networkRcvdBps":{"format":"int64","nullable":true,"type":"integer"},"networkSentBps":{"format":"int64","nullable":true,"type":"integer"},"networkSsid":{"nullable":true,"type":"string"},"personEmail":{"$ref":"#/components/schemas/digital-experience-monitoring_personEmail"},"platform":{"$ref":"#/components/schemas/digital-experience-monitoring_platform"},"ramAvailableKb":{"format":"int64","nullable":true,"type":"integer"},"ramUsedPct":{"format":"float","nullable":true,"type":"number"},"ramUsedPctByApp":{"items":{"$ref":"#/components/schemas/digital-experience-monitoring_ram_used_pct_by_app"},"nullable":true,"type":"array"},"status":{"$ref":"#/components/schemas/digital-experience-monitoring_status"},"switchLocked":{"nullable":true,"type":"boolean"},"timestamp":{"$ref":"#/components/schemas/digital-experience-monitoring_timestamp"},"version":{"$ref":"#/components/schemas/digital-experience-monitoring_version"},"wifiStrengthDbm":{"format":"int64","nullable":true,"type":"integer"}},"required":["colo","deviceId","mode","platform","status","timestamp","version"],"type":"object"},"digital-experience-monitoring_device-dex-test-schemas-data":{"description":"The configuration object which contains the details for the WARP client to conduct the test.","example":{"host":"https://dash.cloudflare.com","kind":"http","method":"GET"},"properties":{"host":{"description":"The desired endpoint to test.","example":"https://dash.cloudflare.com","type":"string"},"kind":{"description":"The type of test.","example":"http","type":"string"},"method":{"description":"The HTTP request method type.","example":"GET","type":"string"}},"type":"object"},"digital-experience-monitoring_device-dex-test-schemas-description":{"description":"Additional details about the test.","example":"Checks the dash endpoint every 30 minutes","type":"string"},"digital-experience-monitoring_device-dex-test-schemas-enabled":{"description":"Determines whether or not the test is active.","example":true,"type":"boolean"},"digital-experience-monitoring_device-dex-test-schemas-http":{"properties":{"data":{"$ref":"#/components/schemas/digital-experience-monitoring_device-dex-test-schemas-data"},"description":{"$ref":"#/components/schemas/digital-experience-monitoring_device-dex-test-schemas-description"},"enabled":{"$ref":"#/components/schemas/digital-experience-monitoring_device-dex-test-schemas-enabled"},"interval":{"$ref":"#/components/schemas/digital-experience-monitoring_device-dex-test-schemas-interval"},"name":{"$ref":"#/components/schemas/digital-experience-monitoring_device-dex-test-schemas-name"},"target_policies":{"$ref":"#/components/schemas/digital-experience-monitoring_device-dex-test-target-policies"},"targeted":{"type":"boolean"},"test_id":{"$ref":"#/components/schemas/digital-experience-monitoring_schemas-test-id"}},"required":["name","interval","enabled","data"],"type":"object"},"digital-experience-monitoring_device-dex-test-schemas-interval":{"description":"How often the test will run.","example":"30m","type":"string"},"digital-experience-monitoring_device-dex-test-schemas-name":{"description":"The name of the DEX test. Must be unique.","example":"HTTP dash health check","type":"string"},"digital-experience-monitoring_device-dex-test-target-policies":{"description":"DEX rules targeted by this test","items":{"$ref":"#/components/schemas/digital-experience-monitoring_dex_target_policy"},"type":"array"},"digital-experience-monitoring_device_id":{"description":"Device-specific ID, given as UUID v4","example":"cb49c27f-7f97-49c5-b6f3-f7c01ead0fd7","type":"string"},"digital-experience-monitoring_dex-delete-response-collection":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common"},{"properties":{"result":{"properties":{"dex_tests":{"items":{"$ref":"#/components/schemas/digital-experience-monitoring_device-dex-test-schemas-http"},"type":"array"}},"type":"object"}}}]},"digital-experience-monitoring_dex-response_collection":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-collection-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/digital-experience-monitoring_device-dex-test-schemas-http"},"type":"array"}}}]},"digital-experience-monitoring_dex-single_response":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_device-dex-test-schemas-http"}}}]},"digital-experience-monitoring_dex_target_policy":{"properties":{"default":{"description":"Whether the DEX rule is the account default","type":"boolean"},"id":{"description":"The id of the DEX rule","type":"string"},"name":{"description":"The name of the DEX rule","type":"string"}},"type":"object"},"digital-experience-monitoring_fleet_status_devices_response":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/digital-experience-monitoring_device"},"type":"array"}},"type":"object"}]},"digital-experience-monitoring_fleet_status_live_response":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"properties":{"result":{"properties":{"deviceStats":{"properties":{"byColo":{"items":{"$ref":"#/components/schemas/digital-experience-monitoring_live_stat"},"nullable":true,"type":"array"},"byMode":{"items":{"$ref":"#/components/schemas/digital-experience-monitoring_live_stat"},"nullable":true,"type":"array"},"byPlatform":{"items":{"$ref":"#/components/schemas/digital-experience-monitoring_live_stat"},"nullable":true,"type":"array"},"byStatus":{"items":{"$ref":"#/components/schemas/digital-experience-monitoring_live_stat"},"nullable":true,"type":"array"},"byVersion":{"items":{"$ref":"#/components/schemas/digital-experience-monitoring_live_stat"},"nullable":true,"type":"array"},"uniqueDevicesTotal":{"$ref":"#/components/schemas/digital-experience-monitoring_uniqueDevicesTotal"}},"type":"object"}},"type":"object"}},"type":"object"}]},"digital-experience-monitoring_get_commands_quota_response":{"properties":{"quota":{"description":"The remaining number of commands that can be initiated for an account","type":"number"},"quota_usage":{"description":"The number of commands that have been initiated for an account","type":"number"},"reset_time":{"description":"The time when the quota resets","format":"date-time","type":"string"}},"required":["quota_usage","quota","reset_time"],"type":"object"},"digital-experience-monitoring_get_commands_response":{"properties":{"commands":{"items":{"properties":{"completed_date":{"format":"date-time","nullable":true,"type":"string"},"created_date":{"format":"date-time","type":"string"},"device_id":{"type":"string"},"filename":{"nullable":true,"type":"string"},"id":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"user_email":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"digital-experience-monitoring_http_details_percentiles_response":{"properties":{"dnsResponseTimeMs":{"$ref":"#/components/schemas/digital-experience-monitoring_percentiles"},"resourceFetchTimeMs":{"$ref":"#/components/schemas/digital-experience-monitoring_percentiles"},"serverResponseTimeMs":{"$ref":"#/components/schemas/digital-experience-monitoring_percentiles"}},"type":"object"},"digital-experience-monitoring_http_details_response":{"properties":{"host":{"description":"The url of the HTTP synthetic application test","example":"http://example.com","type":"string"},"httpStats":{"nullable":true,"properties":{"availabilityPct":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time"},"dnsResponseTimeMs":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_over_time"},"httpStatusCode":{"items":{"properties":{"status200":{"type":"integer"},"status300":{"type":"integer"},"status400":{"type":"integer"},"status500":{"type":"integer"},"timestamp":{"example":"2023-07-16 15:00:00+00","type":"string"}},"required":["timestamp","status200","status300","status400","status500"],"type":"object"},"type":"array"},"resourceFetchTimeMs":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_over_time"},"serverResponseTimeMs":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_over_time"},"uniqueDevicesTotal":{"description":"Count of unique devices that have run this test in the given time period","example":57,"type":"integer"}},"required":["uniqueDevicesTotal","resourceFetchTimeMs","serverResponseTimeMs","dnsResponseTimeMs","httpStatusCode","availabilityPct"],"type":"object"},"httpStatsByColo":{"items":{"properties":{"availabilityPct":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time"},"colo":{"example":"DFW","type":"string"},"dnsResponseTimeMs":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_over_time"},"httpStatusCode":{"items":{"properties":{"status200":{"type":"integer"},"status300":{"type":"integer"},"status400":{"type":"integer"},"status500":{"type":"integer"},"timestamp":{"example":"2023-07-16 15:00:00+00","type":"string"}},"required":["timestamp","status200","status300","status400","status500"],"type":"object"},"type":"array"},"resourceFetchTimeMs":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_over_time"},"serverResponseTimeMs":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_over_time"},"uniqueDevicesTotal":{"description":"Count of unique devices that have run this test in the given time period","example":57,"type":"integer"}},"required":["colo","uniqueDevicesTotal","resourceFetchTimeMs","serverResponseTimeMs","dnsResponseTimeMs","httpStatusCode","availabilityPct"],"type":"object"},"type":"array"},"interval":{"description":"The interval at which the HTTP synthetic application test is set to run.","example":"0h5m0s","type":"string"},"kind":{"enum":["http"]},"method":{"description":"The HTTP method to use when running the test","example":"GET","type":"string"},"name":{"description":"The name of the HTTP synthetic application test","example":"Atlassian Sign In Page","type":"string"},"target_policies":{"items":{"properties":{"default":{"description":"Whether the policy is the default for the account","type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name","default"],"type":"object"},"nullable":true,"type":"array"},"targeted":{"type":"boolean"}},"type":"object"},"digital-experience-monitoring_ip_info":{"properties":{"address":{"nullable":true,"type":"string"},"asn":{"nullable":true,"type":"integer"},"aso":{"nullable":true,"type":"string"},"location":{"properties":{"city":{"nullable":true,"type":"string"},"country_iso":{"nullable":true,"type":"string"},"state_iso":{"nullable":true,"type":"string"},"zip":{"nullable":true,"type":"string"}},"type":"object"},"netmask":{"nullable":true,"type":"string"},"version":{"nullable":true,"type":"string"}},"type":"object"},"digital-experience-monitoring_live_stat":{"properties":{"uniqueDevicesTotal":{"$ref":"#/components/schemas/digital-experience-monitoring_uniqueDevicesTotal"},"value":{"type":"string"}},"type":"object"},"digital-experience-monitoring_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"digital-experience-monitoring_mode":{"description":"The mode under which the WARP client is run","example":"proxy","type":"string"},"digital-experience-monitoring_page":{"default":1,"description":"Page number of paginated results","example":1,"minimum":1,"type":"number"},"digital-experience-monitoring_per_page":{"description":"Number of items per page","example":10,"maximum":50,"minimum":1,"type":"number"},"digital-experience-monitoring_percentiles":{"properties":{"p50":{"description":"p50 observed in the time period","nullable":true,"type":"number"},"p90":{"description":"p90 observed in the time period","nullable":true,"type":"number"},"p95":{"description":"p95 observed in the time period","nullable":true,"type":"number"},"p99":{"description":"p99 observed in the time period","nullable":true,"type":"number"}},"type":"object"},"digital-experience-monitoring_personEmail":{"description":"User contact email address","type":"string"},"digital-experience-monitoring_platform":{"description":"Operating system","example":"windows","type":"string"},"digital-experience-monitoring_post_commands_response":{"properties":{"commands":{"description":"List of created commands","items":{"properties":{"args":{"additionalProperties":{"description":"Command argument value as a string","type":"string"},"description":"Command arguments","type":"object"},"device_id":{"description":"Identifier for the device associated with the command","type":"string"},"id":{"description":"Unique identifier for the command","type":"string"},"status":{"description":"Current status of the command","enum":["PENDING_EXEC","PENDING_UPLOAD","SUCCESS","FAILED"],"type":"string"},"type":{"description":"Type of the command (e.g., \"pcap\" or \"warp-diag\")","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"digital-experience-monitoring_ram_used_pct_by_app":{"items":{"properties":{"name":{"type":"string"},"ram_used_pct":{"format":"float","type":"number"}},"type":"object"},"type":"array"},"digital-experience-monitoring_schemas-test-id":{"description":"The unique identifier for the test.","example":"372e67954025e0ba6aaa6d586b9e0b59","maxLength":32,"readOnly":true,"type":"string"},"digital-experience-monitoring_since_minutes":{"default":10,"description":"Number of minutes before current time","example":10,"maximum":60,"minimum":1,"type":"number"},"digital-experience-monitoring_sort_by":{"default":"timestamp","description":"Dimension to sort results by","enum":["colo","device_id","mode","platform","status","timestamp","version"],"type":"string"},"digital-experience-monitoring_source":{"default":"last_seen","description":"Specifies fleet status details source","enum":["last_seen","hourly","raw"],"example":"last_seen","type":"string"},"digital-experience-monitoring_status":{"description":"Network status","example":"connected","type":"string"},"digital-experience-monitoring_test_stat_over_time":{"properties":{"avg":{"description":"average observed in the time period","nullable":true,"type":"integer"},"max":{"description":"highest observed in the time period","nullable":true,"type":"integer"},"min":{"description":"lowest observed in the time period","nullable":true,"type":"integer"},"slots":{"items":{"properties":{"timestamp":{"example":"2023-07-16 15:00:00+00","type":"string"},"value":{"type":"integer"}},"required":["timestamp","value"],"type":"object"},"type":"array"}},"required":["slots"],"type":"object"},"digital-experience-monitoring_test_stat_pct_over_time":{"properties":{"avg":{"description":"average observed in the time period","format":"float","nullable":true,"type":"number"},"max":{"description":"highest observed in the time period","format":"float","nullable":true,"type":"number"},"min":{"description":"lowest  observed in the time period","format":"float","nullable":true,"type":"number"},"slots":{"items":{"properties":{"timestamp":{"example":"2023-07-16 15:00:00+00","type":"string"},"value":{"format":"float","type":"number"}},"required":["timestamp","value"],"type":"object"},"type":"array"}},"required":["slots"],"type":"object"},"digital-experience-monitoring_tests_response":{"properties":{"overviewMetrics":{"properties":{"avgHttpAvailabilityPct":{"description":"percentage availability for all HTTP test results in response","format":"float","nullable":true,"type":"number"},"avgTracerouteAvailabilityPct":{"description":"percentage availability for all traceroutes results in response","format":"float","nullable":true,"type":"number"},"testsTotal":{"description":"number of  tests.","type":"integer"}},"required":["testsTotal"],"type":"object"},"tests":{"description":"array of test results objects.","items":{"properties":{"created":{"description":"date the test was created.","type":"string"},"description":{"description":"the test description defined during configuration","type":"string"},"enabled":{"description":"if true, then the test will run on targeted devices. Else, the test will not run.","type":"boolean"},"host":{"type":"string"},"httpResults":{"nullable":true,"properties":{"resourceFetchTime":{"$ref":"#/components/schemas/digital-experience-monitoring_timing_aggregates"}},"required":["resourceFetchTime"],"type":"object"},"httpResultsByColo":{"items":{"properties":{"colo":{"description":"Cloudflare colo","example":"SJC","type":"string"},"resourceFetchTime":{"$ref":"#/components/schemas/digital-experience-monitoring_timing_aggregates"}},"required":["colo","resourceFetchTime"],"type":"object"},"type":"array"},"id":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"},"interval":{"description":"The interval at which the synthetic application test is set to run.","type":"string"},"kind":{"description":"test type, http or traceroute","enum":["http","traceroute"],"type":"string"},"method":{"description":"for HTTP, the method to use when running the test","type":"string"},"name":{"description":"name given to this test","type":"string"},"target_policies":{"items":{"properties":{"default":{"description":"Whether the policy is the default for the account","type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name","default"],"type":"object"},"nullable":true,"type":"array"},"targeted":{"type":"boolean"},"tracerouteResults":{"nullable":true,"properties":{"roundTripTime":{"$ref":"#/components/schemas/digital-experience-monitoring_timing_aggregates"}},"required":["roundTripTime"],"type":"object"},"tracerouteResultsByColo":{"items":{"properties":{"colo":{"description":"Cloudflare colo","example":"SJC","type":"string"},"roundTripTime":{"$ref":"#/components/schemas/digital-experience-monitoring_timing_aggregates"}},"required":["colo","roundTripTime"],"type":"object"},"type":"array"},"updated":{"type":"string"}},"required":["id","name","kind","interval","enabled","description","updated","created","host"],"type":"object"},"type":"array"}},"required":["overviewMetrics","tests"],"type":"object"},"digital-experience-monitoring_time_now":{"description":"Current time in ISO format","example":"2023-10-11T00:00:00Z","type":"string"},"digital-experience-monitoring_timestamp":{"description":"Timestamp in ISO format","example":"2023-10-11T00:00:00Z","type":"string"},"digital-experience-monitoring_timing_aggregates":{"properties":{"avgMs":{"nullable":true,"type":"integer"},"history":{"items":{"$ref":"#/components/schemas/digital-experience-monitoring_aggregate_stat"},"type":"array"},"overTime":{"nullable":true,"properties":{"timePeriod":{"$ref":"#/components/schemas/digital-experience-monitoring_aggregate_time_period"},"values":{"items":{"$ref":"#/components/schemas/digital-experience-monitoring_aggregate_time_slot"},"type":"array"}},"required":["values","timePeriod"],"type":"object"}},"required":["history"],"type":"object"},"digital-experience-monitoring_traceroute_details_percentiles_response":{"properties":{"hopsCount":{"$ref":"#/components/schemas/digital-experience-monitoring_percentiles"},"packetLossPct":{"$ref":"#/components/schemas/digital-experience-monitoring_percentiles"},"roundTripTimeMs":{"$ref":"#/components/schemas/digital-experience-monitoring_percentiles"}},"type":"object"},"digital-experience-monitoring_traceroute_details_response":{"properties":{"host":{"description":"The host of the Traceroute synthetic application test","example":"1.1.1.1","type":"string"},"interval":{"description":"The interval at which the Traceroute synthetic application test is set to run.","example":"0h5m0s","type":"string"},"kind":{"enum":["traceroute"]},"name":{"description":"The name of the Traceroute synthetic application test","example":"Atlassian Sign In Page","type":"string"},"target_policies":{"items":{"properties":{"default":{"description":"Whether the policy is the default for the account","type":"boolean"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name","default"],"type":"object"},"nullable":true,"type":"array"},"targeted":{"type":"boolean"},"tracerouteStats":{"nullable":true,"properties":{"availabilityPct":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time"},"hopsCount":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_over_time"},"packetLossPct":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time"},"roundTripTimeMs":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_over_time"},"uniqueDevicesTotal":{"description":"Count of unique devices that have run this test in the given time period","example":57,"type":"integer"}},"required":["uniqueDevicesTotal","roundTripTimeMs","hopsCount","packetLossPct","availabilityPct"],"type":"object"},"tracerouteStatsByColo":{"items":{"properties":{"availabilityPct":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time"},"colo":{"example":"DFW","type":"string"},"hopsCount":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_over_time"},"packetLossPct":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_pct_over_time"},"roundTripTimeMs":{"$ref":"#/components/schemas/digital-experience-monitoring_test_stat_over_time"},"uniqueDevicesTotal":{"description":"Count of unique devices that have run this test in the given time period","example":57,"type":"integer"}},"required":["colo","uniqueDevicesTotal","roundTripTimeMs","hopsCount","packetLossPct","availabilityPct"],"type":"object"},"type":"array"}},"required":["kind","name","host","interval"],"type":"object"},"digital-experience-monitoring_traceroute_test_network_path_response":{"properties":{"deviceName":{"type":"string"},"id":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"},"interval":{"description":"The interval at which the Traceroute synthetic application test is set to run.","example":"0h5m0s","type":"string"},"kind":{"enum":["traceroute"]},"name":{"type":"string"},"networkPath":{"nullable":true,"properties":{"sampling":{"description":"Specifies the sampling applied, if any, to the slots response. When sampled, results shown represent the first test run to the start of each sampling interval.","nullable":true,"properties":{"unit":{"enum":["hours"]},"value":{"type":"integer"}},"required":["value","unit"],"type":"object"},"slots":{"items":{"properties":{"clientToAppRttMs":{"description":"Round trip time in ms of the client to app mile","nullable":true,"type":"integer"},"clientToCfEgressRttMs":{"description":"Round trip time in ms of the client to Cloudflare egress mile","nullable":true,"type":"integer"},"clientToCfIngressRttMs":{"description":"Round trip time in ms of the client to Cloudflare ingress mile","nullable":true,"type":"integer"},"clientToIspRttMs":{"description":"Round trip time in ms of the client to ISP mile","nullable":true,"type":"integer"},"id":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"},"timestamp":{"example":"2023-07-16 15:00:00+00","type":"string"}},"required":["id","timestamp","clientToAppRttMs","clientToCfIngressRttMs","clientToCfEgressRttMs"],"type":"object"},"type":"array"}},"required":["slots"],"type":"object"},"url":{"description":"The host of the Traceroute synthetic application test","example":"1.1.1.1","type":"string"}},"required":["id"],"type":"object"},"digital-experience-monitoring_traceroute_test_result_network_path_response":{"properties":{"deviceName":{"description":"name of the device associated with this network path response","type":"string"},"hops":{"description":"an array of the hops taken by the device to reach the end destination","items":{"properties":{"asn":{"nullable":true,"type":"integer"},"aso":{"nullable":true,"type":"string"},"ipAddress":{"nullable":true,"type":"string"},"location":{"nullable":true,"properties":{"city":{"nullable":true,"type":"string"},"state":{"nullable":true,"type":"string"},"zip":{"nullable":true,"type":"string"}},"type":"object"},"mile":{"enum":["client-to-app","client-to-cf-egress","client-to-cf-ingress","client-to-isp"],"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"packetLossPct":{"format":"float","nullable":true,"type":"number"},"rttMs":{"nullable":true,"type":"integer"},"ttl":{"type":"integer"}},"required":["ttl"],"type":"object"},"type":"array"},"resultId":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"},"testId":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"},"testName":{"description":"name of the tracroute test","type":"string"}},"required":["resultId","hops"],"type":"object"},"digital-experience-monitoring_uniqueDevicesTotal":{"description":"Number of unique devices","type":"number"},"digital-experience-monitoring_unique_devices_response":{"properties":{"uniqueDevicesTotal":{"description":"total number of unique devices","type":"integer"}},"required":["uniqueDevicesTotal"],"type":"object"},"digital-experience-monitoring_uuid":{"description":"API Resource UUID tag.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string"},"digital-experience-monitoring_version":{"description":"WARP client version","example":"1.0.0","type":"string"},"digital-experience-monitoring_warp_config_change_event":{"properties":{"device_id":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"},"device_registration":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"},"from":{"$ref":"#/components/schemas/digital-experience-monitoring_warp_config_details"},"hostname":{"description":"The hostname of the machine the event is from","type":"string"},"serial_number":{"description":"The serial number of the machine the event is from","type":"string"},"timestamp":{"$ref":"#/components/schemas/digital-experience-monitoring_timestamp"},"to":{"$ref":"#/components/schemas/digital-experience-monitoring_warp_config_details"},"user_email":{"description":"Email tied to the device","type":"string"}},"type":"object"},"digital-experience-monitoring_warp_config_details":{"properties":{"account_name":{"description":"The account name.","type":"string"},"account_tag":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"},"config_name":{"description":"The name of the WARP configuration.","type":"string"}},"type":"object"},"digital-experience-monitoring_warp_events_response":{"items":{"oneOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_warp_toggle_change_event"},{"$ref":"#/components/schemas/digital-experience-monitoring_warp_config_change_event"}]},"type":"array"},"digital-experience-monitoring_warp_toggle_change_event":{"properties":{"account_name":{"description":"The account name.","type":"string"},"account_tag":{"description":"The public account identifier.","type":"string"},"device_id":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"},"device_registration":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"},"hostname":{"description":"The hostname of the machine the event is from","type":"string"},"serial_number":{"description":"The serial number of the machine the event is from","type":"string"},"timestamp":{"$ref":"#/components/schemas/digital-experience-monitoring_timestamp"},"toggle":{"description":"The state of the WARP toggle.","enum":["on","off"],"type":"string"},"user_email":{"description":"Email tied to the device","type":"string"}},"type":"object"},"dlp_AddinAccountMapping":{"properties":{"addin_identifier_token":{"format":"uuid","type":"string"},"auth_requirements":{"$ref":"#/components/schemas/dlp_AddinAuth"}},"required":["auth_requirements","addin_identifier_token"],"type":"object"},"dlp_AddinAuth":{"oneOf":[{"properties":{"allowed_microsoft_organizations":{"items":{"type":"string"},"type":"array"},"type":{"enum":["Org"],"type":"string"}},"required":["allowed_microsoft_organizations","type"],"type":"object"},{"properties":{"type":{"enum":["NoAuth"],"type":"string"}},"required":["type"],"type":"object"}]},"dlp_Behavior":{"properties":{"description":{"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"},"risk_level":{"$ref":"#/components/schemas/dlp_RiskLevel"}},"required":["name","description","risk_level","enabled"],"type":"object"},"dlp_Behaviors":{"properties":{"behaviors":{"additionalProperties":{"$ref":"#/components/schemas/dlp_Behavior"},"type":"object"}},"required":["behaviors"],"type":"object"},"dlp_Confidence":{"enum":["low","medium","high","very_high"],"type":"string"},"dlp_ContextAwareness":{"deprecated":true,"description":"Scan the context of predefined entries to only return matches surrounded by keywords.","properties":{"enabled":{"description":"If true, scan the context of predefined entries to only return matches surrounded by keywords.","type":"boolean"},"skip":{"$ref":"#/components/schemas/dlp_SkipConfig"}},"required":["enabled","skip"],"type":"object"},"dlp_CreateEmailRule":{"properties":{"action":{"$ref":"#/components/schemas/dlp_EmailRuleAction"},"conditions":{"description":"Triggered if all conditions match.","items":{"$ref":"#/components/schemas/dlp_EmailRuleCondition"},"type":"array"},"description":{"nullable":true,"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"}},"required":["name","enabled","conditions","action"],"type":"object"},"dlp_CreateIntegrationBody":{"properties":{"integration_type":{"$ref":"#/components/schemas/dlp_RiskScoreIntegrationType"},"reference_id":{"description":"A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4).\nhttps://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider","nullable":true,"type":"string"},"tenant_url":{"description":"The base url of the tenant, e.g. \"https://tenant.okta.com\".","format":"uri","type":"string"}},"required":["integration_type","tenant_url"],"type":"object"},"dlp_CustomEntry":{"properties":{"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"pattern":{"$ref":"#/components/schemas/dlp_Pattern"},"profile_id":{"format":"uuid","nullable":true,"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","name","created_at","updated_at","pattern","enabled"],"type":"object"},"dlp_CustomEntryUpdate":{"allOf":[{"$ref":"#/components/schemas/dlp_CustomEntryUpdateType"},{"properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"}]},"dlp_CustomEntryUpdateType":{"properties":{"name":{"type":"string"},"pattern":{"$ref":"#/components/schemas/dlp_Pattern"}},"required":["name","pattern"],"type":"object"},"dlp_CustomProfile":{"properties":{"ai_context_enabled":{"default":false,"type":"boolean"},"allowed_match_count":{"default":0,"description":"Related DLP policies will trigger when the match count exceeds the number set.","example":5,"format":"int32","maximum":1000,"minimum":0,"type":"integer"},"confidence_threshold":{"allOf":[{"$ref":"#/components/schemas/dlp_Confidence"}],"default":"low"},"context_awareness":{"$ref":"#/components/schemas/dlp_ContextAwareness"},"created_at":{"description":"When the profile was created.","format":"date-time","type":"string"},"description":{"description":"The description of the profile.","nullable":true,"type":"string"},"entries":{"items":{"$ref":"#/components/schemas/dlp_Entry"},"type":"array","x-stainless-skip":["terraform"]},"id":{"description":"The id of the profile (uuid).","format":"uuid","type":"string"},"name":{"description":"The name of the profile.","type":"string","x-auditable":true},"ocr_enabled":{"default":false,"type":"boolean"},"updated_at":{"description":"When the profile was lasted updated.","format":"date-time","type":"string"}},"required":["id","name","created_at","updated_at","allowed_match_count","ocr_enabled"],"type":"object"},"dlp_CustomProfileArray":{"items":{"$ref":"#/components/schemas/dlp_CustomProfile"},"type":"array"},"dlp_CustomProfileUpdate":{"properties":{"ai_context_enabled":{"default":false,"type":"boolean"},"allowed_match_count":{"format":"int32","nullable":true,"type":"integer"},"confidence_threshold":{"default":"low","nullable":true,"type":"string"},"context_awareness":{"$ref":"#/components/schemas/dlp_ContextAwareness"},"description":{"description":"The description of the profile.","nullable":true,"type":"string"},"entries":{"deprecated":true,"description":"Custom entries from this profile.\nIf this field is omitted, entries owned by this profile will not be changed.","items":{"$ref":"#/components/schemas/dlp_ProfileEntryUpdate"},"nullable":true,"type":"array"},"name":{"type":"string"},"ocr_enabled":{"default":false,"type":"boolean"},"shared_entries":{"description":"Other entries, e.g. predefined or integration.","items":{"$ref":"#/components/schemas/dlp_SharedEntryUpdate"},"type":"array"}},"required":["name"],"type":"object"},"dlp_Dataset":{"properties":{"case_sensitive":{"type":"boolean"},"columns":{"items":{"$ref":"#/components/schemas/dlp_DatasetColumn"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"description":{"description":"The description of the dataset.","nullable":true,"type":"string"},"encoding_version":{"format":"int32","minimum":0,"type":"integer"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"num_cells":{"format":"int64","type":"integer"},"secret":{"type":"boolean"},"status":{"$ref":"#/components/schemas/dlp_DatasetUploadStatus"},"updated_at":{"description":"Stores when the dataset was last updated.\n\nThis includes name or description changes as well as uploads.","format":"date-time","type":"string"},"uploads":{"items":{"$ref":"#/components/schemas/dlp_DatasetUpload"},"type":"array"}},"required":["name","id","status","num_cells","created_at","updated_at","uploads","secret","encoding_version","columns"],"type":"object"},"dlp_DatasetArray":{"items":{"$ref":"#/components/schemas/dlp_Dataset"},"type":"array"},"dlp_DatasetColumn":{"properties":{"entry_id":{"format":"uuid","type":"string"},"header_name":{"type":"string"},"num_cells":{"format":"int64","type":"integer"},"upload_status":{"$ref":"#/components/schemas/dlp_DatasetUploadStatus"}},"required":["entry_id","upload_status","header_name","num_cells"],"type":"object"},"dlp_DatasetColumnArray":{"items":{"$ref":"#/components/schemas/dlp_DatasetColumn"},"type":"array"},"dlp_DatasetCreation":{"properties":{"dataset":{"$ref":"#/components/schemas/dlp_Dataset"},"encoding_version":{"description":"Encoding version to use for dataset.","format":"int32","minimum":0,"type":"integer"},"max_cells":{"format":"int64","minimum":0,"type":"integer"},"secret":{"description":"The secret to use for Exact Data Match datasets.\n\nThis is not present in Custom Wordlists.","format":"password","type":"string"},"version":{"description":"The version to use when uploading the dataset.","format":"int64","type":"integer"}},"required":["version","max_cells","dataset","encoding_version"],"type":"object"},"dlp_DatasetNewVersion":{"properties":{"case_sensitive":{"type":"boolean"},"columns":{"items":{"$ref":"#/components/schemas/dlp_DatasetColumn"},"type":"array"},"encoding_version":{"format":"int32","minimum":0,"type":"integer"},"max_cells":{"format":"int64","minimum":0,"type":"integer"},"secret":{"format":"password","type":"string"},"version":{"format":"int64","type":"integer"}},"required":["version","max_cells","encoding_version"],"type":"object"},"dlp_DatasetUpdate":{"properties":{"case_sensitive":{"description":"Determines if the words should be matched in a case-sensitive manner.\n\nOnly required for custom word lists.","type":"boolean"},"description":{"description":"The description of the dataset.","nullable":true,"type":"string"},"name":{"description":"The name of the dataset, must be unique.","nullable":true,"type":"string"}},"type":"object"},"dlp_DatasetUpload":{"properties":{"num_cells":{"format":"int64","type":"integer"},"status":{"$ref":"#/components/schemas/dlp_DatasetUploadStatus"},"version":{"format":"int64","type":"integer"}},"required":["version","status","num_cells"],"type":"object"},"dlp_DatasetUploadStatus":{"enum":["empty","uploading","pending","processing","failed","complete"],"type":"string"},"dlp_DocumentFingerprint":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"default":"","type":"string"},"entry_id":{"format":"uuid","type":"string"},"file_name":{"nullable":true,"type":"string"},"id":{"format":"uuid","type":"string"},"match_percent":{"format":"int32","type":"integer"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/dlp_DatasetUploadStatus"},"updated_at":{"format":"date-time","type":"string"},"version":{"format":"int64","nullable":true,"type":"integer"}},"required":["id","entry_id","name","description","match_percent","status","created_at","updated_at"],"type":"object"},"dlp_DocumentFingerprintArray":{"items":{"$ref":"#/components/schemas/dlp_DocumentFingerprint"},"type":"array"},"dlp_DocumentFingerprintEntry":{"properties":{"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","name","created_at","updated_at","enabled"],"type":"object"},"dlp_DocumentFingerprintUpload":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"entry_id":{"format":"uuid","type":"string"},"file_name":{"type":"string"},"id":{"format":"uuid","type":"string"},"match_percent":{"format":"int32","type":"integer"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/dlp_DatasetUploadStatus"},"updated_at":{"format":"date-time","type":"string"},"version":{"format":"int64","type":"integer"}},"required":["id","entry_id","name","description","match_percent","version","file_name","status","created_at","updated_at"],"type":"object"},"dlp_EmailRule":{"properties":{"action":{"$ref":"#/components/schemas/dlp_EmailRuleAction"},"conditions":{"description":"Triggered if all conditions match.","items":{"$ref":"#/components/schemas/dlp_EmailRuleCondition"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"description":{"nullable":true,"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"},"priority":{"format":"int32","minimum":0,"type":"integer"},"rule_id":{"format":"uuid","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["rule_id","name","priority","enabled","conditions","action","created_at","updated_at"],"type":"object"},"dlp_EmailRuleAction":{"oneOf":[{"properties":{"action":{"enum":["Block"],"type":"string"},"message":{"nullable":true,"type":"string"}},"required":["action"],"type":"object"}]},"dlp_EmailRuleArray":{"items":{"$ref":"#/components/schemas/dlp_EmailRule"},"type":"array"},"dlp_EmailRuleCondition":{"properties":{"operator":{"$ref":"#/components/schemas/dlp_EmailRuleOperator"},"selector":{"$ref":"#/components/schemas/dlp_EmailRuleSelector"},"value":{"$ref":"#/components/schemas/dlp_EmailRuleValue"}},"required":["selector","operator","value"],"type":"object"},"dlp_EmailRuleOperator":{"enum":["InList","NotInList","MatchRegex","NotMatchRegex"],"type":"string"},"dlp_EmailRuleSelector":{"enum":["Recipients","Sender","DLPProfiles"],"type":"string"},"dlp_EmailRuleValue":{"oneOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}]},"dlp_Empty":{"nullable":true,"type":"object"},"dlp_Entry":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/dlp_CustomEntry"},{"properties":{"type":{"enum":["custom"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Custom Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedEntry"},{"properties":{"type":{"enum":["predefined"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Predefined Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_IntegrationEntry"},{"properties":{"type":{"enum":["integration"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Integration Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_ExactDataEntry"},{"properties":{"type":{"enum":["exact_data"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Exact Data Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_DocumentFingerprintEntry"},{"properties":{"type":{"enum":["document_fingerprint"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Document Fingerprint Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_WordListEntry"},{"properties":{"type":{"enum":["word_list"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Word List Entry"}]},"dlp_EntryConfidence":{"properties":{"ai_context_available":{"description":"Indicates whether this entry has AI remote service validation.","type":"boolean"},"available":{"description":"Indicates whether this entry has any form of validation that is not an AI remote service.","type":"boolean"}},"required":["available","ai_context_available"],"type":"object"},"dlp_EntryOfNewProfile":{"oneOf":[{"$ref":"#/components/schemas/dlp_NewCustomEntry"},{"$ref":"#/components/schemas/dlp_NewWordListEntry"}]},"dlp_EntryUpdate":{"allOf":[{"$ref":"#/components/schemas/dlp_EntryUpdateType"},{"properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"}]},"dlp_EntryUpdateType":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/dlp_CustomEntryUpdateType"},{"properties":{"type":{"enum":["custom"],"type":"string"}},"required":["type"],"type":"object"}]},{"properties":{"type":{"enum":["predefined"],"type":"string"}},"required":["type"],"type":"object"},{"properties":{"type":{"enum":["integration"],"type":"string"}},"required":["type"],"type":"object"}]},"dlp_ExactDataEntry":{"properties":{"case_sensitive":{"description":"Only applies to custom word lists.\nDetermines if the words should be matched in a case-sensitive manner\nCannot be set to false if secret is true","type":"boolean"},"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"secret":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","name","created_at","updated_at","enabled","secret","case_sensitive"],"type":"object"},"dlp_IntegrationEntry":{"properties":{"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"profile_id":{"format":"uuid","nullable":true,"type":"string","x-stainless-terraform-configurability":"computed_optional"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","name","created_at","updated_at","enabled"],"type":"object"},"dlp_IntegrationProfile":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"description":"The description of the profile.","nullable":true,"type":"string"},"entries":{"items":{"$ref":"#/components/schemas/dlp_Entry"},"type":"array"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","name","entries","created_at","updated_at"],"type":"object"},"dlp_Limits":{"properties":{"max_dataset_cells":{"format":"int64","minimum":0,"type":"integer"}},"required":["max_dataset_cells"],"type":"object"},"dlp_NewCustomEntry":{"properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"pattern":{"$ref":"#/components/schemas/dlp_Pattern"}},"required":["name","pattern","enabled"],"type":"object"},"dlp_NewCustomEntryWithId":{"allOf":[{"$ref":"#/components/schemas/dlp_NewCustomEntry"},{"properties":{"entry_id":{"format":"uuid","type":"string"}},"required":["entry_id"],"type":"object"}]},"dlp_NewCustomProfile":{"properties":{"ai_context_enabled":{"default":false,"type":"boolean"},"allowed_match_count":{"default":0,"description":"Related DLP policies will trigger when the match count exceeds the number set.","example":5,"format":"int32","maximum":1000,"minimum":0,"type":"integer"},"confidence_threshold":{"default":"low","nullable":true,"type":"string"},"context_awareness":{"$ref":"#/components/schemas/dlp_ContextAwareness"},"description":{"description":"The description of the profile.","nullable":true,"type":"string"},"entries":{"items":{"$ref":"#/components/schemas/dlp_EntryOfNewProfile"},"type":"array","x-stainless-skip":["terraform"]},"name":{"type":"string"},"ocr_enabled":{"default":false,"type":"boolean"},"shared_entries":{"description":"Entries from other profiles (e.g. pre-defined Cloudflare profiles, or your Microsoft Information Protection profiles).","items":{"$ref":"#/components/schemas/dlp_NewSharedEntry"},"type":"array"}},"required":["name"],"type":"object"},"dlp_NewDataset":{"properties":{"case_sensitive":{"description":"Only applies to custom word lists.\nDetermines if the words should be matched in a case-sensitive manner\nCannot be set to false if `secret` is true or undefined","type":"boolean"},"description":{"description":"The description of the dataset.","nullable":true,"type":"string"},"encoding_version":{"description":"Dataset encoding version\n\nNon-secret custom word lists with no header are always version 1.\nSecret EDM lists with no header are version 1.\nMulticolumn CSV with headers are version 2.\nOmitting this field provides the default value 0, which is interpreted\nthe same as 1.","format":"int32","minimum":0,"type":"integer"},"name":{"type":"string"},"secret":{"description":"Generate a secret dataset.\n\nIf true, the response will include a secret to use with the EDM encoder.\nIf false, the response has no secret and the dataset is uploaded in plaintext.","type":"boolean"}},"required":["name"],"type":"object"},"dlp_NewDatasetColumn":{"allOf":[{"oneOf":[{"properties":{"entry_id":{"format":"uuid","type":"string"}},"required":["entry_id"],"title":"Existing Column","type":"object"},{"properties":{"entry_name":{"type":"string"}},"required":["entry_name"],"title":"New Column","type":"object"}]},{"properties":{"header_name":{"type":"string"},"num_cells":{"format":"int64","type":"integer"}},"required":["header_name","num_cells"],"type":"object"}]},"dlp_NewDocumentFingerprint":{"properties":{"description":{"default":"","type":"string"},"match_percent":{"format":"int32","type":"integer"},"name":{"type":"string"}},"required":["name","match_percent"],"type":"object"},"dlp_NewEntry":{"properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"pattern":{"$ref":"#/components/schemas/dlp_Pattern"},"profile_id":{"format":"uuid","type":"string"}},"required":["name","pattern","enabled"],"type":"object"},"dlp_NewPredefinedEntry":{"description":"Used to create a new predefined or integration entry.\n\nPredefined or integration entries can not be updated via the API so\nthese fields will update the entry's settings.","properties":{"enabled":{"type":"boolean"},"entry_id":{"format":"uuid","type":"string"},"profile_id":{"description":"This field is not used as the owning profile.\nFor predefined entries it is already set to a predefined profile.","format":"uuid","nullable":true,"type":"string"}},"required":["enabled","entry_id"],"type":"object"},"dlp_NewPredefinedProfile":{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedProfileUpdate"},{"properties":{"profile_id":{"format":"uuid","type":"string"}},"required":["profile_id"],"type":"object"}]},"dlp_NewSharedEntry":{"oneOf":[{"properties":{"enabled":{"type":"boolean"},"entry_id":{"format":"uuid","type":"string"},"entry_type":{"enum":["custom"],"type":"string"}},"required":["entry_id","enabled","entry_type"],"type":"object"},{"properties":{"enabled":{"type":"boolean"},"entry_id":{"format":"uuid","type":"string"},"entry_type":{"enum":["predefined"],"type":"string"}},"required":["entry_id","enabled","entry_type"],"type":"object"},{"properties":{"enabled":{"type":"boolean"},"entry_id":{"format":"uuid","type":"string"},"entry_type":{"enum":["integration"],"type":"string"}},"required":["entry_id","enabled","entry_type"],"type":"object"},{"properties":{"enabled":{"type":"boolean"},"entry_id":{"format":"uuid","type":"string"},"entry_type":{"enum":["exact_data"],"type":"string"}},"required":["entry_id","enabled","entry_type"],"type":"object"},{"properties":{"enabled":{"type":"boolean"},"entry_id":{"format":"uuid","type":"string"},"entry_type":{"enum":["document_fingerprint"],"type":"string"}},"required":["entry_id","enabled","entry_type"],"type":"object"}]},"dlp_NewWordListEntry":{"properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"words":{"items":{"type":"string"},"type":"array"}},"required":["name","words","enabled"],"type":"object"},"dlp_Pattern":{"properties":{"regex":{"type":"string"},"validation":{"allOf":[{"$ref":"#/components/schemas/dlp_Validation"}]}},"required":["regex"],"type":"object"},"dlp_PayloadLogSetting":{"properties":{"public_key":{"nullable":true,"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["updated_at"],"type":"object"},"dlp_PayloadLogSettingUpdate":{"properties":{"public_key":{"nullable":true,"type":"string"}},"type":"object"},"dlp_PredefinedEntry":{"properties":{"confidence":{"$ref":"#/components/schemas/dlp_EntryConfidence"},"enabled":{"type":"boolean"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"profile_id":{"format":"uuid","nullable":true,"type":"string"},"variant":{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedEntryVariant"}]}},"required":["id","name","enabled","confidence"],"type":"object"},"dlp_PredefinedEntryUpdate":{"properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"type":"object"},"dlp_PredefinedEntryVariant":{"oneOf":[{"properties":{"description":{"nullable":true,"type":"string"},"topic_type":{"$ref":"#/components/schemas/dlp_PromptTopicType"},"type":{"enum":["PromptTopic"],"type":"string"}},"required":["topic_type","type"],"type":"object"}]},"dlp_PredefinedProfile":{"properties":{"ai_context_enabled":{"default":false,"type":"boolean"},"allowed_match_count":{"format":"int32","type":"integer"},"confidence_threshold":{"allOf":[{"$ref":"#/components/schemas/dlp_Confidence"}],"default":"low"},"context_awareness":{"$ref":"#/components/schemas/dlp_ContextAwareness"},"entries":{"items":{"$ref":"#/components/schemas/dlp_Entry"},"type":"array"},"id":{"description":"The id of the predefined profile (uuid).","format":"uuid","type":"string"},"name":{"description":"The name of the predefined profile.","type":"string"},"ocr_enabled":{"default":false,"type":"boolean"},"open_access":{"description":"Whether this profile can be accessed by anyone.","type":"boolean"}},"required":["id","name","entries","allowed_match_count"],"type":"object"},"dlp_PredefinedProfileConfig":{"properties":{"ai_context_enabled":{"default":false,"type":"boolean"},"allowed_match_count":{"format":"int32","type":"integer"},"confidence_threshold":{"default":"low","nullable":true,"type":"string"},"enabled_entries":{"items":{"format":"uuid","type":"string"},"type":"array"},"entries":{"deprecated":true,"items":{"$ref":"#/components/schemas/dlp_Entry"},"type":"array"},"id":{"description":"The id of the predefined profile (uuid).","format":"uuid","type":"string"},"name":{"description":"The name of the predefined profile.","type":"string"},"ocr_enabled":{"default":false,"type":"boolean"},"open_access":{"description":"Whether this profile can be accessed by anyone.","type":"boolean"}},"required":["id","name","entries","enabled_entries","allowed_match_count","confidence_threshold"],"type":"object"},"dlp_PredefinedProfileConfigUpdate":{"properties":{"ai_context_enabled":{"default":false,"type":"boolean"},"allowed_match_count":{"default":0,"example":5,"format":"int32","maximum":1000,"minimum":0,"nullable":true,"type":"integer"},"confidence_threshold":{"default":"low","nullable":true,"type":"string"},"enabled_entries":{"items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"},"entries":{"deprecated":true,"items":{"$ref":"#/components/schemas/dlp_PredefinedProfileEntryUpdate"},"type":"array","x-stainless-terraform-configurability":"computed_optional"},"ocr_enabled":{"default":false,"type":"boolean"}},"type":"object"},"dlp_PredefinedProfileEntryUpdate":{"properties":{"enabled":{"type":"boolean"},"id":{"format":"uuid","type":"string"}},"required":["id","enabled"],"type":"object"},"dlp_PredefinedProfileUpdate":{"properties":{"ai_context_enabled":{"default":false,"type":"boolean"},"allowed_match_count":{"default":0,"example":5,"format":"int32","maximum":1000,"minimum":0,"nullable":true,"type":"integer"},"confidence_threshold":{"default":"low","nullable":true,"type":"string"},"context_awareness":{"$ref":"#/components/schemas/dlp_ContextAwareness"},"entries":{"deprecated":true,"items":{"$ref":"#/components/schemas/dlp_PredefinedProfileEntryUpdate"},"type":"array"},"ocr_enabled":{"default":false,"type":"boolean"}},"type":"object"},"dlp_Profile":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/dlp_CustomProfile"},{"properties":{"type":{"enum":["custom"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Custom Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedProfile"},{"properties":{"type":{"enum":["predefined"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Predefined Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_IntegrationProfile"},{"properties":{"type":{"enum":["integration"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Integration Profile"}]},"dlp_ProfileArray":{"items":{"$ref":"#/components/schemas/dlp_Profile"},"type":"array"},"dlp_ProfileEntryUpdate":{"oneOf":[{"$ref":"#/components/schemas/dlp_NewCustomEntryWithId"},{"$ref":"#/components/schemas/dlp_NewCustomEntry"}]},"dlp_PromptTopicType":{"enum":["Intent","Content"],"type":"string"},"dlp_RegexValidationQuery":{"properties":{"max_match_bytes":{"description":"Maximum number of bytes that the regular expression can match.\n\nIf this is `null` then there is no limit on the length. Patterns can use\n`*` and `+`. Otherwise repeats should use a range `{m,n}` to restrict\npatterns to the length. If this field is missing, then a default length\nlimit is used.\n\nNote that the length is specified in bytes. Since regular expressions\nuse UTF-8 the pattern `.` can match up to 4 bytes. Hence `.{1,256}`\nhas a maximum length of 1024 bytes.","format":"int32","minimum":0,"nullable":true,"type":"integer"},"regex":{"type":"string"}},"required":["regex"],"type":"object"},"dlp_RegexValidationResult":{"properties":{"valid":{"type":"boolean"}},"required":["valid"],"type":"object"},"dlp_RiskEvent":{"properties":{"event_details":{},"id":{"type":"string"},"name":{"type":"string"},"risk_level":{"$ref":"#/components/schemas/dlp_RiskLevel"},"timestamp":{"format":"date-time","type":"string"}},"required":["id","risk_level","name","timestamp"],"type":"object"},"dlp_RiskEvents":{"properties":{"email":{"type":"string"},"events":{"items":{"$ref":"#/components/schemas/dlp_RiskEvent"},"type":"array"},"last_reset_time":{"format":"date-time","nullable":true,"type":"string"},"name":{"type":"string"},"risk_level":{"allOf":[{"$ref":"#/components/schemas/dlp_RiskLevel"}]}},"required":["name","email","events"],"type":"object"},"dlp_RiskLevel":{"enum":["low","medium","high"],"type":"string"},"dlp_RiskScoreIntegration":{"properties":{"account_tag":{"description":"The Cloudflare account tag.","type":"string"},"active":{"description":"Whether this integration is enabled and should export changes in risk score.","type":"boolean"},"created_at":{"description":"When the integration was created in RFC3339 format.","format":"date-time","type":"string"},"id":{"description":"The id of the integration, a UUIDv4.","format":"uuid","type":"string"},"integration_type":{"$ref":"#/components/schemas/dlp_RiskScoreIntegrationType"},"reference_id":{"description":"A reference ID defined by the client.\nShould be set to the Access-Okta IDP integration ID.\nUseful when the risk-score integration needs to be associated with a secondary asset and recalled using that ID.","type":"string"},"tenant_url":{"description":"The base URL for the tenant. E.g. \"https://tenant.okta.com\".","type":"string"},"well_known_url":{"description":"The URL for the Shared Signals Framework configuration, e.g. \"/.well-known/sse-configuration/{integration_uuid}/\". https://openid.net/specs/openid-sse-framework-1_0.html#rfc.section.6.2.1.","type":"string"}},"required":["id","account_tag","integration_type","reference_id","tenant_url","well_known_url","active","created_at"],"type":"object"},"dlp_RiskScoreIntegrationArray":{"items":{"$ref":"#/components/schemas/dlp_RiskScoreIntegration"},"type":"array"},"dlp_RiskScoreIntegrationType":{"enum":["Okta"],"type":"string"},"dlp_RiskSummary":{"properties":{"users":{"items":{"$ref":"#/components/schemas/dlp_UserRiskInfo"},"type":"array"}},"required":["users"],"type":"object"},"dlp_SharedEntryUpdate":{"oneOf":[{"properties":{"enabled":{"type":"boolean"},"entry_id":{"format":"uuid","type":"string"},"entry_type":{"enum":["predefined"],"type":"string"}},"required":["entry_id","enabled","entry_type"],"type":"object"},{"properties":{"enabled":{"type":"boolean"},"entry_id":{"format":"uuid","type":"string"},"entry_type":{"enum":["integration"],"type":"string"}},"required":["entry_id","enabled","entry_type"],"type":"object"},{"properties":{"enabled":{"type":"boolean"},"entry_id":{"format":"uuid","type":"string"},"entry_type":{"enum":["exact_data"],"type":"string"}},"required":["entry_id","enabled","entry_type"],"type":"object"},{"properties":{"enabled":{"type":"boolean"},"entry_id":{"format":"uuid","type":"string"},"entry_type":{"enum":["document_fingerprint"],"type":"string"}},"required":["entry_id","enabled","entry_type"],"type":"object"}]},"dlp_SkipConfig":{"description":"Content types to exclude from context analysis and return all matches.","properties":{"files":{"description":"If the content type is a file, skip context analysis and return all matches.","type":"boolean"}},"required":["files"],"type":"object"},"dlp_UpdateAddinAccountMapping":{"properties":{"auth_requirements":{"$ref":"#/components/schemas/dlp_AddinAuth"}},"required":["auth_requirements"],"type":"object"},"dlp_UpdateBehavior":{"properties":{"enabled":{"type":"boolean"},"risk_level":{"$ref":"#/components/schemas/dlp_RiskLevel"}},"required":["risk_level","enabled"],"type":"object"},"dlp_UpdateBehaviors":{"properties":{"behaviors":{"additionalProperties":{"$ref":"#/components/schemas/dlp_UpdateBehavior"},"type":"object"}},"required":["behaviors"],"type":"object"},"dlp_UpdateDocumentFingerprint":{"properties":{"description":{"nullable":true,"type":"string"},"match_percent":{"format":"int32","nullable":true,"type":"integer"},"name":{"nullable":true,"type":"string"}},"type":"object"},"dlp_UpdateEmailRulePriorities":{"description":"Used to update multiple email rule priorities as an atomic action,\nto support patterns such as swapping the priorities of two email rules.","properties":{"new_priorities":{"additionalProperties":{"format":"int32","minimum":0,"type":"integer"},"type":"object"}},"required":["new_priorities"],"type":"object"},"dlp_UpdateIntegrationBody":{"properties":{"active":{"description":"Whether this integration is enabled. If disabled, no risk changes will be exported to the third-party.","type":"boolean"},"reference_id":{"description":"A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4).\nhttps://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider","nullable":true,"type":"string"},"tenant_url":{"description":"The base url of the tenant, e.g. \"https://tenant.okta.com\".","format":"uri","type":"string"}},"required":["tenant_url","active"],"type":"object"},"dlp_UserRiskInfo":{"properties":{"email":{"type":"string"},"event_count":{"minimum":0,"type":"integer"},"last_event":{"format":"date-time","type":"string"},"max_risk_level":{"$ref":"#/components/schemas/dlp_RiskLevel"},"name":{"type":"string"},"user_id":{"format":"uuid","type":"string"}},"required":["user_id","name","email","max_risk_level","event_count","last_event"],"type":"object"},"dlp_Validation":{"deprecated":true,"enum":["luhn"],"type":"string"},"dlp_WordListEntry":{"properties":{"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"profile_id":{"format":"uuid","nullable":true,"type":"string"},"updated_at":{"format":"date-time","type":"string"},"word_list":{}},"required":["id","name","created_at","updated_at","word_list","enabled"],"type":"object"},"dlp_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"dlp_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/dlp_messages"},"messages":{"$ref":"#/components/schemas/dlp_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"dlp_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/dlp_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/dlp_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"dlp_api-response-single":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-common"}],"type":"object"},"dlp_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"dls_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/dls_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"dls_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/dls_messages"},"messages":{"$ref":"#/components/schemas/dls_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"dls_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/dls_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/dls_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"dls_hostname":{"description":"DNS hostname to be regionalized, must be a subdomain of the zone. Wildcards are supported for one level, e.g `*.example.com`","example":"foo.example.com","type":"string","x-auditable":true},"dls_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"dls_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"dls_region_key":{"description":"Identifying key for the region","example":"ca","type":"string","x-auditable":true},"dls_regional_hostname_response":{"properties":{"created_on":{"allOf":[{"$ref":"#/components/schemas/dls_timestamp"},{"description":"When the regional hostname was created"},{"example":"2014-01-01T05:20:00.12345Z"}]},"hostname":{"$ref":"#/components/schemas/dls_hostname"},"region_key":{"$ref":"#/components/schemas/dls_region_key"},"routing":{"$ref":"#/components/schemas/dls_routing"}},"required":["hostname","region_key","created_on"],"type":"object"},"dls_routing":{"default":"dns","description":"Configure which routing method to use for the regional hostname","example":"dns","type":"string","x-auditable":true},"dls_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true},"dns-analytics_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/dns-analytics_messages"},"messages":{"$ref":"#/components/schemas/dns-analytics_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"dns-analytics_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/dns-analytics_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/dns-analytics_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"dns-analytics_api-response-single":{"allOf":[{"$ref":"#/components/schemas/dns-analytics_api-response-common"}],"type":"object"},"dns-analytics_data":{"description":"Array with one row per combination of dimension values.","items":{"properties":{"dimensions":{"description":"Array of dimension values, representing the combination of dimension values corresponding to this row.","items":{"description":"Dimension value.","example":"NODATA","type":"string"},"type":"array"}},"required":["dimensions"],"type":"object"},"type":"array"},"dns-analytics_dimensions":{"description":"A comma-separated list of dimensions to group results by.","example":"queryType","type":"string"},"dns-analytics_filters":{"description":"Segmentation filter in 'attribute operator value' format.","example":"responseCode==NOERROR,queryType==A","type":"string"},"dns-analytics_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"dns-analytics_limit":{"default":100000,"description":"Limit number of returned metrics.","example":100,"type":"integer"},"dns-analytics_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"dns-analytics_metrics":{"description":"A comma-separated list of metrics to query.","example":"queryCount,uncachedCount","type":"string"},"dns-analytics_query":{"properties":{"dimensions":{"description":"Array of dimension names.","example":["responseCode","queryName"],"items":{"description":"Dimension name.","example":"responseCode","type":"string"},"type":"array"},"filters":{"$ref":"#/components/schemas/dns-analytics_filters"},"limit":{"$ref":"#/components/schemas/dns-analytics_limit"},"metrics":{"description":"Array of metric names.","example":["queryCount","responseTimeAvg"],"items":{"description":"Metric name.","example":"queries","type":"string"},"type":"array"},"since":{"$ref":"#/components/schemas/dns-analytics_since"},"sort":{"description":"Array of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).","example":["+responseCode","-queryName"],"items":{"description":"Dimension name (may be prefixed by - (descending) or + (ascending).","example":"+responseCode","type":"string"},"type":"array"},"until":{"$ref":"#/components/schemas/dns-analytics_until"}},"required":["dimensions","metrics","since","until","limit"],"type":"object"},"dns-analytics_report":{"allOf":[{"$ref":"#/components/schemas/dns-analytics_result"},{"properties":{"data":{"items":{"properties":{"metrics":{"description":"Array with one item per requested metric. Each item is a single value.","items":{"description":"Nominal metric value.","type":"number"},"type":"array"}},"required":["metrics"],"type":"object"},"type":"array"}},"required":["data"],"type":"object"}],"type":"object"},"dns-analytics_report_bytime":{"allOf":[{"$ref":"#/components/schemas/dns-analytics_result"},{"properties":{"data":{"items":{"properties":{"metrics":{"description":"Array with one item per requested metric. Each item is an array of values, broken down by time interval.","items":{"description":"Nominal metric values, broken down by time interval.","items":{"description":"Nominal metric value.","type":"number"},"type":"array"},"type":"array"}},"required":["metrics"],"type":"object"},"type":"array"},"query":{"properties":{"time_delta":{"$ref":"#/components/schemas/dns-analytics_time_delta"}},"required":["time_delta"],"type":"object"},"time_intervals":{"description":"Array of time intervals in the response data. Each interval is represented as an array containing two values: the start time, and the end time.\n","items":{"description":"Array with exactly two items, representing the start and end time (respectively) of this time interval.","items":{"description":"Time value.","example":"2023-11-11T12:00:00Z","format":"date-time","type":"string"},"type":"array"},"type":"array"}},"required":["time_intervals","query","data"],"type":"object"}],"type":"object"},"dns-analytics_result":{"properties":{"data":{"$ref":"#/components/schemas/dns-analytics_data"},"data_lag":{"description":"Number of seconds between current time and last processed event, in another words how many seconds of data could be missing.","example":60,"minimum":0,"type":"number"},"max":{"description":"Maximum results for each metric (object mapping metric names to values). Currently always an empty object.","type":"object"},"min":{"description":"Minimum results for each metric (object mapping metric names to values). Currently always an empty object.","type":"object"},"query":{"$ref":"#/components/schemas/dns-analytics_query"},"rows":{"description":"Total number of rows in the result.","example":100,"minimum":0,"type":"number"},"totals":{"description":"Total results for metrics across all data (object mapping metric names to values).","type":"object"}},"required":["rows","totals","min","max","data_lag","query","data"],"type":"object"},"dns-analytics_since":{"description":"Start date and time of requesting data period in ISO 8601 format.","example":"2023-11-11T12:00:00Z","format":"date-time","type":"string"},"dns-analytics_sort":{"description":"A comma-separated list of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).","example":"+responseCode,-queryName","type":"string"},"dns-analytics_time_delta":{"description":"Unit of time to group data by.","enum":["all","auto","year","quarter","month","week","day","hour","dekaminute","minute"],"example":"hour","type":"string"},"dns-analytics_until":{"description":"End date and time of requesting data period in ISO 8601 format.","example":"2023-11-11T13:00:00Z","format":"date-time","type":"string"},"dns-custom-nameservers_CustomNS":{"description":"A single account custom nameserver.","properties":{"dns_records":{"description":"A and AAAA records associated with the nameserver.","items":{"properties":{"type":{"description":"DNS record type.","enum":["A","AAAA"],"example":"A","type":"string","x-auditable":true},"value":{"description":"DNS record contents (an IPv4 or IPv6 address).","example":"1.1.1.1","type":"string","x-auditable":true}},"type":"object"},"type":"array","x-stainless-collection-type":"set"},"ns_name":{"$ref":"#/components/schemas/dns-custom-nameservers_ns_name"},"ns_set":{"$ref":"#/components/schemas/dns-custom-nameservers_ns_set"},"status":{"deprecated":true,"description":"Verification status of the nameserver.","enum":["moved","pending","verified"],"example":"verified","type":"string","x-auditable":true},"zone_tag":{"$ref":"#/components/schemas/dns-custom-nameservers_schemas-identifier"}},"required":["dns_records","ns_name","status","zone_tag"],"title":"Custom NS","type":"object"},"dns-custom-nameservers_CustomNSInput":{"properties":{"ns_name":{"$ref":"#/components/schemas/dns-custom-nameservers_ns_name"},"ns_set":{"$ref":"#/components/schemas/dns-custom-nameservers_ns_set"}},"required":["ns_name"],"title":"Custom NS Input","type":"object"},"dns-custom-nameservers_acns_response_collection":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dns-custom-nameservers_CustomNS"},"type":"array"}},"type":"object"}],"type":"object"},"dns-custom-nameservers_acns_response_single":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-custom-nameservers_CustomNS"}},"type":"object"}],"type":"object"},"dns-custom-nameservers_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"dns-custom-nameservers_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/dns-custom-nameservers_messages"},"messages":{"$ref":"#/components/schemas/dns-custom-nameservers_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"dns-custom-nameservers_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"dns-custom-nameservers_api-response-single":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_api-response-common"}],"type":"object"},"dns-custom-nameservers_empty_response":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_api-response-collection"},{"properties":{"result":{"items":{"description":"Unused","type":"string","x-auditable":true},"maxItems":0,"type":"array"}},"type":"object"}],"type":"object"},"dns-custom-nameservers_get_response":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_api-response-collection"},{"$ref":"#/components/schemas/dns-custom-nameservers_zone_metadata"}],"type":"object"},"dns-custom-nameservers_identifier":{"description":"Account identifier tag.","example":"372e67954025e0ba6aaa6d586b9e0b59","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"dns-custom-nameservers_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"dns-custom-nameservers_ns_name":{"description":"The FQDN of the name server.","example":"ns1.example.com","format":"hostname","type":"string","x-auditable":true},"dns-custom-nameservers_ns_set":{"default":1,"description":"The number of the set that this name server belongs to.","example":1,"maximum":5,"minimum":1,"type":"number","x-auditable":true},"dns-custom-nameservers_schemas-empty_response":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_api-response-collection"},{"properties":{"result":{"items":{"description":"Unused","type":"string","x-auditable":true},"maxItems":0,"type":"array"}},"type":"object"}],"type":"object"},"dns-custom-nameservers_schemas-identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"dns-custom-nameservers_zone_metadata":{"properties":{"enabled":{"description":"Whether zone uses account-level custom nameservers.","example":true,"type":"boolean","x-auditable":true},"ns_set":{"default":1,"description":"The number of the name server set to assign to the zone.","example":1,"maximum":5,"minimum":1,"type":"number","x-auditable":true}},"type":"object"},"dns-firewall_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"dns-firewall_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/dns-firewall_messages"},"messages":{"$ref":"#/components/schemas/dns-firewall_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"dns-firewall_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"dns-firewall_api-response-single":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_api-response-common"}],"type":"object"},"dns-firewall_attack_mitigation":{"description":"Attack mitigation settings","nullable":true,"properties":{"enabled":{"description":"When enabled, automatically mitigate random-prefix attacks to protect upstream DNS servers","example":true,"type":"boolean","x-auditable":true},"only_when_upstream_unhealthy":{"default":true,"description":"Only mitigate attacks when upstream servers seem unhealthy","example":false,"type":"boolean","x-auditable":true}},"type":"object"},"dns-firewall_deprecate_any_requests":{"description":"Whether to refuse to answer queries for the ANY type","example":true,"type":"boolean","x-auditable":true},"dns-firewall_dns-firewall-cluster":{"properties":{"attack_mitigation":{"$ref":"#/components/schemas/dns-firewall_attack_mitigation"},"deprecate_any_requests":{"$ref":"#/components/schemas/dns-firewall_deprecate_any_requests"},"ecs_fallback":{"$ref":"#/components/schemas/dns-firewall_ecs_fallback"},"maximum_cache_ttl":{"$ref":"#/components/schemas/dns-firewall_maximum_cache_ttl"},"minimum_cache_ttl":{"$ref":"#/components/schemas/dns-firewall_minimum_cache_ttl"},"name":{"$ref":"#/components/schemas/dns-firewall_name"},"negative_cache_ttl":{"$ref":"#/components/schemas/dns-firewall_negative_cache_ttl"},"ratelimit":{"$ref":"#/components/schemas/dns-firewall_ratelimit"},"retries":{"$ref":"#/components/schemas/dns-firewall_retries"},"upstream_ips":{"$ref":"#/components/schemas/dns-firewall_upstream_ips"}},"type":"object"},"dns-firewall_dns-firewall-cluster-patch":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_dns-firewall-cluster"}],"type":"object"},"dns-firewall_dns-firewall-cluster-post":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_dns-firewall-cluster"}],"required":["name","upstream_ips"],"type":"object"},"dns-firewall_dns-firewall-cluster-response":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_dns-firewall-cluster"},{"properties":{"dns_firewall_ips":{"$ref":"#/components/schemas/dns-firewall_dns_firewall_ips"},"id":{"$ref":"#/components/schemas/dns-firewall_identifier"},"modified_on":{"$ref":"#/components/schemas/dns-firewall_modified_on"}},"required":["id","dns_firewall_ips","modified_on"],"type":"object"}],"required":["name","upstream_ips","minimum_cache_ttl","maximum_cache_ttl","negative_cache_ttl","deprecate_any_requests","ecs_fallback","ratelimit","retries"],"type":"object"},"dns-firewall_dns-firewall-reverse-dns":{"properties":{"ptr":{"additionalProperties":{"description":"PTR record content","type":"string"},"description":"Map of cluster IP addresses to PTR record contents","type":"object"}},"type":"object"},"dns-firewall_dns-firewall-reverse-dns-patch":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_dns-firewall-reverse-dns"}],"type":"object"},"dns-firewall_dns-firewall-reverse-dns-response":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_dns-firewall-reverse-dns"}],"required":["ptr"],"type":"object"},"dns-firewall_dns_firewall_ips":{"example":["203.0.113.1","203.0.113.254","2001:DB8:AB::CF","2001:DB8:CD::CF"],"items":{"anyOf":[{"description":"Cloudflare-assigned DNS IPv4 address","example":"203.0.113.1","format":"ipv4","type":"string","x-auditable":true},{"description":"Cloudflare-assigned DNS IPv6 address","example":"2001:DB8:ab::CF","format":"ipv6","type":"string","x-auditable":true}],"type":"string"},"type":"array","x-stainless-collection-type":"set"},"dns-firewall_dns_firewall_response_collection":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dns-firewall_dns-firewall-cluster-response"},"type":"array"}},"type":"object"}],"type":"object"},"dns-firewall_dns_firewall_reverse_dns_response":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-firewall_dns-firewall-reverse-dns-response"}},"type":"object"}],"type":"object"},"dns-firewall_dns_firewall_single_response":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-firewall_dns-firewall-cluster-response"}},"type":"object"}],"type":"object"},"dns-firewall_ecs_fallback":{"description":"Whether to forward client IP (resolver) subnet if no EDNS Client Subnet is sent","example":false,"type":"boolean","x-auditable":true},"dns-firewall_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"dns-firewall_maximum_cache_ttl":{"default":900,"description":"By default, Cloudflare attempts to cache responses for as long as\nindicated by the TTL received from upstream nameservers. This setting\nsets an upper bound on this duration. For caching purposes, higher TTLs\nwill be decreased to the maximum value defined by this setting.\n\nThis setting does not affect the TTL value in the DNS response\nCloudflare returns to clients. Cloudflare will always forward the TTL\nvalue received from upstream nameservers.\n","example":900,"maximum":36000,"minimum":30,"type":"number","x-auditable":true},"dns-firewall_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"dns-firewall_minimum_cache_ttl":{"default":60,"description":"By default, Cloudflare attempts to cache responses for as long as\nindicated by the TTL received from upstream nameservers. This setting\nsets a lower bound on this duration. For caching purposes, lower TTLs\nwill be increased to the minimum value defined by this setting.\n\nThis setting does not affect the TTL value in the DNS response\nCloudflare returns to clients. Cloudflare will always forward the TTL\nvalue received from upstream nameservers.\n\nNote that, even with this setting, there is no guarantee that a\nresponse will be cached for at least the specified duration. Cached\nresponses may be removed earlier for capacity or other operational\nreasons.\n","example":60,"maximum":36000,"minimum":30,"type":"number","x-auditable":true},"dns-firewall_modified_on":{"description":"Last modification of DNS Firewall cluster","example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true},"dns-firewall_name":{"description":"DNS Firewall cluster name","example":"My Awesome DNS Firewall cluster","maxLength":160,"minLength":1,"type":"string","x-auditable":true},"dns-firewall_negative_cache_ttl":{"description":"This setting controls how long DNS Firewall should cache negative\nresponses (e.g., NXDOMAIN) from the upstream servers.\n\nThis setting does not affect the TTL value in the DNS response\nCloudflare returns to clients. Cloudflare will always forward the TTL\nvalue received from upstream nameservers.\n","example":900,"maximum":36000,"minimum":30,"nullable":true,"type":"number","x-auditable":true},"dns-firewall_ratelimit":{"description":"Ratelimit in queries per second per datacenter (applies to DNS queries sent to the upstream nameservers configured on the cluster)","example":600,"maximum":1000000000,"minimum":100,"nullable":true,"type":"number","x-auditable":true},"dns-firewall_retries":{"default":2,"description":"Number of retries for fetching DNS responses from upstream nameservers (not counting the initial attempt)","example":2,"maximum":2,"minimum":0,"type":"number","x-auditable":true},"dns-firewall_upstream_ips":{"example":["192.0.2.1","198.51.100.1","2001:DB8:100::CF"],"items":{"anyOf":[{"description":"Upstream DNS Server IPv4 address","example":"192.0.2.1","format":"ipv4","type":"string","x-auditable":true},{"description":"Upstream DNS Server IPv6 address","example":"2001:DB8:100::CF","format":"ipv6","type":"string","x-auditable":true}],"type":"string"},"minLength":1,"type":"array","x-stainless-collection-type":"set"},"dns-records_AAAARecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"A valid IPv6 address.","example":"2400:cb00:2049::1","format":"ipv6","type":"string","x-auditable":true},"type":{"description":"Record type.","enum":["AAAA"],"example":"AAAA","type":"string","x-auditable":true}},"type":"object"}],"title":"AAAA Record","type":"object"},"dns-records_ARecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"A valid IPv4 address.","example":"198.51.100.4","format":"ipv4","type":"string","x-auditable":true},"type":{"description":"Record type.","enum":["A"],"example":"A","type":"string","x-auditable":true}},"type":"object"}],"title":"A Record","type":"object"},"dns-records_CAARecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Formatted CAA content. See 'data' to set CAA properties.","readOnly":true,"type":"string","x-auditable":true},"data":{"description":"Components of a CAA record.","properties":{"flags":{"description":"Flags for the CAA record.","example":1,"maximum":255,"minimum":0,"type":"number","x-auditable":true},"tag":{"description":"Name of the property controlled by this record (e.g.: issue, issuewild, iodef).","example":"issue","type":"string","x-auditable":true},"value":{"description":"Value of the record. This field's semantics depend on the chosen tag.","type":"string","x-auditable":true}},"type":"object"},"type":{"description":"Record type.","enum":["CAA"],"example":"CAA","type":"string","x-auditable":true}},"type":"object"}],"title":"CAA Record","type":"object"},"dns-records_CERTRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Formatted CERT content. See 'data' to set CERT properties.","readOnly":true,"type":"string","x-auditable":true},"data":{"description":"Components of a CERT record.","properties":{"algorithm":{"description":"Algorithm.","example":8,"maximum":255,"minimum":0,"type":"number","x-auditable":true},"certificate":{"description":"Certificate.","type":"string","x-auditable":true},"key_tag":{"description":"Key Tag.","example":1,"maximum":65535,"minimum":0,"type":"number","x-auditable":true},"type":{"description":"Type.","example":9,"maximum":65535,"minimum":0,"type":"number","x-auditable":true}},"type":"object"},"type":{"description":"Record type.","enum":["CERT"],"example":"CERT","type":"string","x-auditable":true}},"type":"object"}],"title":"CERT Record","type":"object"},"dns-records_CNAMERecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"A valid hostname. Must not match the record's name.","type":"string","x-auditable":true},"settings":{"properties":{"flatten_cname":{"default":false,"description":"If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.","example":true,"type":"boolean","x-auditable":true}},"type":"object"},"type":{"description":"Record type.","enum":["CNAME"],"example":"CNAME","type":"string","x-auditable":true}},"type":"object"}],"title":"CNAME Record","type":"object"},"dns-records_DNSKEYRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Formatted DNSKEY content. See 'data' to set DNSKEY properties.","readOnly":true,"type":"string","x-auditable":true},"data":{"description":"Components of a DNSKEY record.","properties":{"algorithm":{"description":"Algorithm.","example":5,"maximum":255,"minimum":0,"type":"number","x-auditable":true},"flags":{"description":"Flags.","example":1,"maximum":65535,"minimum":0,"type":"number","x-auditable":true},"protocol":{"description":"Protocol.","example":3,"maximum":255,"minimum":0,"type":"number","x-auditable":true},"public_key":{"description":"Public Key.","type":"string","x-auditable":true}},"type":"object"},"type":{"description":"Record type.","enum":["DNSKEY"],"example":"DNSKEY","type":"string","x-auditable":true}},"type":"object"}],"title":"DNSKEY Record","type":"object"},"dns-records_DSRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Formatted DS content. See 'data' to set DS properties.","readOnly":true,"type":"string","x-auditable":true},"data":{"description":"Components of a DS record.","properties":{"algorithm":{"description":"Algorithm.","example":3,"maximum":255,"minimum":0,"type":"number","x-auditable":true},"digest":{"description":"Digest.","type":"string","x-auditable":true},"digest_type":{"description":"Digest Type.","example":1,"maximum":255,"minimum":0,"type":"number","x-auditable":true},"key_tag":{"description":"Key Tag.","example":1,"maximum":65535,"minimum":0,"type":"number","x-auditable":true}},"type":"object"},"type":{"description":"Record type.","enum":["DS"],"example":"DS","type":"string","x-auditable":true}},"type":"object"}],"title":"DS Record","type":"object"},"dns-records_HTTPSRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Formatted HTTPS content. See 'data' to set HTTPS properties.","readOnly":true,"type":"string","x-auditable":true},"data":{"description":"Components of a HTTPS record.","properties":{"priority":{"description":"Priority.","example":1,"maximum":65535,"minimum":0,"type":"number","x-auditable":true},"target":{"description":"Target.","example":".","type":"string","x-auditable":true},"value":{"description":"Value.","example":"alpn=\"h3,h2\" ipv4hint=\"127.0.0.1\" ipv6hint=\"::1\"","type":"string","x-auditable":true}},"type":"object"},"type":{"description":"Record type.","enum":["HTTPS"],"example":"HTTPS","type":"string","x-auditable":true}},"type":"object"}],"title":"HTTPS Record","type":"object"},"dns-records_LOCRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Formatted LOC content. See 'data' to set LOC properties.","example":"IN LOC 37 46 46 N 122 23 35 W 0m 100m 0m 0m","readOnly":true,"type":"string","x-auditable":true},"data":{"description":"Components of a LOC record.","properties":{"altitude":{"description":"Altitude of location in meters.","example":0,"maximum":42849672.95,"minimum":-100000,"type":"number","x-auditable":true},"lat_degrees":{"description":"Degrees of latitude.","example":37,"maximum":90,"minimum":0,"type":"number","x-auditable":true},"lat_direction":{"description":"Latitude direction.","enum":["N","S"],"example":"N","type":"string","x-auditable":true},"lat_minutes":{"description":"Minutes of latitude.","example":46,"maximum":59,"minimum":0,"type":"number","x-auditable":true},"lat_seconds":{"description":"Seconds of latitude.","example":46,"maximum":59.999,"minimum":0,"type":"number","x-auditable":true},"long_degrees":{"description":"Degrees of longitude.","example":122,"maximum":180,"minimum":0,"type":"number","x-auditable":true},"long_direction":{"description":"Longitude direction.","enum":["E","W"],"example":"W","type":"string","x-auditable":true},"long_minutes":{"description":"Minutes of longitude.","example":23,"maximum":59,"minimum":0,"type":"number","x-auditable":true},"long_seconds":{"description":"Seconds of longitude.","example":35,"maximum":59.999,"minimum":0,"type":"number","x-auditable":true},"precision_horz":{"description":"Horizontal precision of location.","example":0,"maximum":90000000,"minimum":0,"type":"number","x-auditable":true},"precision_vert":{"description":"Vertical precision of location.","example":0,"maximum":90000000,"minimum":0,"type":"number","x-auditable":true},"size":{"description":"Size of location in meters.","example":100,"maximum":90000000,"minimum":0,"type":"number","x-auditable":true}},"type":"object"},"type":{"description":"Record type.","enum":["LOC"],"example":"LOC","type":"string","x-auditable":true}},"type":"object"}],"title":"LOC Record","type":"object"},"dns-records_MXRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"A valid mail server hostname.","example":"mx.example.com","format":"hostname","type":"string","x-auditable":true},"priority":{"$ref":"#/components/schemas/dns-records_priority"},"type":{"description":"Record type.","enum":["MX"],"example":"MX","type":"string","x-auditable":true}},"type":"object"}],"title":"MX Record","type":"object"},"dns-records_NAPTRRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Formatted NAPTR content. See 'data' to set NAPTR properties.","readOnly":true,"type":"string","x-auditable":true},"data":{"description":"Components of a NAPTR record.","properties":{"flags":{"description":"Flags.","type":"string","x-auditable":true},"order":{"description":"Order.","example":100,"maximum":65535,"minimum":0,"type":"number","x-auditable":true},"preference":{"description":"Preference.","example":10,"maximum":65535,"minimum":0,"type":"number","x-auditable":true},"regex":{"description":"Regex.","type":"string","x-auditable":true},"replacement":{"description":"Replacement.","type":"string","x-auditable":true},"service":{"description":"Service.","type":"string","x-auditable":true}},"type":"object"},"type":{"description":"Record type.","enum":["NAPTR"],"example":"NAPTR","type":"string","x-auditable":true}},"type":"object"}],"title":"NAPTR Record","type":"object"},"dns-records_NSRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"A valid name server host name.","example":"ns1.example.com","type":"string","x-auditable":true},"type":{"description":"Record type.","enum":["NS"],"example":"NS","type":"string","x-auditable":true}},"type":"object"}],"title":"NS Record","type":"object"},"dns-records_OPENPGPKEYRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"A single Base64-encoded OpenPGP Transferable Public Key (RFC 4880 Section 11.1)","type":"string","x-auditable":true},"type":{"description":"Record type.","enum":["OPENPGPKEY"],"example":"OPENPGPKEY","type":"string","x-auditable":true}},"type":"object"}],"title":"OPENPGPKEY Record","type":"object"},"dns-records_PTRRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Domain name pointing to the address.","example":"example.com","type":"string","x-auditable":true},"type":{"description":"Record type.","enum":["PTR"],"example":"PTR","type":"string","x-auditable":true}},"type":"object"}],"title":"PTR Record","type":"object"},"dns-records_SMIMEARecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Formatted SMIMEA content. See 'data' to set SMIMEA properties.","readOnly":true,"type":"string","x-auditable":true},"data":{"description":"Components of a SMIMEA record.","properties":{"certificate":{"description":"Certificate.","type":"string","x-auditable":true},"matching_type":{"description":"Matching Type.","example":0,"maximum":255,"minimum":0,"type":"number","x-auditable":true},"selector":{"description":"Selector.","example":0,"maximum":255,"minimum":0,"type":"number","x-auditable":true},"usage":{"description":"Usage.","example":3,"maximum":255,"minimum":0,"type":"number","x-auditable":true}},"type":"object"},"type":{"description":"Record type.","enum":["SMIMEA"],"example":"SMIMEA","type":"string","x-auditable":true}},"type":"object"}],"title":"SMIMEA Record","type":"object"},"dns-records_SRVRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Priority, weight, port, and SRV target. See 'data' for setting the individual component values.","example":"10 IN SRV 5 8806 example.com.","readOnly":true,"type":"string","x-auditable":true},"data":{"description":"Components of a SRV record.","properties":{"port":{"description":"The port of the service.","example":8806,"maximum":65535,"minimum":0,"type":"number","x-auditable":true},"priority":{"$ref":"#/components/schemas/dns-records_priority"},"target":{"description":"A valid hostname.","example":"example.com","format":"hostname","type":"string","x-auditable":true},"weight":{"description":"The record weight.","example":5,"maximum":65535,"minimum":0,"type":"number","x-auditable":true}},"type":"object"},"type":{"description":"Record type.","enum":["SRV"],"example":"SRV","type":"string","x-auditable":true}},"type":"object"}],"title":"SRV Record","type":"object"},"dns-records_SSHFPRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Formatted SSHFP content. See 'data' to set SSHFP properties.","readOnly":true,"type":"string","x-auditable":true},"data":{"description":"Components of a SSHFP record.","properties":{"algorithm":{"description":"Algorithm.","example":2,"maximum":255,"minimum":0,"type":"number","x-auditable":true},"fingerprint":{"description":"Fingerprint.","type":"string","x-auditable":true},"type":{"description":"Type.","example":1,"maximum":255,"minimum":0,"type":"number","x-auditable":true}},"type":"object"},"type":{"description":"Record type.","enum":["SSHFP"],"example":"SSHFP","type":"string","x-auditable":true}},"type":"object"}],"title":"SSHFP Record","type":"object"},"dns-records_SVCBRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Formatted SVCB content. See 'data' to set SVCB properties.","readOnly":true,"type":"string","x-auditable":true},"data":{"description":"Components of a SVCB record.","properties":{"priority":{"description":"Priority.","example":1,"maximum":65535,"minimum":0,"type":"number","x-auditable":true},"target":{"description":"Target.","example":".","type":"string","x-auditable":true},"value":{"description":"Value.","example":"alpn=\"h3,h2\" ipv4hint=\"127.0.0.1\" ipv6hint=\"::1\"","type":"string","x-auditable":true}},"type":"object"},"type":{"description":"Record type.","enum":["SVCB"],"example":"SVCB","type":"string","x-auditable":true}},"type":"object"}],"title":"SVCB Record","type":"object"},"dns-records_TLSARecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Formatted TLSA content. See 'data' to set TLSA properties.","readOnly":true,"type":"string","x-auditable":true},"data":{"description":"Components of a TLSA record.","properties":{"certificate":{"description":"Certificate.","type":"string","x-auditable":true},"matching_type":{"description":"Matching Type.","example":1,"maximum":255,"minimum":0,"type":"number","x-auditable":true},"selector":{"description":"Selector.","example":0,"maximum":255,"minimum":0,"type":"number","x-auditable":true},"usage":{"description":"Usage.","example":0,"maximum":255,"minimum":0,"type":"number","x-auditable":true}},"type":"object"},"type":{"description":"Record type.","enum":["TLSA"],"example":"TLSA","type":"string","x-auditable":true}},"type":"object"}],"title":"TLSA Record","type":"object"},"dns-records_TXTRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Text content for the record. The content must consist of quoted \"character strings\" (RFC 1035), each with a length of up to 255 bytes. Strings exceeding this allowed maximum length are automatically split.\n\nLearn more at \u003chttps://www.cloudflare.com/learning/dns/dns-records/dns-txt-record/\u003e.","example":"\"v=spf1 include:example.com -all\"","type":"string","x-auditable":true},"type":{"description":"Record type.","enum":["TXT"],"example":"TXT","type":"string","x-auditable":true}},"type":"object"}],"title":"TXT Record","type":"object"},"dns-records_URIRecord":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-shared-fields"},{"properties":{"content":{"description":"Formatted URI content. See 'data' to set URI properties.","readOnly":true,"type":"string","x-auditable":true},"data":{"description":"Components of a URI record.","properties":{"target":{"description":"The record content.","example":"http://example.com/example.html","type":"string","x-auditable":true},"weight":{"description":"The record weight.","example":20,"maximum":65535,"minimum":0,"type":"number","x-auditable":true}},"type":"object"},"priority":{"$ref":"#/components/schemas/dns-records_priority"},"type":{"description":"Record type.","enum":["URI"],"example":"URI","type":"string","x-auditable":true}},"type":"object"}],"title":"URI Record","type":"object"},"dns-records_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/dns-records_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"dns-records_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/dns-records_messages"},"messages":{"$ref":"#/components/schemas/dns-records_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"dns-records_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/dns-records_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/dns-records_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"dns-records_api-response-single":{"allOf":[{"$ref":"#/components/schemas/dns-records_api-response-common"}],"type":"object"},"dns-records_comment":{"description":"Comments or notes about the DNS record. This field has no effect on DNS responses.","example":"Domain verification record","type":"string","x-auditable":true},"dns-records_direction":{"default":"asc","description":"Direction to order DNS records in.","enum":["asc","desc"],"type":"string"},"dns-records_dns-record-batch-delete":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/dns-records_identifier"}},"type":"object"}],"required":["id"],"type":"object"},"dns-records_dns-record-batch-patch":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-patch"}],"properties":{"id":{"$ref":"#/components/schemas/dns-records_identifier"}},"required":["id"],"type":"object"},"dns-records_dns-record-batch-post":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-post"}],"type":"object"},"dns-records_dns-record-batch-put":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-post"}],"properties":{"id":{"$ref":"#/components/schemas/dns-records_identifier"}},"required":["id"],"type":"object"},"dns-records_dns-record-patch":{"anyOf":[{"$ref":"#/components/schemas/dns-records_dns-record-without-data"},{"$ref":"#/components/schemas/dns-records_dns-record-with-data"}],"type":"object"},"dns-records_dns-record-post":{"anyOf":[{"$ref":"#/components/schemas/dns-records_dns-record-without-data"},{"$ref":"#/components/schemas/dns-records_dns-record-with-data"}],"type":"object"},"dns-records_dns-record-response":{"allOf":[{"anyOf":[{"$ref":"#/components/schemas/dns-records_dns-record-without-data"},{"$ref":"#/components/schemas/dns-records_dns-record-with-data"}],"type":"object"},{"properties":{"comment_modified_on":{"description":"When the record comment was last modified. Omitted if there is no comment.","example":"2024-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-stainless-terraform-configurability":"computed"},"created_on":{"description":"When the record was created.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-stainless-terraform-configurability":"computed"},"id":{"$ref":"#/components/schemas/dns-records_identifier"},"meta":{"description":"Extra Cloudflare-specific information about the record.","readOnly":true,"type":"object","x-stainless-terraform-configurability":"computed"},"modified_on":{"description":"When the record was last modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-stainless-terraform-configurability":"computed"},"proxiable":{"description":"Whether the record can be proxied by Cloudflare or not.","example":true,"readOnly":true,"type":"boolean","x-stainless-terraform-configurability":"computed"},"tags_modified_on":{"description":"When the record tags were last modified. Omitted if there are no tags.","example":"2025-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-stainless-terraform-configurability":"computed"}},"required":["id","proxiable","created_on","modified_on","meta"],"type":"object"}],"discriminator":{"propertyName":"type"},"required":["name","type","content","data","proxied","ttl","settings","comment","tags"],"type":"object"},"dns-records_dns-record-scan-batch-accept":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns-record-patch"}],"type":"object"},"dns-records_dns-record-scan-batch-reject":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/dns-records_identifier"}},"type":"object"}],"required":["id"],"type":"object"},"dns-records_dns-record-shared-fields":{"properties":{"comment":{"$ref":"#/components/schemas/dns-records_comment"},"name":{"$ref":"#/components/schemas/dns-records_name"},"proxied":{"$ref":"#/components/schemas/dns-records_proxied"},"settings":{"$ref":"#/components/schemas/dns-records_settings"},"tags":{"$ref":"#/components/schemas/dns-records_tags"},"ttl":{"$ref":"#/components/schemas/dns-records_ttl"}},"type":"object"},"dns-records_dns-record-with-data":{"oneOf":[{"$ref":"#/components/schemas/dns-records_CAARecord"},{"$ref":"#/components/schemas/dns-records_CERTRecord"},{"$ref":"#/components/schemas/dns-records_DNSKEYRecord"},{"$ref":"#/components/schemas/dns-records_DSRecord"},{"$ref":"#/components/schemas/dns-records_HTTPSRecord"},{"$ref":"#/components/schemas/dns-records_LOCRecord"},{"$ref":"#/components/schemas/dns-records_NAPTRRecord"},{"$ref":"#/components/schemas/dns-records_SMIMEARecord"},{"$ref":"#/components/schemas/dns-records_SRVRecord"},{"$ref":"#/components/schemas/dns-records_SSHFPRecord"},{"$ref":"#/components/schemas/dns-records_SVCBRecord"},{"$ref":"#/components/schemas/dns-records_TLSARecord"},{"$ref":"#/components/schemas/dns-records_URIRecord"}],"type":"object"},"dns-records_dns-record-without-data":{"oneOf":[{"$ref":"#/components/schemas/dns-records_ARecord"},{"$ref":"#/components/schemas/dns-records_AAAARecord"},{"$ref":"#/components/schemas/dns-records_CNAMERecord"},{"$ref":"#/components/schemas/dns-records_MXRecord"},{"$ref":"#/components/schemas/dns-records_NSRecord"},{"$ref":"#/components/schemas/dns-records_OPENPGPKEYRecord"},{"$ref":"#/components/schemas/dns-records_PTRRecord"},{"$ref":"#/components/schemas/dns-records_TXTRecord"}],"type":"object"},"dns-records_dns-request-batch-object":{"properties":{"deletes":{"items":{"$ref":"#/components/schemas/dns-records_dns-record-batch-delete"},"type":"array"},"patches":{"items":{"$ref":"#/components/schemas/dns-records_dns-record-batch-patch"},"type":"array"},"posts":{"items":{"$ref":"#/components/schemas/dns-records_dns-record-batch-post"},"type":"array"},"puts":{"items":{"$ref":"#/components/schemas/dns-records_dns-record-batch-put"},"type":"array"}},"type":"object"},"dns-records_dns-request-review-scan-object":{"properties":{"accepts":{"items":{"$ref":"#/components/schemas/dns-records_dns-record-scan-batch-accept"},"type":"array"},"rejects":{"items":{"$ref":"#/components/schemas/dns-records_dns-record-scan-batch-reject"},"type":"array"}},"type":"object"},"dns-records_dns-response-batch-object":{"properties":{"deletes":{"items":{"$ref":"#/components/schemas/dns-records_dns-record-response"},"type":"array"},"patches":{"items":{"$ref":"#/components/schemas/dns-records_dns-record-response"},"type":"array"},"posts":{"items":{"$ref":"#/components/schemas/dns-records_dns-record-response"},"type":"array"},"puts":{"items":{"$ref":"#/components/schemas/dns-records_dns-record-response"},"type":"array"}},"type":"object"},"dns-records_dns-response-review-scan-object":{"properties":{"accepts":{"items":{"$ref":"#/components/schemas/dns-records_dns-record-response"},"type":"array"},"rejects":{"items":{"$ref":"#/components/schemas/dns-records_identifier"},"type":"array"}},"type":"object"},"dns-records_dns_response_batch":{"allOf":[{"$ref":"#/components/schemas/dns-records_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-records_dns-response-batch-object"}},"type":"object"}],"type":"object"},"dns-records_dns_response_collection":{"allOf":[{"$ref":"#/components/schemas/dns-records_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dns-records_dns-record-response"},"type":"array"}},"type":"object"}],"type":"object"},"dns-records_dns_response_import_scan":{"allOf":[{"$ref":"#/components/schemas/dns-records_api-response-single"},{"properties":{"result":{"properties":{"recs_added":{"description":"Number of DNS records added.","example":5,"type":"number"},"total_records_parsed":{"description":"Total number of DNS records parsed.","example":5,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"dns-records_dns_response_review_scan":{"allOf":[{"$ref":"#/components/schemas/dns-records_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-records_dns-response-review-scan-object"}},"type":"object"}],"type":"object"},"dns-records_dns_response_single":{"allOf":[{"$ref":"#/components/schemas/dns-records_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-records_dns-record-response"}},"type":"object"}],"type":"object"},"dns-records_dns_response_trigger_scan":{"allOf":[{"$ref":"#/components/schemas/dns-records_api-response-single"}],"type":"object"},"dns-records_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"dns-records_match":{"default":"all","description":"Whether to match all search requirements or at least one (any). If set to `all`, acts like a logical AND between filters. If set to `any`, acts like a logical OR instead. Note that the interaction between tag filters is controlled by the `tag-match` parameter instead.\n","enum":["any","all"],"example":"any","type":"string"},"dns-records_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"dns-records_name":{"description":"Complete DNS record name, including the zone name, in Punycode.","example":"example.com","maxLength":255,"minLength":1,"type":"string","x-auditable":true},"dns-records_order":{"default":"type","description":"Field to order DNS records by.","enum":["type","name","content","ttl","proxied"],"type":"string"},"dns-records_page":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"},"dns-records_per_page":{"default":100,"description":"Number of DNS records per page.","example":5,"maximum":5000000,"minimum":1,"type":"number"},"dns-records_priority":{"description":"Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.","example":10,"maximum":65535,"minimum":0,"type":"number","x-auditable":true},"dns-records_proxied":{"default":false,"description":"Whether the record is receiving the performance and security benefits of Cloudflare.","example":true,"type":"boolean","x-auditable":true},"dns-records_search":{"description":"Allows searching in multiple properties of a DNS record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future. This parameter works independently of the `match` setting. For automated searches, please use the other available parameters.\n","example":"www.cloudflare.com","type":"string"},"dns-records_settings":{"description":"Settings for the DNS record.","properties":{"ipv4_only":{"default":false,"description":"When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.","example":true,"type":"boolean","x-auditable":true},"ipv6_only":{"default":false,"description":"When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.","example":true,"type":"boolean","x-auditable":true}},"type":"object"},"dns-records_tag_match":{"default":"all","description":"Whether to match all tag search requirements or at least one (any). If set to `all`, acts like a logical AND between tag filters. If set to `any`, acts like a logical OR instead. Note that the regular `match` parameter is still used to combine the resulting condition with other filters that aren't related to tags.\n","enum":["any","all"],"example":"any","type":"string"},"dns-records_tags":{"default":[],"description":"Custom tags for the DNS record. This field has no effect on DNS responses.","items":{"description":"Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens)","example":"owner:dns-team","type":"string","x-auditable":true},"type":"array","x-stainless-collection-type":"set"},"dns-records_ttl":{"anyOf":[{"example":3600,"maximum":86400,"minimum":30,"type":"number"},{"enum":[1],"type":"number"}],"default":1,"description":"Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.","example":3600,"type":"number","x-auditable":true},"dns-records_type":{"description":"Record type.","enum":["A","AAAA","CAA","CERT","CNAME","DNSKEY","DS","HTTPS","LOC","MX","NAPTR","NS","OPENPGPKEY","PTR","SMIMEA","SRV","SSHFP","SVCB","TLSA","TXT","URI"],"example":"A","type":"string","x-auditable":true},"dns-settings_account_settings":{"properties":{"zone_defaults":{"$ref":"#/components/schemas/dns-settings_dns-settings-account-response"}},"required":["zone_defaults"],"type":"object"},"dns-settings_account_settings_patch":{"properties":{"zone_defaults":{"$ref":"#/components/schemas/dns-settings_dns-settings-account-patch"}},"type":"object"},"dns-settings_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/dns-settings_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"dns-settings_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/dns-settings_messages"},"messages":{"$ref":"#/components/schemas/dns-settings_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"dns-settings_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/dns-settings_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/dns-settings_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"dns-settings_api-response-single":{"allOf":[{"$ref":"#/components/schemas/dns-settings_api-response-common"}],"type":"object"},"dns-settings_created_time":{"description":"When the view was created.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"dns-settings_direction":{"default":"asc","description":"Direction to order DNS views in.","enum":["asc","desc"],"type":"string"},"dns-settings_dns-settings-account-patch":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns-settings-patch"},{"properties":{"nameservers":{"description":"Settings determining the nameservers through which the zone should be available.","properties":{"type":{"description":"Nameserver type","enum":["cloudflare.standard","cloudflare.standard.random","custom.account","custom.tenant"],"example":"cloudflare.standard","type":"string","x-auditable":true}},"type":"object"}},"type":"object"}],"type":"object"},"dns-settings_dns-settings-account-response":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns-settings-response"},{"properties":{"nameservers":{"description":"Settings determining the nameservers through which the zone should be available.","properties":{"type":{"description":"Nameserver type","enum":["cloudflare.standard","cloudflare.standard.random","custom.account","custom.tenant"],"example":"cloudflare.standard","type":"string","x-auditable":true}},"required":["type"],"type":"object"}},"required":["nameservers"],"type":"object"}],"type":"object"},"dns-settings_dns-settings-base":{"properties":{"flatten_all_cnames":{"$ref":"#/components/schemas/dns-settings_flatten_all_cnames"},"foundation_dns":{"$ref":"#/components/schemas/dns-settings_foundation_dns"},"internal_dns":{"$ref":"#/components/schemas/dns-settings_internal_dns_base"},"multi_provider":{"$ref":"#/components/schemas/dns-settings_multi_provider"},"ns_ttl":{"$ref":"#/components/schemas/dns-settings_ns_ttl"},"secondary_overrides":{"$ref":"#/components/schemas/dns-settings_secondary_overrides"},"soa":{"$ref":"#/components/schemas/dns-settings_soa-base"},"zone_mode":{"$ref":"#/components/schemas/dns-settings_zone_mode"}},"type":"object"},"dns-settings_dns-settings-patch":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns-settings-base"}],"type":"object"},"dns-settings_dns-settings-response":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns-settings-base"},{"properties":{"internal_dns":{"$ref":"#/components/schemas/dns-settings_internal_dns_response"},"soa":{"$ref":"#/components/schemas/dns-settings_soa-response"}},"required":["flatten_all_cnames","foundation_dns","multi_provider","secondary_overrides","soa","ns_ttl","zone_mode","internal_dns"],"type":"object"}],"type":"object"},"dns-settings_dns-settings-zone-patch":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns-settings-patch"},{"properties":{"nameservers":{"description":"Settings determining the nameservers through which the zone should be available.","properties":{"ns_set":{"description":"Configured nameserver set to be used for this zone","example":1,"maximum":5,"minimum":1,"type":"integer","x-auditable":true},"type":{"description":"Nameserver type","enum":["cloudflare.standard","custom.account","custom.tenant","custom.zone"],"example":"cloudflare.standard","type":"string","x-auditable":true}},"type":"object"}},"type":"object"}],"type":"object"},"dns-settings_dns-settings-zone-response":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns-settings-response"},{"properties":{"nameservers":{"description":"Settings determining the nameservers through which the zone should be available.","properties":{"ns_set":{"description":"Configured nameserver set to be used for this zone","example":1,"maximum":5,"minimum":1,"type":"integer","x-auditable":true},"type":{"description":"Nameserver type","enum":["cloudflare.standard","custom.account","custom.tenant","custom.zone"],"example":"cloudflare.standard","type":"string","x-auditable":true}},"required":["type"],"type":"object"}},"required":["nameservers"],"type":"object"}],"type":"object"},"dns-settings_dns-view":{"properties":{"created_time":{"$ref":"#/components/schemas/dns-settings_created_time"},"modified_time":{"$ref":"#/components/schemas/dns-settings_modified_time"},"name":{"$ref":"#/components/schemas/dns-settings_name"},"zones":{"$ref":"#/components/schemas/dns-settings_zones"}},"type":"object"},"dns-settings_dns-view-patch":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns-view"}],"type":"object"},"dns-settings_dns-view-post":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns-view"}],"required":["name","zones"],"type":"object"},"dns-settings_dns-view-response":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns-view"},{"properties":{"id":{"$ref":"#/components/schemas/dns-settings_identifier"}},"required":["id"],"type":"object"}],"required":["id","name","zones","created_time","modified_time"],"type":"object"},"dns-settings_dns_response_single":{"allOf":[{"$ref":"#/components/schemas/dns-settings_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-settings_account_settings"}},"type":"object"}],"required":["result"],"type":"object"},"dns-settings_dns_view_response_collection":{"allOf":[{"$ref":"#/components/schemas/dns-settings_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dns-settings_dns-view-response"},"type":"array"}},"type":"object"}],"type":"object"},"dns-settings_dns_view_response_single":{"allOf":[{"$ref":"#/components/schemas/dns-settings_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-settings_dns-view-response"}},"type":"object"}],"type":"object"},"dns-settings_flatten_all_cnames":{"description":"Whether to flatten all CNAME records in the zone. Note that, due to DNS limitations, a CNAME record at the zone apex will always be flattened.","example":false,"type":"boolean","x-auditable":true},"dns-settings_foundation_dns":{"description":"Whether to enable Foundation DNS Advanced Nameservers on the zone.","example":false,"type":"boolean","x-auditable":true},"dns-settings_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"dns-settings_internal_dns_base":{"description":"Settings for this internal zone.","properties":{"reference_zone_id":{"description":"The ID of the zone to fallback to.","example":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"type":"string"}},"type":"object"},"dns-settings_internal_dns_response":{"allOf":[{"$ref":"#/components/schemas/dns-settings_internal_dns_base"},{"required":["reference_zone_id"],"type":"object"}],"type":"object"},"dns-settings_match":{"default":"all","description":"Whether to match all search requirements or at least one (any). If set to `all`, acts like a logical AND between filters. If set to `any`, acts like a logical OR instead.\n","enum":["any","all"],"example":"any","type":"string"},"dns-settings_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"dns-settings_modified_time":{"description":"When the view was last modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"dns-settings_multi_provider":{"description":"Whether to enable multi-provider DNS, which causes Cloudflare to activate the zone even when non-Cloudflare NS records exist, and to respect NS records at the zone apex during outbound zone transfers.","example":false,"type":"boolean","x-auditable":true},"dns-settings_name":{"description":"The name of the view.","example":"my view","maxLength":255,"minLength":1,"type":"string","x-auditable":true},"dns-settings_ns_ttl":{"description":"The time to live (TTL) of the zone's nameserver (NS) records.","example":86400,"maximum":86400,"minimum":30,"type":"number","x-auditable":true},"dns-settings_order":{"default":"type","description":"Field to order DNS views by.","enum":["name","created_on","modified_on"],"type":"string"},"dns-settings_page":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"},"dns-settings_per_page":{"default":100,"description":"Number of DNS views per page.","example":5,"maximum":5000000,"minimum":1,"type":"number"},"dns-settings_schemas-dns_response_single":{"allOf":[{"$ref":"#/components/schemas/dns-settings_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-settings_dns-settings-zone-response"}},"type":"object"}],"required":["result"],"type":"object"},"dns-settings_secondary_overrides":{"description":"Allows a Secondary DNS zone to use (proxied) override records and CNAME flattening at the zone apex.","example":false,"type":"boolean","x-auditable":true},"dns-settings_soa-base":{"description":"Components of the zone's SOA record.","properties":{"expire":{"description":"Time in seconds of being unable to query the primary server after which secondary servers should stop serving the zone.","example":604800,"maximum":2419200,"minimum":86400,"type":"number","x-auditable":true},"min_ttl":{"description":"The time to live (TTL) for negative caching of records within the zone.","example":1800,"maximum":86400,"minimum":60,"type":"number","x-auditable":true},"mname":{"description":"The primary nameserver, which may be used for outbound zone transfers. If null, a Cloudflare-assigned value will be used.","example":"kristina.ns.cloudflare.com","nullable":true,"type":"string","x-auditable":true},"refresh":{"description":"Time in seconds after which secondary servers should re-check the SOA record to see if the zone has been updated.","example":10000,"maximum":86400,"minimum":600,"type":"number","x-auditable":true},"retry":{"description":"Time in seconds after which secondary servers should retry queries after the primary server was unresponsive.","example":2400,"maximum":86400,"minimum":600,"type":"number","x-auditable":true},"rname":{"description":"The email address of the zone administrator, with the first label representing the local part of the email address.","example":"admin.example.com","type":"string","x-auditable":true},"ttl":{"description":"The time to live (TTL) of the SOA record itself.","example":3600,"maximum":86400,"minimum":300,"type":"number","x-auditable":true}},"type":"object"},"dns-settings_soa-response":{"allOf":[{"$ref":"#/components/schemas/dns-settings_soa-base"},{"required":["mname","rname","refresh","retry","expire","min_ttl","ttl"],"type":"object"}],"type":"object"},"dns-settings_zone_mode":{"description":"Whether the zone mode is a regular or CDN/DNS only zone.","enum":["standard","cdn_only","dns_only"],"example":"dns_only","type":"string","x-auditable":true},"dns-settings_zones":{"description":"The list of zones linked to this view.","items":{"description":"The zone ID.","example":"372e67954025e0ba6aaa6d586b9e0b59","maxLength":32,"minLength":32,"type":"string","x-auditable":true},"type":"array","x-stainless-collection-type":"set"},"dnssec_algorithm":{"description":"Algorithm key code.","example":"13","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"dnssec_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/dnssec_messages"},"messages":{"$ref":"#/components/schemas/dnssec_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"dnssec_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/dnssec_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/dnssec_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"dnssec_api-response-single":{"allOf":[{"$ref":"#/components/schemas/dnssec_api-response-common"}],"type":"object"},"dnssec_delete_dnssec_response_single":{"allOf":[{"$ref":"#/components/schemas/dnssec_api-response-single"},{"properties":{"result":{"example":"","type":"string"}},"type":"object"}]},"dnssec_digest":{"description":"Digest hash.","example":"48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"dnssec_digest_algorithm":{"description":"Type of digest algorithm.","example":"SHA256","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"dnssec_digest_type":{"description":"Coded type for digest algorithm.","example":"2","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"dnssec_dnssec":{"properties":{"algorithm":{"$ref":"#/components/schemas/dnssec_algorithm"},"digest":{"$ref":"#/components/schemas/dnssec_digest"},"digest_algorithm":{"$ref":"#/components/schemas/dnssec_digest_algorithm"},"digest_type":{"$ref":"#/components/schemas/dnssec_digest_type"},"dnssec_multi_signer":{"$ref":"#/components/schemas/dnssec_dnssec_multi_signer"},"dnssec_presigned":{"$ref":"#/components/schemas/dnssec_dnssec_presigned"},"dnssec_use_nsec3":{"$ref":"#/components/schemas/dnssec_dnssec_use_nsec3"},"ds":{"$ref":"#/components/schemas/dnssec_ds"},"flags":{"$ref":"#/components/schemas/dnssec_flags"},"key_tag":{"$ref":"#/components/schemas/dnssec_key_tag"},"key_type":{"$ref":"#/components/schemas/dnssec_key_type"},"modified_on":{"$ref":"#/components/schemas/dnssec_modified_on"},"public_key":{"$ref":"#/components/schemas/dnssec_public_key"},"status":{"$ref":"#/components/schemas/dnssec_status"}},"type":"object"},"dnssec_dnssec_multi_signer":{"description":"If true, multi-signer DNSSEC is enabled on the zone, allowing multiple\nproviders to serve a DNSSEC-signed zone at the same time.\nThis is required for DNSKEY records (except those automatically\ngenerated by Cloudflare) to be added to the zone.\n\nSee [Multi-signer DNSSEC](https://developers.cloudflare.com/dns/dnssec/multi-signer-dnssec/) for details.","example":false,"type":"boolean","x-auditable":true},"dnssec_dnssec_presigned":{"description":"If true, allows Cloudflare to transfer in a DNSSEC-signed zone\nincluding signatures from an external provider, without requiring\nCloudflare to sign any records on the fly.\n\nNote that this feature has some limitations.\nSee [Cloudflare as Secondary](https://developers.cloudflare.com/dns/zone-setups/zone-transfers/cloudflare-as-secondary/setup/#dnssec) for details.","example":true,"type":"boolean","x-auditable":true},"dnssec_dnssec_response_single":{"allOf":[{"$ref":"#/components/schemas/dnssec_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dnssec_dnssec"}},"type":"object"}]},"dnssec_dnssec_use_nsec3":{"description":"If true, enables the use of NSEC3 together with DNSSEC on the zone.\nCombined with setting dnssec_presigned to true, this enables the use of\nNSEC3 records when transferring in from an external provider.\nIf dnssec_presigned is instead set to false (default), NSEC3 records will be\ngenerated and signed at request time.\n\nSee [DNSSEC with NSEC3](https://developers.cloudflare.com/dns/dnssec/enable-nsec3/) for details.","example":false,"type":"boolean","x-auditable":true},"dnssec_ds":{"description":"Full DS record.","example":"example.com. 3600 IN DS 16953 13 2 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"dnssec_flags":{"description":"Flag for DNSSEC record.","example":257,"nullable":true,"readOnly":true,"type":"number","x-auditable":true},"dnssec_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"dnssec_key_tag":{"description":"Code for key tag.","example":42,"nullable":true,"readOnly":true,"type":"number","x-auditable":true},"dnssec_key_type":{"description":"Algorithm key type.","example":"ECDSAP256SHA256","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"dnssec_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"dnssec_modified_on":{"description":"When DNSSEC was last modified.","example":"2014-01-01T05:20:00Z","format":"date-time","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"dnssec_public_key":{"description":"Public key for DS record.","example":"oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA==","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"dnssec_status":{"description":"Status of DNSSEC, based on user-desired state and presence of necessary records.","enum":["active","pending","disabled","pending-disabled","error"],"example":"active","x-auditable":true},"dos_DnsProtectionRule":{"additionalProperties":false,"properties":{"burst_sensitivity":{"description":"The burst sensitivity. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"created_on":{"description":"The creation timestamp of the DNS Protection rule.","format":"date-time","type":"string","x-auditable":true},"id":{"description":"The unique ID of the DNS Protection rule.","type":"string","x-auditable":true},"mode":{"description":"The mode for DNS Protection. Must be one of 'enabled', 'disabled', 'monitoring'.","type":"string","x-auditable":true},"modified_on":{"description":"The last modification timestamp of the DNS Protection rule.","format":"date-time","type":"string","x-auditable":true},"name":{"description":"The name of the DNS Protection rule. Value is relative to the 'scope' setting. For 'global' scope, name should be 'global'. For either the 'region' or 'datacenter' scope, name should be the actual name of the region or datacenter, e.g., 'wnam' or 'lax'.","type":"string","x-auditable":true},"profile_sensitivity":{"description":"The profile sensitivity. Recommended setting is 'low'. Must be one of 'low', 'medium', 'high', or 'very_high'.","type":"string","x-auditable":true},"rate_sensitivity":{"description":"The rate sensitivity. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"scope":{"description":"The scope for the DNS Protection rule. Must be one of 'global', 'region', or 'datacenter'.","type":"string","x-auditable":true}},"required":["id","scope","name","mode","profile_sensitivity","rate_sensitivity","burst_sensitivity","created_on","modified_on"],"type":"object"},"dos_DnsProtectionRuleUpdate":{"additionalProperties":false,"properties":{"burst_sensitivity":{"description":"The new burst sensitivity. Optional. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"mode":{"description":"The new mode for DNS Protection. Optional. Must be one of 'enabled', 'disabled', 'monitoring'.","type":"string","x-auditable":true},"profile_sensitivity":{"description":"The new profile sensitivity. Optional. Recommended setting is 'low'. Must be one of 'low', 'medium', 'high', or 'very_high'.","type":"string","x-auditable":true},"rate_sensitivity":{"description":"The new rate sensitivity. Optional. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true}},"type":"object"},"dos_ExpressionFilter":{"additionalProperties":false,"properties":{"created_on":{"description":"The creation timestamp of the expression filter.","format":"date-time","type":"string","x-auditable":true},"expression":{"description":"The filter expression.","example":"ip.dst in { 192.0.2.0/24 198.51.100.0/24 } and tcp.srcport in { 80 443 10000..65535 }","type":"string","x-auditable":true},"id":{"description":"The unique ID of the expression filter.","type":"string","x-auditable":true},"mode":{"description":"The filter's mode. Must be one of 'enabled', 'disabled', 'monitoring'.","type":"string","x-auditable":true},"modified_on":{"description":"The last modification timestamp of the expression filter.","format":"date-time","type":"string","x-auditable":true}},"required":["id","expression","mode","created_on","modified_on"],"type":"object"},"dos_ExpressionFilterUpdate":{"additionalProperties":false,"properties":{"expression":{"description":"The new filter expression. Optional.","example":"ip.dst in { 192.0.2.0/24 198.51.100.0/24 } and tcp.srcport in { 80 443 10000..65535 }","type":"string","x-auditable":true},"mode":{"description":"The new mode for the filter. Optional. Must be one of 'enabled', 'disabled', 'monitoring'.","type":"string","x-auditable":true}},"type":"object"},"dos_InfraPrefix":{"additionalProperties":false,"properties":{"comment":{"description":"An optional comment describing the allowlist prefix.","type":"string","x-auditable":true},"created_on":{"description":"The creation timestamp of the allowlist prefix.","format":"date-time","type":"string","x-auditable":true},"enabled":{"description":"Whether to enable the allowlist prefix into effect. Defaults to false.","type":"boolean","x-auditable":true},"id":{"description":"The unique ID of the allowlist prefix.","type":"string","x-auditable":true},"modified_on":{"description":"The last modification timestamp of the allowlist prefix.","format":"date-time","type":"string","x-auditable":true},"prefix":{"description":"The allowlist prefix in CIDR format.","type":"string","x-auditable":true}},"required":["id","prefix","comment","enabled","created_on","modified_on"],"type":"object"},"dos_InfraPrefixUpdate":{"additionalProperties":false,"properties":{"comment":{"description":"A comment describing the allowlist prefix. Optional.","type":"string","x-auditable":true},"enabled":{"description":"Whether to enable the allowlist prefix into effect. Optional.","type":"boolean","x-auditable":true}},"type":"object"},"dos_NewDnsProtectionRule":{"additionalProperties":false,"properties":{"burst_sensitivity":{"description":"The burst sensitivity. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"mode":{"description":"The mode for DNS Protection. Must be one of 'enabled', 'disabled', 'monitoring'.","type":"string","x-auditable":true},"name":{"description":"The name of the DNS Protection rule. Value is relative to the 'scope' setting. For 'global' scope, name should be 'global'. For either the 'region' or 'datacenter' scope, name should be the actual name of the region or datacenter, e.g., 'wnam' or 'lax'.","type":"string","x-auditable":true},"profile_sensitivity":{"description":"The profile sensitivity. Recommended setting is 'low'. Must be one of 'low', 'medium', 'high', or 'very_high'.","type":"string","x-auditable":true},"rate_sensitivity":{"description":"The rate sensitivity. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"scope":{"description":"The scope for the DNS Protection rule. Must be one of 'global', 'region', or 'datacenter'.","type":"string","x-auditable":true}},"required":["scope","name","mode","profile_sensitivity","rate_sensitivity","burst_sensitivity"],"type":"object"},"dos_NewExpressionFilter":{"additionalProperties":false,"properties":{"expression":{"description":"The filter expression.","example":"ip.dst in { 192.0.2.0/24 198.51.100.0/24 } and tcp.srcport in { 80 443 10000..65535 }","type":"string","x-auditable":true},"mode":{"description":"The filter's mode. Must be one of 'enabled', 'disabled', 'monitoring'.","type":"string","x-auditable":true}},"required":["expression","mode"],"type":"object"},"dos_NewInfraPrefix":{"additionalProperties":false,"properties":{"comment":{"description":"An comment describing the allowlist prefix.","type":"string","x-auditable":true},"enabled":{"description":"Whether to enable the allowlist prefix into effect.","type":"boolean","x-auditable":true},"prefix":{"description":"The allowlist prefix to add in CIDR format.","type":"string","x-auditable":true}},"required":["prefix","comment","enabled"],"type":"object"},"dos_NewPrefix":{"additionalProperties":false,"properties":{"comment":{"description":"A comment describing the prefix.","type":"string","x-auditable":true},"excluded":{"description":"Whether to exclude the prefix from protection.","type":"boolean","x-auditable":true},"prefix":{"description":"The prefix to add in CIDR format.","example":"192.0.2.0/24","type":"string","x-auditable":true}},"required":["prefix","comment","excluded"],"type":"object"},"dos_NewSynProtectionRule":{"additionalProperties":false,"properties":{"burst_sensitivity":{"description":"The burst sensitivity. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"mitigation_type":{"description":"The type of mitigation. Must be one of 'challenge' or 'retransmit'. Optional. Defaults to 'challenge'.","type":"string","x-auditable":true},"mode":{"description":"The mode for SYN Protection. Must be one of 'enabled', 'disabled', 'monitoring'.","type":"string","x-auditable":true},"name":{"description":"The name of the SYN Protection rule. Value is relative to the 'scope' setting. For 'global' scope, name should be 'global'. For either the 'region' or 'datacenter' scope, name should be the actual name of the region or datacenter, e.g., 'wnam' or 'lax'.","type":"string","x-auditable":true},"rate_sensitivity":{"description":"The rate sensitivity. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"scope":{"description":"The scope for the SYN Protection rule. Must be one of 'global', 'region', or 'datacenter'.","type":"string","x-auditable":true}},"required":["scope","name","mode","rate_sensitivity","burst_sensitivity"],"type":"object"},"dos_NewTcpFlowProtectionRule":{"additionalProperties":false,"properties":{"burst_sensitivity":{"description":"The burst sensitivity. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"mode":{"description":"The mode for the TCP Flow Protection. Must be one of 'enabled', 'disabled', 'monitoring'.","type":"string","x-auditable":true},"name":{"description":"The name of the TCP Flow Protection rule. Value is relative to the 'scope' setting. For 'global' scope, name should be 'global'. For either the 'region' or 'datacenter' scope, name should be the actual name of the region or datacenter, e.g., 'wnam' or 'lax'.","type":"string","x-auditable":true},"rate_sensitivity":{"description":"The rate sensitivity. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"scope":{"description":"The scope for the TCP Flow Protection rule.","type":"string","x-auditable":true}},"required":["scope","name","mode","rate_sensitivity","burst_sensitivity"],"type":"object"},"dos_Prefix":{"additionalProperties":false,"properties":{"comment":{"description":"A comment describing the prefix.","type":"string","x-auditable":true},"created_on":{"description":"The creation timestamp of the prefix.","format":"date-time","type":"string","x-auditable":true},"excluded":{"description":"Whether to exclude the prefix from protection.","type":"boolean","x-auditable":true},"id":{"description":"The unique ID of the prefix.","type":"string","x-auditable":true},"modified_on":{"description":"The last modification timestamp of the prefix.","format":"date-time","type":"string","x-auditable":true},"prefix":{"description":"The prefix in CIDR format.","example":"192.0.2.0/24","type":"string","x-auditable":true}},"required":["id","prefix","comment","excluded","created_on","modified_on"],"type":"object"},"dos_PrefixUpdate":{"additionalProperties":false,"properties":{"comment":{"description":"A new comment for the prefix. Optional.","type":"string","x-auditable":true},"excluded":{"description":"Whether to exclude the prefix from protection. Optional.","type":"boolean","x-auditable":true}},"type":"object"},"dos_ProtectionStatus":{"additionalProperties":false,"properties":{"enabled":{"type":"boolean","x-auditable":true}},"required":["enabled"],"type":"object"},"dos_SynProtectionRule":{"additionalProperties":false,"properties":{"burst_sensitivity":{"description":"The burst sensitivity. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"created_on":{"description":"The creation timestamp of the SYN Protection rule.","format":"date-time","type":"string","x-auditable":true},"id":{"description":"The unique ID of the SYN Protection rule.","type":"string","x-auditable":true},"mitigation_type":{"description":"The type of mitigation for SYN Protection. Must be one of 'challenge' or 'retransmit'.","type":"string","x-auditable":true},"mode":{"description":"The mode for SYN Protection. Must be one of 'enabled', 'disabled', 'monitoring'.","type":"string","x-auditable":true},"modified_on":{"description":"The last modification timestamp of the SYN Protection rule.","format":"date-time","type":"string","x-auditable":true},"name":{"description":"The name of the SYN Protection rule. Value is relative to the 'scope' setting. For 'global' scope, name should be 'global'. For either the 'region' or 'datacenter' scope, name should be the actual name of the region or datacenter, e.g., 'wnam' or 'lax'.","type":"string","x-auditable":true},"rate_sensitivity":{"description":"The rate sensitivity. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"scope":{"description":"The scope for the SYN Protection rule. Must be one of 'global', 'region', or 'datacenter'.","type":"string","x-auditable":true}},"required":["id","scope","name","mode","mitigation_type","rate_sensitivity","burst_sensitivity","created_on","modified_on"],"type":"object"},"dos_SynProtectionRuleUpdate":{"additionalProperties":false,"properties":{"burst_sensitivity":{"description":"The new burst sensitivity. Optional. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"mitigation_type":{"description":"The new mitigation type. Optional. Must be one of 'challenge' or 'retransmit'.","type":"string","x-auditable":true},"mode":{"description":"The new mode for SYN Protection. Optional. Must be one of 'enabled', 'disabled', 'monitoring'.","type":"string","x-auditable":true},"rate_sensitivity":{"description":"The new rate sensitivity. Optional. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true}},"type":"object"},"dos_TcpFlowProtectionRule":{"additionalProperties":false,"properties":{"burst_sensitivity":{"description":"The burst sensitivity. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"created_on":{"description":"The creation timestamp of the TCP Flow Protection rule.","format":"date-time","type":"string","x-auditable":true},"id":{"description":"The unique ID of the TCP Flow Protection rule.","type":"string","x-auditable":true},"mode":{"description":"The mode for TCP Flow Protection. Must be one of 'enabled', 'disabled', 'monitoring'.","type":"string","x-auditable":true},"modified_on":{"description":"The last modification timestamp of the TCP Flow Protection rule.","format":"date-time","type":"string","x-auditable":true},"name":{"description":"The name of the TCP Flow Protection rule. Value is relative to the 'scope' setting. For 'global' scope, name should be 'global'. For either the 'region' or 'datacenter' scope, name should be the actual name of the region or datacenter, e.g., 'wnam' or 'lax'.","type":"string","x-auditable":true},"rate_sensitivity":{"description":"The rate sensitivity. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"scope":{"description":"The scope for the TCP Flow Protection rule. Must be one of 'global', 'region', or 'datacenter'.","type":"string","x-auditable":true}},"required":["id","scope","name","mode","rate_sensitivity","burst_sensitivity","created_on","modified_on"],"type":"object"},"dos_TcpFlowProtectionRuleUpdate":{"additionalProperties":false,"properties":{"burst_sensitivity":{"description":"The new burst sensitivity. Optional. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true},"mode":{"description":"The new mode for TCP Flow Protection. Optional. Must be one of 'enabled', 'disabled', 'monitoring'.","type":"string","x-auditable":true},"rate_sensitivity":{"description":"The new rate sensitivity. Optional. Must be one of 'low', 'medium', 'high'.","type":"string","x-auditable":true}},"type":"object"},"dos_UpdateProtectionStatus":{"additionalProperties":false,"properties":{"enabled":{"description":"Enables or disables protection.","type":"boolean","x-auditable":true}},"required":["enabled"],"type":"object"},"dos_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"dos_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/dos_messages"},"messages":{"$ref":"#/components/schemas/dos_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"dos_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/dos_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/dos_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"dos_api-response-common-paginated":{"$ref":"#/components/schemas/dos_api-response-collection"},"dos_asn":{"type":"integer"},"dos_asn_country":{"example":"US","type":"string"},"dos_asn_description":{"example":"CLOUDFLARENET","type":"string"},"dos_asn_type":{"description":"Infrastructure type of this ASN.","enum":["hosting_provider","isp","organization"],"example":"hosting_provider","type":"string"},"dos_dns-protection-rule-list-response":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dos_DnsProtectionRule"},"type":"array"}}}]},"dos_dns-protection-rule-response":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/dos_DnsProtectionRule"}}}]},"dos_expression-filter-list-response":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dos_ExpressionFilter"},"type":"array"}}}]},"dos_expression-filter-response":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/dos_ExpressionFilter"}}}]},"dos_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"dos_infra-prefix-list-response":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dos_InfraPrefix"},"type":"array"}}}]},"dos_infra-prefix-response":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/dos_InfraPrefix"}}}]},"dos_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"dos_prefix-list-response":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dos_Prefix"},"type":"array"}}}]},"dos_prefix-response":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/dos_Prefix"}}}]},"dos_protection-status-response":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/dos_ProtectionStatus"}}}]},"dos_syn-protection-rule-list-response":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dos_SynProtectionRule"},"type":"array"}}}]},"dos_syn-protection-rule-response":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/dos_SynProtectionRule"}}}]},"dos_tcp-flow-protection-rule-list-response":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dos_TcpFlowProtectionRule"},"type":"array"}}}]},"dos_tcp-flow-protection-rule-response":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/dos_TcpFlowProtectionRule"}}}]},"dos_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true},"dos_uuid":{"description":"UUID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string","x-auditable":true},"email-security_AccountId":{"description":"Account Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"minLength":32,"readOnly":true,"title":"account_id","type":"string"},"email-security_AllowPolicy":{"allOf":[{"additionalProperties":false,"example":{"comments":"Trust all messages send from test@example.com","is_acceptable_sender":false,"is_exempt_recipient":false,"is_recipient":false,"is_regex":false,"is_sender":true,"is_spoof":false,"is_trusted_sender":true,"pattern":"test@example.com","pattern_type":"EMAIL","verify_sender":true},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_acceptable_sender":{"description":"Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions.\nNote: This will not exempt messages with Malicious or Suspicious dispositions.","type":"boolean","x-auditable":true},"is_exempt_recipient":{"description":"Messages to this recipient will bypass all detections.","type":"boolean","x-auditable":true},"is_recipient":{"deprecated":true,"type":"boolean","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"is_sender":{"deprecated":true,"type":"boolean","x-auditable":true},"is_spoof":{"deprecated":true,"type":"boolean","x-auditable":true},"is_trusted_sender":{"description":"Messages from this sender will bypass all detections and link following.","type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true},"pattern_type":{"$ref":"#/components/schemas/email-security_PatternType"},"verify_sender":{"description":"Enforce DMARC, SPF or DKIM authentication.\nWhen on, Email Security only honors policies that pass authentication.","type":"boolean","x-auditable":true}},"required":["is_exempt_recipient","is_trusted_sender","is_acceptable_sender","pattern","is_regex","verify_sender","pattern_type"],"type":"object"},{"properties":{"created_at":{"format":"date-time","type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/email-security_AllowPolicyId"},"last_modified":{"format":"date-time","type":"string","x-auditable":true}},"required":["id","created_at","last_modified"],"type":"object"}],"example":{"comments":"Trust all messages send from test@example.com","created_at":"2023-11-14T22:13:20Z","id":2401,"is_acceptable_sender":false,"is_exempt_recipient":false,"is_recipient":false,"is_regex":false,"is_sender":true,"is_spoof":false,"is_trusted_sender":true,"last_modified":"2023-11-14T22:13:20Z","pattern":"test@example.com","pattern_type":"EMAIL","verify_sender":true}},"email-security_AllowPolicyId":{"description":"The unique identifier for the allow policy.","example":2401,"format":"int32","title":"identifier","type":"integer"},"email-security_ApiResponseCommon":{"properties":{"errors":{"example":[],"items":{"$ref":"#/components/schemas/email-security_Message"},"type":"array"},"messages":{"example":[],"items":{"$ref":"#/components/schemas/email-security_Message"},"type":"array"},"success":{"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"email-security_Attachment":{"properties":{"content_type":{"nullable":true,"type":"string"},"detection":{"allOf":[{"$ref":"#/components/schemas/email-security_DispositionLabel"},{"nullable":true,"type":"string"}]},"encrypted":{"nullable":true,"type":"boolean"},"name":{"nullable":true,"type":"string"},"size":{"minimum":0,"type":"integer"}},"required":["size"],"type":"object"},"email-security_BlockedSender":{"allOf":[{"additionalProperties":false,"example":{"comments":"block sender with email test@example.com","is_regex":false,"pattern":"test@example.com","pattern_type":"EMAIL"},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true},"pattern_type":{"$ref":"#/components/schemas/email-security_PatternType"}},"required":["pattern","is_regex","pattern_type"],"type":"object"},{"properties":{"created_at":{"format":"date-time","type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/email-security_BlockedSenderId"},"last_modified":{"format":"date-time","type":"string","x-auditable":true}},"required":["id","created_at","last_modified"],"type":"object"}],"example":{"comments":"block sender with email test@example.com","created_at":"2023-11-14T22:13:20Z","id":2402,"is_regex":false,"last_modified":"2023-11-14T22:13:20Z","pattern":"test@example.com","pattern_type":"EMAIL"}},"email-security_BlockedSenderId":{"description":"The unique identifier for the allow policy.","example":2402,"format":"int32","title":"identifier","type":"integer"},"email-security_CreateAllowPolicy":{"additionalProperties":false,"example":{"comments":"Trust all messages send from test@example.com","is_acceptable_sender":false,"is_exempt_recipient":false,"is_recipient":false,"is_regex":false,"is_sender":true,"is_spoof":false,"is_trusted_sender":true,"pattern":"test@example.com","pattern_type":"EMAIL","verify_sender":true},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_acceptable_sender":{"description":"Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions.\nNote: This will not exempt messages with Malicious or Suspicious dispositions.","type":"boolean","x-auditable":true},"is_exempt_recipient":{"description":"Messages to this recipient will bypass all detections.","type":"boolean","x-auditable":true},"is_recipient":{"deprecated":true,"type":"boolean","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"is_sender":{"deprecated":true,"type":"boolean","x-auditable":true},"is_spoof":{"deprecated":true,"type":"boolean","x-auditable":true},"is_trusted_sender":{"description":"Messages from this sender will bypass all detections and link following.","type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true},"pattern_type":{"$ref":"#/components/schemas/email-security_PatternType"},"verify_sender":{"description":"Enforce DMARC, SPF or DKIM authentication.\nWhen on, Email Security only honors policies that pass authentication.","type":"boolean","x-auditable":true}},"required":["is_exempt_recipient","is_trusted_sender","is_acceptable_sender","pattern","is_regex","verify_sender","pattern_type"],"type":"object"},"email-security_CreateBlockedSender":{"additionalProperties":false,"example":{"comments":"block sender with email test@example.com","is_regex":false,"pattern":"test@example.com","pattern_type":"EMAIL"},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true},"pattern_type":{"$ref":"#/components/schemas/email-security_PatternType"}},"required":["pattern","is_regex","pattern_type"],"type":"object"},"email-security_CreateDisplayName":{"properties":{"email":{"type":"string","x-auditable":true},"is_email_regex":{"type":"boolean","x-auditable":true},"name":{"maxLength":1024,"type":"string","x-auditable":true}},"required":["name","email","is_email_regex"],"type":"object"},"email-security_CreateTrustedDomain":{"additionalProperties":false,"example":{"comments":null,"is_recent":true,"is_regex":false,"is_similarity":false,"pattern":"example.com"},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_recent":{"description":"Select to prevent recently registered domains from triggering a\nSuspicious or Malicious disposition.","type":"boolean","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"is_similarity":{"description":"Select for partner or other approved domains that have similar\nspelling to your connected domains. Prevents listed domains from\ntriggering a Spoof disposition.","type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true}},"required":["is_recent","is_similarity","is_regex","pattern"],"type":"object"},"email-security_CursorWithLegacyResultInfo":{"properties":{"count":{"format":"int32","minimum":0,"type":"integer"},"next":{"nullable":true,"type":"string"},"page":{"deprecated":true,"description":"Deprecated: Returns always 0","format":"int32","minimum":0,"type":"integer"},"per_page":{"description":"number of items per page","format":"int32","minimum":0,"type":"integer"},"previous":{"nullable":true,"type":"string"},"total_count":{"deprecated":true,"description":"Deprecated: Returns always 0","format":"int32","minimum":0,"type":"integer"}},"required":["per_page","count","page","total_count"],"type":"object"},"email-security_DeliveryMode":{"enum":["DIRECT","BCC","JOURNAL","API","RETRO_SCAN"],"type":"string"},"email-security_DisplayName":{"allOf":[{"properties":{"email":{"type":"string","x-auditable":true},"is_email_regex":{"type":"boolean","x-auditable":true},"name":{"maxLength":1024,"type":"string","x-auditable":true}},"required":["name","email","is_email_regex"],"type":"object"},{"properties":{"comments":{"nullable":true,"type":"string"},"created_at":{"format":"date-time","type":"string"},"directory_id":{"allOf":[{"format":"int64","type":"integer"},{"nullable":true,"type":"integer"}]},"directory_node_id":{"allOf":[{"format":"int64","type":"integer"},{"nullable":true,"type":"integer"}]},"external_directory_node_id":{"deprecated":true,"nullable":true,"type":"string"},"id":{"example":2403,"format":"int32","title":"identifier","type":"integer"},"last_modified":{"format":"date-time","type":"string"},"provenance":{"nullable":true,"type":"string"}},"required":["id","created_at","last_modified"],"type":"object"}]},"email-security_DispositionLabel":{"enum":["MALICIOUS","MALICIOUS-BEC","SUSPICIOUS","SPOOF","SPAM","BULK","ENCRYPTED","EXTERNAL","UNKNOWN","NONE"],"type":"string"},"email-security_Domain":{"example":{"allowed_delivery_modes":["API"],"authorization":null,"created_at":"2023-11-14T22:13:20Z","dmarc_status":"good","domain":"example.com","drop_dispositions":["MALICIOUS","SPAM"],"emails_processed":null,"folder":"Inbox","id":2400,"inbox_provider":"Microsoft","integration_id":"a5dbb180-60ea-4578-84bb-d01a5d4e50c3","ip_restrictions":[],"last_modified":"2023-11-14T22:13:20Z","lookback_hops":2,"o365_tenant_id":"c3c3239d-8858-47df-9618-0e2d9bdf6aa8","regions":["GLOBAL"],"require_tls_inbound":false,"require_tls_outbound":true,"spf_status":"good","transport":"example.com"},"properties":{"allowed_delivery_modes":{"items":{"$ref":"#/components/schemas/email-security_DeliveryMode"},"type":"array"},"authorization":{"allOf":[{"properties":{"authorized":{"type":"boolean"},"status_message":{"nullable":true,"type":"string"},"timestamp":{"format":"date-time","type":"string"}},"required":["authorized","timestamp"],"type":"object"},{"nullable":true,"type":"object"}]},"created_at":{"format":"date-time","type":"string"},"dmarc_status":{"allOf":[{"enum":["none","good","invalid"],"type":"string"},{"nullable":true,"type":"string"}]},"domain":{"type":"string"},"drop_dispositions":{"items":{"$ref":"#/components/schemas/email-security_DispositionLabel"},"type":"array"},"emails_processed":{"allOf":[{"properties":{"timestamp":{"format":"date-time","type":"string"},"total_emails_processed":{"format":"int32","minimum":0,"type":"integer"},"total_emails_processed_previous":{"format":"int32","minimum":0,"type":"integer"}},"required":["total_emails_processed","total_emails_processed_previous","timestamp"],"type":"object"},{"nullable":true,"type":"object"}]},"folder":{"allOf":[{"$ref":"#/components/schemas/email-security_ScannableFolder"},{"nullable":true,"type":"string"}]},"id":{"description":"The unique identifier for the domain.","example":2400,"format":"int32","type":"integer"},"inbox_provider":{"allOf":[{"enum":["Microsoft","Google"],"type":"string"},{"nullable":true,"type":"string"}]},"integration_id":{"format":"uuid","nullable":true,"type":"string"},"ip_restrictions":{"example":["192.0.2.0/24","2001:db8::/32"],"items":{"type":"string"},"type":"array"},"last_modified":{"format":"date-time","type":"string"},"lookback_hops":{"format":"int32","type":"integer"},"o365_tenant_id":{"nullable":true,"type":"string"},"regions":{"items":{"enum":["GLOBAL","AU","DE","IN","US"],"type":"string"},"type":"array"},"require_tls_inbound":{"nullable":true,"type":"boolean"},"require_tls_outbound":{"nullable":true,"type":"boolean"},"spf_status":{"allOf":[{"enum":["none","good","neutral","open","invalid"],"type":"string"},{"nullable":true,"type":"string"}]},"transport":{"type":"string"}},"required":["id","created_at","last_modified","domain","allowed_delivery_modes","lookback_hops","ip_restrictions","transport","drop_dispositions","regions"],"type":"object"},"email-security_Link":{"properties":{"href":{"type":"string"},"text":{"nullable":true,"type":"string"}},"required":["href"],"type":"object"},"email-security_MailsearchMessage":{"allOf":[{"properties":{"action_log":{},"alert_id":{"nullable":true,"type":"string"},"client_recipients":{"items":{"type":"string"},"type":"array"},"delivery_mode":{"allOf":[{"$ref":"#/components/schemas/email-security_MessageDeliveryMode"},{"nullable":true,"type":"string"}]},"detection_reasons":{"items":{"type":"string"},"type":"array"},"edf_hash":{"nullable":true,"type":"string"},"envelope_from":{"nullable":true,"type":"string"},"envelope_to":{"items":{"type":"string"},"nullable":true,"type":"array"},"final_disposition":{"allOf":[{"$ref":"#/components/schemas/email-security_DispositionLabel"},{"nullable":true,"type":"string"}]},"findings":{"items":{"properties":{"attachment":{"nullable":true,"type":"string"},"detail":{"nullable":true,"type":"string"},"detection":{"allOf":[{"$ref":"#/components/schemas/email-security_DispositionLabel"},{"nullable":true,"type":"string"}]},"field":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"portion":{"nullable":true,"type":"string"},"reason":{"nullable":true,"type":"string"},"score":{"format":"double","nullable":true,"type":"number"},"value":{"nullable":true,"type":"string"}},"type":"object"},"nullable":true,"type":"array"},"from":{"nullable":true,"type":"string"},"from_name":{"nullable":true,"type":"string"},"htmltext_structure_hash":{"nullable":true,"type":"string"},"is_phish_submission":{"type":"boolean"},"is_quarantined":{"type":"boolean"},"message_id":{"nullable":true,"type":"string"},"postfix_id":{"$ref":"#/components/schemas/email-security_PostfixId"},"properties":{"properties":{"allowlisted_pattern":{"type":"string"},"allowlisted_pattern_type":{"allOf":[{"enum":["quarantine_release","acceptable_sender","allowed_sender","allowed_recipient","domain_similarity","domain_recency","managed_acceptable_sender","outbound_ndr"],"type":"string"}]},"blocklisted_message":{"type":"boolean"},"blocklisted_pattern":{"type":"string"},"whitelisted_pattern_type":{"allOf":[{"enum":["quarantine_release","acceptable_sender","allowed_sender","allowed_recipient","domain_similarity","domain_recency","managed_acceptable_sender","outbound_ndr"],"type":"string"}]}},"type":"object"},"replyto":{"nullable":true,"type":"string"},"sent_date":{"nullable":true,"type":"string"},"subject":{"nullable":true,"type":"string"},"threat_categories":{"items":{"type":"string"},"nullable":true,"type":"array"},"to":{"items":{"type":"string"},"nullable":true,"type":"array"},"to_name":{"items":{"type":"string"},"nullable":true,"type":"array"},"ts":{"type":"string"},"validation":{"allOf":[{"properties":{"comment":{"nullable":true,"type":"string"},"dkim":{"allOf":[{"$ref":"#/components/schemas/email-security_ValidationStatus"},{"nullable":true,"type":"string"}]},"dmarc":{"allOf":[{"$ref":"#/components/schemas/email-security_ValidationStatus"},{"nullable":true,"type":"string"}]},"spf":{"allOf":[{"$ref":"#/components/schemas/email-security_ValidationStatus"},{"nullable":true,"type":"string"}]}},"type":"object"},{"nullable":true,"type":"object"}]}},"required":["ts","client_recipients","postfix_id","detection_reasons","action_log","is_quarantined","is_phish_submission","properties"],"type":"object"},{"properties":{"id":{"type":"string","x-auditable":true}},"required":["id"],"type":"object"}],"example":{"action_log":[],"alert_id":"4Njp3P0STMz2c02Q-2022-12-30T02:44:49","client_recipients":["email@example.com"],"delivery_mode":"DIRECT","detection_reasons":["Selector is a source of spam/uce : Smtp-Helo-Server-Ip=\u003cb\u003e127.0.0[dot]186\u003c/b\u003e"],"edf_hash":null,"envelope_from":"d1994@example.com","envelope_to":["email@example.com"],"final_disposition":"MALICIOUS","findings":null,"from":"d1994@example.com","from_name":"Sender Name","htmltext_structure_hash":null,"id":"47JJcT1w6GztQV7-email@example.com","is_phish_submission":false,"is_quarantined":false,"message_id":"\u003c4VAZPrAdg7IGNxdt1DWRNu0gvOeL_iZiwP4BQfo4DaE.Yw-woXuugQbeFhBpzwFQtqq_v2v1HOKznoMBqbciQpE@example.com\u003e","postfix_id":"47JJcT1w6GztQV7","properties":{},"replyto":"email@example.com","sent_date":"2019-11-21T00:22:01","subject":"listen, I highly recommend u to read that email, just to ensure not a thing will take place","threat_categories":["IPReputation","ASNReputation"],"to":["email@example.com"],"to_name":["Recipient Name"],"ts":"2019-11-20T23:22:01","validation":{"comment":null,"dkim":"pass","dmarc":"none","spf":"fail"}}},"email-security_Message":{"properties":{"code":{"format":"int32","minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"email-security_MessageDeliveryMode":{"enum":["DIRECT","BCC","JOURNAL","REVIEW_SUBMISSION","DMARC_UNVERIFIED","DMARC_FAILURE_REPORT","DMARC_AGGREGATE_REPORT","THREAT_INTEL_SUBMISSION","SIMULATION_SUBMISSION","API","RETRO_SCAN"],"type":"string"},"email-security_MessageHeader":{"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"email-security_PatternType":{"enum":["EMAIL","DOMAIN","IP","UNKNOWN"],"type":"string"},"email-security_PostfixId":{"description":"The identifier of the message.","example":"4Njp3P0STMz2c02Q","title":"postfix_id","type":"string"},"email-security_ReleaseResponse":{"allOf":[{"properties":{"delivered":{"items":{"type":"string"},"nullable":true,"type":"array"},"failed":{"items":{"type":"string"},"nullable":true,"type":"array"},"undelivered":{"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},{"properties":{"postfix_id":{"$ref":"#/components/schemas/email-security_PostfixId"}},"required":["postfix_id"],"type":"object"}]},"email-security_ResultInfo":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"format":"int32","type":"integer"},"page":{"description":"Current page within paginated list of results","example":1,"format":"int32","type":"integer"},"per_page":{"description":"Number of results per page of results","example":20,"format":"int32","type":"integer"},"total_count":{"description":"Total results available without any search parameters","example":2000,"format":"int32","type":"integer"}},"required":["count","page","per_page","total_count"],"type":"object"},"email-security_RetractionResponseItem":{"properties":{"completed_timestamp":{"format":"date-time","type":"string"},"destination":{"nullable":true,"type":"string"},"item_count":{"format":"int32","type":"integer"},"message_id":{"nullable":true,"type":"string"},"operation":{"nullable":true,"type":"string"},"recipient":{"nullable":true,"type":"string"},"status":{"nullable":true,"type":"string"}},"required":["item_count","completed_timestamp"],"type":"object"},"email-security_ScannableFolder":{"enum":["AllItems","Inbox"],"type":"string"},"email-security_SortingDirection":{"enum":["asc","desc"],"type":"string"},"email-security_Submission":{"properties":{"original_disposition":{"allOf":[{"$ref":"#/components/schemas/email-security_DispositionLabel"},{"nullable":true,"type":"string"}]},"original_edf_hash":{"nullable":true,"type":"string"},"outcome":{"nullable":true,"type":"string"},"outcome_disposition":{"allOf":[{"$ref":"#/components/schemas/email-security_DispositionLabel"},{"nullable":true,"type":"string"}]},"requested_by":{"nullable":true,"type":"string"},"requested_disposition":{"allOf":[{"$ref":"#/components/schemas/email-security_DispositionLabel"},{"nullable":true,"type":"string"}]},"requested_ts":{"format":"date-time","type":"string"},"status":{"nullable":true,"type":"string"},"subject":{"nullable":true,"type":"string"},"submission_id":{"type":"string"},"type":{"nullable":true,"type":"string"}},"required":["submission_id","requested_ts"],"type":"object"},"email-security_ThreatCategory":{"properties":{"description":{"nullable":true,"type":"string"},"id":{"format":"int64","type":"integer"},"name":{"nullable":true,"type":"string"}},"required":["id"],"type":"object"},"email-security_TraceLine":{"properties":{"lineno":{"format":"int64","type":"integer"},"message":{"type":"string"},"ts":{"format":"date-time","type":"string"}},"required":["ts","lineno","message"],"type":"object"},"email-security_TrustedDomain":{"allOf":[{"additionalProperties":false,"example":{"comments":null,"is_recent":true,"is_regex":false,"is_similarity":false,"pattern":"example.com"},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_recent":{"description":"Select to prevent recently registered domains from triggering a\nSuspicious or Malicious disposition.","type":"boolean","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"is_similarity":{"description":"Select for partner or other approved domains that have similar\nspelling to your connected domains. Prevents listed domains from\ntriggering a Spoof disposition.","type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true}},"required":["is_recent","is_similarity","is_regex","pattern"],"type":"object"},{"properties":{"created_at":{"format":"date-time","type":"string","x-auditable":true},"id":{"description":"The unique identifier for the trusted domain.","example":2401,"format":"int32","title":"identifier","type":"integer"},"last_modified":{"format":"date-time","type":"string","x-auditable":true}},"required":["id","created_at","last_modified"],"type":"object"}],"example":{"comments":null,"created_at":"2023-11-14T22:13:20Z","id":2401,"is_recent":true,"is_regex":false,"is_similarity":false,"last_modified":"2023-11-14T22:13:20Z","pattern":"example.com"}},"email-security_TrustedDomainId":{"description":"The unique identifier for the trusted domain.","example":2401,"format":"int32","title":"identifier","type":"integer"},"email-security_UpdateAllowPolicy":{"additionalProperties":false,"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_acceptable_sender":{"description":"Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions.\nNote: This will not exempt messages with Malicious or Suspicious dispositions.","nullable":true,"type":"boolean","x-auditable":true},"is_exempt_recipient":{"description":"Messages to this recipient will bypass all detections.","nullable":true,"type":"boolean","x-auditable":true},"is_regex":{"nullable":true,"type":"boolean","x-auditable":true},"is_trusted_sender":{"description":"Messages from this sender will bypass all detections and link following.","nullable":true,"type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"nullable":true,"type":"string","x-auditable":true},"pattern_type":{"allOf":[{"$ref":"#/components/schemas/email-security_PatternType"},{"nullable":true,"type":"string"}]},"verify_sender":{"description":"Enforce DMARC, SPF or DKIM authentication.\nWhen on, Email Security only honors policies that pass authentication.","nullable":true,"type":"boolean","x-auditable":true}},"type":"object"},"email-security_UpdateBlockedSender":{"additionalProperties":false,"properties":{"comments":{"nullable":true,"type":"string","x-auditable":true},"is_regex":{"nullable":true,"type":"boolean","x-auditable":true},"pattern":{"minLength":1,"nullable":true,"type":"string","x-auditable":true},"pattern_type":{"allOf":[{"$ref":"#/components/schemas/email-security_PatternType"},{"nullable":true,"type":"string"}]}},"type":"object"},"email-security_UpdateTrustedDomain":{"additionalProperties":false,"properties":{"comments":{"maxLength":1024,"type":"string","x-auditable":true},"is_recent":{"description":"Select to prevent recently registered domains from triggering a\nSuspicious or Malicious disposition.","type":"boolean","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"is_similarity":{"description":"Select for partner or other approved domains that have similar\nspelling to your connected domains. Prevents listed domains from\ntriggering a Spoof disposition.","type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true}},"type":"object"},"email-security_ValidationStatus":{"enum":["pass","neutral","fail","error","none"],"type":"string"},"email_account_id":{"$ref":"#/components/schemas/email_identifier"},"email_addresses":{"allOf":[{"$ref":"#/components/schemas/email_destination_address_properties"}],"type":"object"},"email_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/email_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"email_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/email_messages"},"messages":{"$ref":"#/components/schemas/email_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"email_api-response-single":{"allOf":[{"$ref":"#/components/schemas/email_api-response-common"}],"type":"object"},"email_catch_all_rule":{"properties":{"actions":{"$ref":"#/components/schemas/email_rule_catchall-actions"},"enabled":{"$ref":"#/components/schemas/email_rule_enabled"},"id":{"$ref":"#/components/schemas/email_rule_identifier"},"matchers":{"$ref":"#/components/schemas/email_rule_catchall-matchers"},"name":{"$ref":"#/components/schemas/email_rule_name"},"tag":{"$ref":"#/components/schemas/email_rule_tag"}},"type":"object"},"email_catch_all_rule_response_single":{"allOf":[{"$ref":"#/components/schemas/email_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/email_catch_all_rule"}}}]},"email_create_destination_address_properties":{"properties":{"email":{"$ref":"#/components/schemas/email_email"}},"required":["email"],"type":"object"},"email_create_rule_properties":{"properties":{"actions":{"$ref":"#/components/schemas/email_rule_actions"},"enabled":{"$ref":"#/components/schemas/email_rule_enabled"},"matchers":{"$ref":"#/components/schemas/email_rule_matchers"},"name":{"$ref":"#/components/schemas/email_rule_name"},"priority":{"$ref":"#/components/schemas/email_rule_priority"}},"required":["actions","matchers"],"type":"object"},"email_created":{"description":"The date and time the destination address has been created.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"email_destination_address_identifier":{"description":"Destination address identifier.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"email_destination_address_properties":{"properties":{"created":{"$ref":"#/components/schemas/email_created"},"email":{"$ref":"#/components/schemas/email_email"},"id":{"$ref":"#/components/schemas/email_destination_address_identifier"},"modified":{"$ref":"#/components/schemas/email_modified"},"tag":{"$ref":"#/components/schemas/email_destination_address_tag"},"verified":{"$ref":"#/components/schemas/email_verified"}},"type":"object"},"email_destination_address_response_single":{"allOf":[{"$ref":"#/components/schemas/email_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/email_addresses"}}}]},"email_destination_address_tag":{"deprecated":true,"description":"Destination address tag. (Deprecated, replaced by destination address identifier)","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"readOnly":true,"type":"string"},"email_destination_addresses_response_collection":{"allOf":[{"$ref":"#/components/schemas/email_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/email_addresses"},"type":"array"},"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":20},"total_count":{"example":1}},"type":"object"}}}]},"email_dns_record":{"description":"List of records needed to enable an Email Routing zone.","properties":{"content":{"description":"DNS record content.","example":"route1.mx.cloudflare.net","type":"string"},"name":{"description":"DNS record name (or @ for the zone apex).","example":"example.com","maxLength":255,"type":"string","x-auditable":true},"priority":{"description":"Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred.","example":12,"maximum":65535,"minimum":0,"type":"number","x-auditable":true},"ttl":{"anyOf":[{"example":3600,"maximum":86400,"minimum":1,"type":"number"},{"enum":[1],"type":"number"}],"description":"Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.","example":1,"type":"number","x-auditable":true},"type":{"description":"DNS record type.","enum":["A","AAAA","CNAME","HTTPS","TXT","SRV","LOC","MX","NS","CERT","DNSKEY","DS","NAPTR","SMIMEA","SSHFP","SVCB","TLSA","URI"],"example":"NS","readOnly":true,"type":"string","x-auditable":true}},"type":"object"},"email_dns_settings_response_collection":{"allOf":[{"$ref":"#/components/schemas/email_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/email_dns_record"},"type":"array"}}}]},"email_email":{"description":"The contact email address of the user.","example":"user@example.com","maxLength":90,"type":"string","x-auditable":true},"email_email_routing_dns_query_response":{"allOf":[{"$ref":"#/components/schemas/email_api-response-collection"},{"properties":{"result":{"properties":{"errors":{"$ref":"#/components/schemas/email_email_routing_get_response_dns_errors"},"record":{"items":{"$ref":"#/components/schemas/email_dns_record"},"type":"array"}},"type":"object"}}}],"type":"object"},"email_email_routing_get_response_dns_error":{"properties":{"code":{"type":"string"},"missing":{"$ref":"#/components/schemas/email_dns_record"}},"type":"object"},"email_email_routing_get_response_dns_errors":{"items":{"$ref":"#/components/schemas/email_email_routing_get_response_dns_error"},"type":"array"},"email_email_setting_created":{"description":"The date and time the settings have been created.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"email_email_setting_dns_request_body":{"nullable":true,"properties":{"name":{"$ref":"#/components/schemas/email_email_setting_name"}},"type":"object"},"email_email_setting_enabled":{"description":"State of the zone settings for Email Routing.","enum":[true,false],"example":true,"readOnly":true,"type":"boolean","x-auditable":true},"email_email_setting_identifier":{"description":"Email Routing settings identifier.","example":"75610dab9e69410a82cf7e400a09ecec","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"email_email_setting_modified":{"description":"The date and time the settings have been modified.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"email_email_setting_name":{"description":"Domain of your zone.","example":"example.net","type":"string","x-auditable":true},"email_email_setting_skip-wizard":{"description":"Flag to check if the user skipped the configuration wizard.","enum":[true,false],"example":true,"readOnly":true,"type":"boolean"},"email_email_setting_status":{"description":"Show the state of your account, and the type or configuration error.","enum":["ready","unconfigured","misconfigured","misconfigured/locked","unlocked"],"example":"ready","readOnly":true,"type":"string"},"email_email_setting_tag":{"deprecated":true,"description":"Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)","example":"75610dab9e69410a82cf7e400a09ecec","maxLength":32,"readOnly":true,"type":"string"},"email_email_settings_properties":{"properties":{"created":{"$ref":"#/components/schemas/email_email_setting_created"},"enabled":{"$ref":"#/components/schemas/email_email_setting_enabled"},"id":{"$ref":"#/components/schemas/email_email_setting_identifier"},"modified":{"$ref":"#/components/schemas/email_email_setting_modified"},"name":{"$ref":"#/components/schemas/email_email_setting_name"},"skip_wizard":{"$ref":"#/components/schemas/email_email_setting_skip-wizard"},"status":{"$ref":"#/components/schemas/email_email_setting_status"},"tag":{"$ref":"#/components/schemas/email_email_setting_tag"}},"required":["id","name","enabled"],"type":"object"},"email_email_settings_response_single":{"allOf":[{"$ref":"#/components/schemas/email_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/email_settings"}}}]},"email_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"email_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"email_modified":{"description":"The date and time the destination address was last modified.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"email_rule_action":{"description":"Actions pattern.","properties":{"type":{"description":"Type of supported action.","enum":["drop","forward","worker"],"example":"forward","type":"string","x-auditable":true},"value":{"items":{"description":"Value for action.","example":"destinationaddress@example.net","maxLength":90,"type":"string","x-auditable":true},"type":"array"}},"required":["type"],"type":"object"},"email_rule_actions":{"description":"List actions patterns.","items":{"$ref":"#/components/schemas/email_rule_action"},"type":"array"},"email_rule_catchall-action":{"description":"Action for the catch-all routing rule.","properties":{"type":{"description":"Type of action for catch-all rule.","enum":["drop","forward","worker"],"example":"forward","type":"string","x-auditable":true},"value":{"items":{"description":"Input value for action.","example":"destinationaddress@example.net","maxLength":90,"type":"string","x-auditable":true},"type":"array"}},"required":["type"],"type":"object"},"email_rule_catchall-actions":{"description":"List actions for the catch-all routing rule.","items":{"$ref":"#/components/schemas/email_rule_catchall-action"},"type":"array"},"email_rule_catchall-matcher":{"description":"Matcher for catch-all routing rule.","properties":{"type":{"description":"Type of matcher. Default is 'all'.","enum":["all"],"example":"all","type":"string","x-auditable":true}},"required":["type"],"type":"object"},"email_rule_catchall-matchers":{"description":"List of matchers for the catch-all routing rule.","items":{"$ref":"#/components/schemas/email_rule_catchall-matcher"},"type":"array"},"email_rule_enabled":{"default":true,"description":"Routing rule status.","enum":[true,false],"example":true,"type":"boolean","x-auditable":true},"email_rule_identifier":{"description":"Routing rule identifier.","example":"a7e6fb77503c41d8a7f3113c6918f10c","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"email_rule_matcher":{"description":"Matching pattern to forward your actions.","properties":{"field":{"description":"Field for type matcher.","enum":["to"],"example":"to","type":"string","x-auditable":true},"type":{"description":"Type of matcher.","enum":["all","literal"],"example":"literal","type":"string","x-auditable":true},"value":{"description":"Value for matcher.","example":"test@example.com","maxLength":90,"type":"string","x-auditable":true}},"required":["type"],"type":"object"},"email_rule_matchers":{"description":"Matching patterns to forward to your actions.","items":{"$ref":"#/components/schemas/email_rule_matcher"},"type":"array"},"email_rule_name":{"description":"Routing rule name.","example":"Send to user@example.net rule.","maxLength":256,"type":"string","x-auditable":true},"email_rule_priority":{"default":0,"description":"Priority of the routing rule.","minimum":0,"type":"number","x-auditable":true},"email_rule_properties":{"properties":{"actions":{"$ref":"#/components/schemas/email_rule_actions"},"enabled":{"$ref":"#/components/schemas/email_rule_enabled"},"id":{"$ref":"#/components/schemas/email_rule_identifier"},"matchers":{"$ref":"#/components/schemas/email_rule_matchers"},"name":{"$ref":"#/components/schemas/email_rule_name"},"priority":{"$ref":"#/components/schemas/email_rule_priority"},"tag":{"$ref":"#/components/schemas/email_rule_tag"}},"type":"object"},"email_rule_response_single":{"allOf":[{"$ref":"#/components/schemas/email_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/email_rules"}}}]},"email_rule_tag":{"deprecated":true,"description":"Routing rule tag. (Deprecated, replaced by routing rule identifier)","example":"a7e6fb77503c41d8a7f3113c6918f10c","maxLength":32,"readOnly":true,"type":"string"},"email_rules":{"allOf":[{"$ref":"#/components/schemas/email_rule_properties"}],"type":"object"},"email_rules_response_collection":{"allOf":[{"$ref":"#/components/schemas/email_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/email_rules"},"type":"array"},"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":20},"total_count":{"example":1}},"type":"object"}}}]},"email_settings":{"allOf":[{"$ref":"#/components/schemas/email_email_settings_properties"}],"type":"object"},"email_update_catch_all_rule_properties":{"properties":{"actions":{"$ref":"#/components/schemas/email_rule_catchall-actions"},"enabled":{"$ref":"#/components/schemas/email_rule_enabled"},"matchers":{"$ref":"#/components/schemas/email_rule_catchall-matchers"},"name":{"$ref":"#/components/schemas/email_rule_name"}},"required":["actions","matchers"],"type":"object"},"email_update_rule_properties":{"properties":{"actions":{"$ref":"#/components/schemas/email_rule_actions"},"enabled":{"$ref":"#/components/schemas/email_rule_enabled"},"matchers":{"$ref":"#/components/schemas/email_rule_matchers"},"name":{"$ref":"#/components/schemas/email_rule_name"},"priority":{"$ref":"#/components/schemas/email_rule_priority"}},"required":["actions","matchers"],"type":"object"},"email_verified":{"description":"The date and time the destination address has been verified. Null means not verified yet.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"email_zone_id":{"$ref":"#/components/schemas/email_identifier"},"firewall_account_identifier":{"description":"Defines an account identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string"},"firewall_action":{"anyOf":[{"properties":{"mode":{"$ref":"#/components/schemas/firewall_mode"},"response":{"$ref":"#/components/schemas/firewall_custom_response"},"timeout":{"$ref":"#/components/schemas/firewall_timeout"}},"type":"object"}],"description":"The action to perform when the threshold of matched traffic within the configured period is exceeded.","type":"object"},"firewall_action_mode":{"default":"challenge","description":"The default action performed by the rules in the WAF package.","enum":["simulate","block","challenge"],"type":"string"},"firewall_anomaly_description":{"description":"A summary of the purpose/function of the WAF package.","example":"Covers OWASP Top 10 vulnerabilities and more.","readOnly":true,"type":"string"},"firewall_anomaly_detection_mode":{"description":"When a WAF package uses anomaly detection, each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined on the WAF package, the action defined on the package will be taken.","example":"anomaly","readOnly":true,"type":"string"},"firewall_anomaly_name":{"description":"The name of the WAF package.","example":"OWASP ModSecurity Core Rule Set","readOnly":true,"type":"string"},"firewall_anomaly_package":{"allOf":[{"$ref":"#/components/schemas/firewall_package_definition"},{"properties":{"action_mode":{"$ref":"#/components/schemas/firewall_action_mode"},"description":{"$ref":"#/components/schemas/firewall_anomaly_description"},"detection_mode":{"$ref":"#/components/schemas/firewall_anomaly_detection_mode"},"name":{"$ref":"#/components/schemas/firewall_anomaly_name"},"sensitivity":{"$ref":"#/components/schemas/firewall_sensitivity"}},"type":"object"}],"required":["id","name","description","zone_id","detection_mode","sensitivity","action_mode"],"title":"Anomaly detection WAF package (OWASP)"},"firewall_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-common"},{"properties":{"result":{"items":{"type":"object"},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/firewall_result_info"}},"type":"object"}],"type":"object"},"firewall_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/firewall_messages"},"messages":{"$ref":"#/components/schemas/firewall_messages"},"result":{"anyOf":[{"type":"object"},{"items":{"type":"object"},"type":"array"},{"type":"string"}]},"success":{"description":"Defines whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"firewall_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/firewall_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/firewall_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Defines whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"firewall_api-response-single":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-common"},{"properties":{"result":{"anyOf":[{"nullable":true,"type":"object"},{"nullable":true,"type":"string"}]}},"type":"object"}],"type":"object"},"firewall_api-response-single-id":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/firewall_identifier"}},"required":["id"],"type":"object"}},"type":"object"}],"type":"object"},"firewall_asn_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `asn` when specifying an Autonomous System Number (ASN) in the rule.","enum":["asn"],"example":"asn","type":"string"},"value":{"description":"The AS number to match.","example":"AS12345","type":"string"}},"title":"An ASN configuration.","type":"object"},"firewall_body":{"description":"The response body to return. The value must conform to the configured content type.","example":"\u003cerror\u003eThis request has been rate-limited.\u003c/error\u003e","maxLength":10240,"type":"string"},"firewall_bypass":{"description":"Criteria specifying when the current rate limit should be bypassed. You can specify that the rate limit should not apply to one or more URLs.","items":{"properties":{"name":{"enum":["url"],"example":"url","type":"string"},"value":{"description":"The URL to bypass.","example":"api.example.com/*","type":"string"}},"type":"object"},"type":"array"},"firewall_cidr_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `ip_range` when specifying an IP address range in the rule.","enum":["ip_range"],"example":"ip_range","type":"string"},"value":{"description":"The IP address range to match. You can only use prefix lengths `/16` and `/24` for IPv4 ranges, and prefix lengths `/32`, `/48`, and `/64` for IPv6 ranges.","example":"198.51.100.4/16","type":"string"}},"title":"An IP address range configuration.","type":"object"},"firewall_components-schemas-action":{"description":"The action to perform when the rule matches.","example":"execute","pattern":"^[a-z_]+$","type":"string"},"firewall_components-schemas-description":{"description":"An informative summary of the current URI-based WAF override.","example":"Enable Cloudflare Magento ruleset for shop.example.com","maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"firewall_components-schemas-identifier":{"description":"The unique identifier of the resource.","example":"de677e5818985db1285d0e80225f06e5","maxLength":32,"readOnly":true,"type":"string"},"firewall_components-schemas-mode":{"description":"The action to apply to a matched request.","enum":["block","challenge","js_challenge","managed_challenge"],"example":"js_challenge","maxLength":12},"firewall_components-schemas-paused":{"description":"When true, indicates that the firewall rule is currently paused.","example":false,"type":"boolean"},"firewall_components-schemas-priority":{"description":"The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.","example":50,"maximum":2147483647,"minimum":0,"type":"number"},"firewall_components-schemas-ref":{"description":"The reference of the rule (the rule ID by default).","example":"my_ref","type":"string"},"firewall_components-ua-rule-id":{"description":"The unique identifier of the User Agent Blocking rule.","example":"372e67954025e0ba6aaa6d586b9e0b59","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"firewall_configuration":{"description":"The rule configuration.","oneOf":[{"$ref":"#/components/schemas/firewall_ip_configuration"},{"$ref":"#/components/schemas/firewall_ipv6_configuration"},{"$ref":"#/components/schemas/firewall_cidr_configuration"},{"$ref":"#/components/schemas/firewall_asn_configuration"},{"$ref":"#/components/schemas/firewall_country_configuration"}],"type":"object"},"firewall_configurations":{"description":"A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations.","items":{"anyOf":[{"$ref":"#/components/schemas/firewall_schemas-ip_configuration"},{"$ref":"#/components/schemas/firewall_schemas-cidr_configuration"}]},"type":"array"},"firewall_content_type":{"description":"The content type of the body. Must be one of the following: `text/plain`, `text/xml`, or `application/json`.","example":"text/xml","maxLength":50,"type":"string","x-auditable":true},"firewall_country_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `country` when specifying a country code in the rule.","enum":["country"],"example":"country","type":"string"},"value":{"description":"The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to [IP Access rules: Parameters](https://developers.cloudflare.com/waf/tools/ip-access-rules/parameters/#country).","example":"US","type":"string","x-auditable":true}},"title":"A country configuration.","type":"object"},"firewall_created_on":{"description":"The timestamp of when the rule was created.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"firewall_custom_response":{"anyOf":[{"properties":{"body":{"$ref":"#/components/schemas/firewall_body"},"content_type":{"$ref":"#/components/schemas/firewall_content_type"}},"type":"object"}],"description":"A custom content type and reponse to return when the threshold is exceeded. The custom response configured in this object will override the custom error for the zone. This object is optional.\nNotes: If you omit this object, Cloudflare will use the default HTML error page. If \"mode\" is \"challenge\", \"managed_challenge\", or \"js_challenge\", Cloudflare will use the zone challenge pages and you should not provide the \"response\" object.","type":"object"},"firewall_delete_filter_if_unused":{"description":"When true, indicates that Cloudflare should also delete the associated filter if there are no other firewall rules referencing the filter.","type":"boolean"},"firewall_deleted":{"description":"When true, indicates that the firewall rule was deleted.","example":true,"type":"boolean"},"firewall_deleted-filter":{"additionalProperties":false,"properties":{"deleted":{"$ref":"#/components/schemas/firewall_deleted"},"id":{"$ref":"#/components/schemas/firewall_filters_components-schemas-id"}},"required":["id","deleted"],"type":"object"},"firewall_description":{"description":"An informative summary of the rule. This value is sanitized and any tags will be removed.","example":"Prevent multiple login failures to mitigate brute force attacks","maxLength":1024,"type":"string","x-auditable":true},"firewall_description_search":{"description":"A string to search for in the description of existing rules.","example":"abusive","type":"string","x-auditable":true},"firewall_detection_mode":{"description":"The mode that defines how rules within the package are evaluated during the course of a request. When a package uses anomaly detection mode (`anomaly` value), each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined in the WAF package, the action configured in the package will be performed. Traditional detection mode (`traditional` value) will decide the action to take when it is triggered by the request. If multiple rules are triggered, the action providing the highest protection will be applied (for example, a 'block' action will win over a 'challenge' action).","enum":["anomaly","traditional"],"example":"traditional","readOnly":true,"type":"string"},"firewall_disabled":{"description":"When true, indicates that the rate limit is currently disabled.","example":false,"type":"boolean","x-auditable":true},"firewall_email":{"description":"The contact email address of the user.","example":"user@example.com","maxLength":90,"type":"string"},"firewall_enabled":{"default":"true","description":"Whether the rule should be executed.","example":true,"type":"boolean"},"firewall_expression":{"description":"The filter expression. For more information, refer to [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).","example":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","type":"string"},"firewall_filter":{"additionalProperties":false,"properties":{"description":{"$ref":"#/components/schemas/firewall_filters_components-schemas-description"},"expression":{"$ref":"#/components/schemas/firewall_expression"},"id":{"$ref":"#/components/schemas/firewall_filters_components-schemas-id"},"paused":{"$ref":"#/components/schemas/firewall_filters_components-schemas-paused"},"ref":{"$ref":"#/components/schemas/firewall_schemas-ref"}},"type":"object"},"firewall_filter-delete-response-collection":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-collection"},{"properties":{"result":{"items":{"properties":{"id":{"$ref":"#/components/schemas/firewall_filters_components-schemas-id"}},"type":"object"},"type":"array"}},"type":"object"}]},"firewall_filter-delete-response-single":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/firewall_filters_components-schemas-id"}},"required":["id"],"type":"object"}},"required":["result"],"type":"object"}]},"firewall_filter-response-collection":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/firewall_filter"},"type":"array"}},"type":"object"}]},"firewall_filter-response-single":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/firewall_filter"}},"required":["result"],"type":"object"}]},"firewall_filter-rule-base":{"properties":{"action":{"$ref":"#/components/schemas/firewall_schemas-action"},"description":{"$ref":"#/components/schemas/firewall_firewall-rules_components-schemas-description"},"id":{"$ref":"#/components/schemas/firewall_firewall-rules_components-schemas-id"},"paused":{"$ref":"#/components/schemas/firewall_components-schemas-paused"},"priority":{"$ref":"#/components/schemas/firewall_components-schemas-priority"},"products":{"$ref":"#/components/schemas/firewall_products"},"ref":{"$ref":"#/components/schemas/firewall_ref"}},"type":"object"},"firewall_filter-rule-response":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-rule-base"},{"properties":{"filter":{"oneOf":[{"$ref":"#/components/schemas/firewall_filter"},{"$ref":"#/components/schemas/firewall_deleted-filter"}]}},"type":"object"}],"type":"object"},"firewall_filter-rule-update-request":{"allOf":[{"$ref":"#/components/schemas/firewall_filter"},{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/firewall_filters_components-schemas-id"}]}},"type":"object"}]},"firewall_filter-rules-response-collection":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/firewall_filter-rule-response"},"type":"array"}},"required":["result"],"type":"object"}]},"firewall_filter-rules-response-collection-delete":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/firewall_filter-rule-response"},"type":"array"}},"required":["result"],"type":"object"}]},"firewall_filter-rules-single-response":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/firewall_filter-rule-response"}},"required":["result"],"type":"object"}]},"firewall_filter-rules-single-response-delete":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/firewall_filter-rule-response"}},"required":["result"],"type":"object"}]},"firewall_filters":{"properties":{"configuration.target":{"description":"The target to search in existing rules.","enum":["ip","ip_range","asn","country"],"example":"ip","type":"string","x-auditable":true},"configuration.value":{"description":"The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.\nNotes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.","example":"198.51.100.4","type":"string"},"match":{"default":"all","description":"When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.","enum":["any","all"],"type":"string","x-auditable":true},"mode":{"$ref":"#/components/schemas/firewall_schemas-mode"},"notes":{"description":"The string to search for in the notes of existing IP Access rules.\nNotes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.","example":"my note","type":"string","x-auditable":true}},"type":"object"},"firewall_filters_components-schemas-description":{"description":"An informative summary of the filter.","example":"Restrict access from these browsers on this address range.","maxLength":500,"type":"string"},"firewall_filters_components-schemas-id":{"description":"The unique identifier of the filter.","example":"372e67954025e0ba6aaa6d586b9e0b61","maxLength":32,"minLength":32,"readOnly":true,"type":"string"},"firewall_filters_components-schemas-paused":{"description":"When true, indicates that the filter is currently paused.","example":false,"type":"boolean"},"firewall_firewall-rules_components-schemas-description":{"description":"An informative summary of the firewall rule.","example":"Blocks traffic identified during investigation for MIR-31","maxLength":500,"type":"string"},"firewall_firewall-rules_components-schemas-id":{"description":"The unique identifier of the firewall rule.","example":"372e67954025e0ba6aaa6d586b9e0b60","maxLength":32,"readOnly":true,"type":"string"},"firewall_firewalluablock":{"properties":{"configuration":{"$ref":"#/components/schemas/firewall_schemas-configuration"},"description":{"$ref":"#/components/schemas/firewall_firewalluablock_components-schemas-description"},"id":{"$ref":"#/components/schemas/firewall_components-ua-rule-id"},"mode":{"$ref":"#/components/schemas/firewall_components-schemas-mode"},"paused":{"$ref":"#/components/schemas/firewall_schemas-paused"}},"type":"object"},"firewall_firewalluablock_components-schemas-description":{"description":"An informative summary of the rule.","example":"Prevent access from abusive clients identified by this User Agent to mitigate a DDoS attack","maxLength":1024,"type":"string"},"firewall_firewalluablock_response_collection":{"allOf":[{"properties":{"result":{"items":{"$ref":"#/components/schemas/firewall_firewalluablock"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/firewall_api-response-collection"}]},"firewall_firewalluablock_response_single":{"allOf":[{"properties":{"result":{"$ref":"#/components/schemas/firewall_firewalluablock"}},"type":"object"},{"$ref":"#/components/schemas/firewall_api-response-single"}]},"firewall_groups":{"additionalProperties":true,"description":"An object that allows you to enable or disable WAF rule groups for the current WAF override. Each key of this object must be the ID of a WAF rule group, and each value must be a valid WAF action (usually `default` or `disable`). When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object.","example":{"ea8687e59929c1fd05ba97574ad43f77":"default"},"type":"object"},"firewall_header_name":{"description":"The name of the response header to match.","example":"Cf-Cache-Status","type":"string","x-auditable":true},"firewall_header_op":{"description":"The operator used when matching: `eq` means \"equal\" and `ne` means \"not equal\".","enum":["eq","ne"],"example":"ne","type":"string","x-auditable":true},"firewall_header_value":{"description":"The value of the response header, which must match exactly.","example":"HIT","type":"string","x-auditable":true},"firewall_id":{"description":"The unique identifier of the rate limit.","example":"372e67954025e0ba6aaa6d586b9e0b59","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"firewall_identifier":{"description":"Defines an identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"firewall_ip_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `ip` when specifying an IP address in the rule.","enum":["ip"],"example":"ip","type":"string"},"value":{"description":"The IP address to match. This address will be compared to the IP address of incoming requests.","example":"198.51.100.4","type":"string"}},"title":"An IP address configuration.","type":"object"},"firewall_ip_range_search":{"description":"A single IP address range to search for in existing rules.","example":"1.2.3.0/16","type":"string","x-auditable":true},"firewall_ip_search":{"description":"A single IP address to search for in existing rules.","example":"1.2.3.4","type":"string"},"firewall_ipv6_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `ip6` when specifying an IPv6 address in the rule.","enum":["ip6"],"example":"ip6","type":"string"},"value":{"description":"The IPv6 address to match.","example":"2001:DB8:100::CF","type":"string"}},"title":"An IPv6 address configuration.","type":"object"},"firewall_lockdowns_components-schemas-description":{"description":"An informative summary of the rule.","example":"Restrict access to these endpoints to requests from a known IP address","maxLength":1024,"type":"string"},"firewall_lockdowns_components-schemas-id":{"description":"The unique identifier of the Zone Lockdown rule.","example":"372e67954025e0ba6aaa6d586b9e0b59","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"firewall_match":{"description":"Determines which traffic the rate limit counts towards the threshold.","oneOf":[{"properties":{"headers":{"items":{"properties":{"name":{"$ref":"#/components/schemas/firewall_header_name"},"op":{"$ref":"#/components/schemas/firewall_header_op"},"value":{"$ref":"#/components/schemas/firewall_header_value"}},"type":"object"},"type":"array"},"request":{"properties":{"methods":{"$ref":"#/components/schemas/firewall_methods"},"schemes":{"$ref":"#/components/schemas/firewall_schemes"},"url":{"$ref":"#/components/schemas/firewall_url"}},"type":"object"},"response":{"properties":{"origin_traffic":{"$ref":"#/components/schemas/firewall_origin_traffic"}},"type":"object"}},"type":"object"}],"type":"object"},"firewall_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"firewall_methods":{"description":"The HTTP methods to match. You can specify a subset (for example, `['POST','PUT']`) or all methods (`['_ALL_']`). This field is optional when creating a rate limit.","example":["GET","POST"],"items":{"description":"An HTTP method or `_ALL_` to indicate all methods.","enum":["GET","POST","PUT","DELETE","PATCH","HEAD","_ALL_"],"example":"GET","type":"string","x-auditable":true},"type":"array"},"firewall_mode":{"description":"The action to perform.","enum":["simulate","ban","challenge","js_challenge","managed_challenge"],"example":"challenge","type":"string","x-auditable":true},"firewall_modified_on":{"description":"The timestamp of when the rule was last modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"firewall_name":{"description":"The name of the WAF package.","example":"USER","readOnly":true,"type":"string"},"firewall_notes":{"description":"An informative summary of the rule, typically used as a reminder or explanation.","example":"This rule is enabled because of an event that occurred on date X.","type":"string","x-auditable":true},"firewall_origin_traffic":{"description":"When true, only the uncached traffic served from your origin servers will count towards rate limiting. In this case, any cached traffic served by Cloudflare will not count towards rate limiting. This field is optional.\nNotes: This field is deprecated. Instead, use response headers and set \"origin_traffic\" to \"false\" to avoid legacy behaviour interacting with the \"response_headers\" property.","type":"boolean","x-auditable":true},"firewall_override":{"properties":{"description":{"$ref":"#/components/schemas/firewall_components-schemas-description"},"groups":{"$ref":"#/components/schemas/firewall_groups"},"id":{"$ref":"#/components/schemas/firewall_overrides-id"},"paused":{"$ref":"#/components/schemas/firewall_paused"},"priority":{"$ref":"#/components/schemas/firewall_priority"},"rewrite_action":{"$ref":"#/components/schemas/firewall_rewrite_action"},"rules":{"$ref":"#/components/schemas/firewall_rules"},"urls":{"$ref":"#/components/schemas/firewall_urls"}},"type":"object"},"firewall_override_response_collection":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/firewall_override"},"type":"array"}},"required":["result"],"type":"object"}]},"firewall_override_response_single":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/firewall_override"}},"required":["result"],"type":"object"}]},"firewall_overrides-id":{"description":"The unique identifier of the WAF override.","example":"de677e5818985db1285d0e80225f06e5","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"firewall_package":{"oneOf":[{"$ref":"#/components/schemas/firewall_package_definition"},{"$ref":"#/components/schemas/firewall_anomaly_package"}],"type":"object"},"firewall_package_definition":{"properties":{"description":{"$ref":"#/components/schemas/firewall_schemas-description"},"detection_mode":{"$ref":"#/components/schemas/firewall_detection_mode"},"id":{"$ref":"#/components/schemas/firewall_identifier"},"name":{"$ref":"#/components/schemas/firewall_name"},"status":{"$ref":"#/components/schemas/firewall_status"},"zone_id":{"$ref":"#/components/schemas/firewall_identifier"}},"required":["id","name","description","detection_mode","zone_id"],"title":"Traditional WAF package","type":"object"},"firewall_package_id":{"description":"Defines a package identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"firewall_package_response_collection":{"anyOf":[{"$ref":"#/components/schemas/firewall_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/firewall_package"},"type":"array"}},"type":"object"}]},"firewall_package_response_single":{"oneOf":[{"$ref":"#/components/schemas/firewall_api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"firewall_paused":{"description":"When true, indicates that the rule is currently paused.","type":"boolean","x-auditable":true},"firewall_period":{"description":"The time in seconds (an integer value) to count matching traffic. If the count exceeds the configured threshold within this period, Cloudflare will perform the configured action.","example":900,"maximum":86400,"minimum":10,"type":"number","x-auditable":true},"firewall_priority":{"description":"The relative priority of the current URI-based WAF override when multiple overrides match a single URL. A lower number indicates higher priority. Higher priority overrides may overwrite values set by lower priority overrides.","example":1,"maximum":1000000000,"minimum":-1000000000,"type":"number","x-auditable":true},"firewall_products":{"items":{"description":"A list of products to bypass for a request when using the `bypass` action.","enum":["zoneLockdown","uaBlock","bic","hot","securityLevel","rateLimit","waf"],"example":"waf","type":"string"},"type":"array"},"firewall_rate-limits":{"allOf":[{"$ref":"#/components/schemas/firewall_ratelimit"}],"type":"object"},"firewall_rate_limit_id":{"description":"Defines the unique identifier of the rate limit.","example":"372e67954025e0ba6aaa6d586b9e0b59","maxLength":32,"readOnly":true,"type":"string"},"firewall_ratelimit":{"properties":{"action":{"$ref":"#/components/schemas/firewall_action"},"bypass":{"$ref":"#/components/schemas/firewall_bypass"},"description":{"$ref":"#/components/schemas/firewall_description"},"disabled":{"$ref":"#/components/schemas/firewall_disabled"},"id":{"$ref":"#/components/schemas/firewall_id"},"match":{"$ref":"#/components/schemas/firewall_match"},"period":{"$ref":"#/components/schemas/firewall_period"},"threshold":{"$ref":"#/components/schemas/firewall_threshold"}},"type":"object"},"firewall_ratelimit_response_collection":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/firewall_rate-limits"},"type":"array"}},"type":"object"}]},"firewall_ratelimit_response_single":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/firewall_rate-limits"}},"type":"object"}]},"firewall_ref":{"description":"A short reference tag. Allows you to select related firewall rules.","example":"MIR-31","maxLength":50,"type":"string"},"firewall_response_collection":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/firewall_schemas-rule"},"type":"array"}},"type":"object"}]},"firewall_response_single":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/firewall_schemas-rule"}},"type":"object"}]},"firewall_result_info":{"properties":{"count":{"description":"Defines the total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Defines the current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Defines the number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Defines the total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"},"firewall_rewrite_action":{"description":"Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.","properties":{"block":{"$ref":"#/components/schemas/firewall_waf_rewrite_action"},"challenge":{"$ref":"#/components/schemas/firewall_waf_rewrite_action"},"default":{"$ref":"#/components/schemas/firewall_waf_rewrite_action"},"disable":{"$ref":"#/components/schemas/firewall_waf_rewrite_action"},"simulate":{"$ref":"#/components/schemas/firewall_waf_rewrite_action"}},"type":"object"},"firewall_rule":{"properties":{"allowed_modes":{"description":"The available actions that a rule can apply to a matched request.","example":["whitelist","block","challenge","js_challenge","managed_challenge"],"items":{"$ref":"#/components/schemas/firewall_schemas-mode"},"readOnly":true,"type":"array"},"configuration":{"$ref":"#/components/schemas/firewall_configuration"},"created_on":{"description":"The timestamp of when the rule was created.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"id":{"$ref":"#/components/schemas/firewall_schemas-identifier"},"mode":{"$ref":"#/components/schemas/firewall_schemas-mode"},"modified_on":{"description":"The timestamp of when the rule was last modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"notes":{"$ref":"#/components/schemas/firewall_notes"}},"required":["id","mode","allowed_modes","configuration"],"type":"object"},"firewall_rule_collection_response":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/firewall_rule"},"type":"array"}},"type":"object"}]},"firewall_rule_identifier":{"description":"Unique identifier for a rule.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string"},"firewall_rule_single_id_response":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/firewall_schemas-identifier"}},"type":"object"}},"type":"object"}]},"firewall_rule_single_response":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/firewall_rule"}},"type":"object"}]},"firewall_rules":{"additionalProperties":{"allOf":[{"$ref":"#/components/schemas/firewall_waf_action"}],"example":"default"},"description":"An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object.","example":{"100015":"disable"},"type":"object"},"firewall_rules_components-schemas-description":{"default":"","description":"An informative description of the rule.","example":"Execute the OWASP ruleset when the IP address is not 1.1.1.1","type":"string"},"firewall_schemas-action":{"description":"The action to apply to a matched request. The `log` action is only available on an Enterprise plan.","enum":["block","challenge","js_challenge","managed_challenge","allow","log","bypass"],"example":"block","type":"string"},"firewall_schemas-cidr_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `ip_range` when specifying an IP address range in the Zone Lockdown rule.","enum":["ip_range"],"example":"ip_range","type":"string"},"value":{"description":"The IP address range to match. You can only use prefix lengths `/16` and `/24`.","example":"198.51.100.4/16","type":"string"}},"title":"An IP address range configuration.","type":"object"},"firewall_schemas-configuration":{"description":"The configuration object for the current rule.","properties":{"target":{"description":"The configuration target for this rule. You must set the target to `ua` for User Agent Blocking rules.","example":"ua","type":"string"},"value":{"description":"The exact user agent string to match. This value will be compared to the received `User-Agent` HTTP header value.","example":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4","type":"string"}},"type":"object"},"firewall_schemas-description":{"description":"A summary of the purpose/function of the WAF package.","example":"null","readOnly":true,"type":"string"},"firewall_schemas-description_search":{"description":"A string to search for in the description of existing rules.","example":"endpoints","type":"string","x-auditable":true},"firewall_schemas-expression":{"description":"The expression defining which traffic will match the rule.","example":"ip.src ne 1.1.1.1","type":"string"},"firewall_schemas-identifier":{"description":"The unique identifier of the IP Access rule.","example":"92f17202ed8bd63d69a66b86a49a8f6b","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"firewall_schemas-ip_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `ip` when specifying an IP address in the Zone Lockdown rule.","enum":["ip"],"example":"ip","type":"string"},"value":{"description":"The IP address to match. This address will be compared to the IP address of incoming requests.","example":"198.51.100.4","type":"string"}},"title":"An IP address configuration.","type":"object"},"firewall_schemas-mode":{"description":"The action to apply to a matched request.","enum":["block","challenge","whitelist","js_challenge","managed_challenge"],"example":"challenge","type":"string","x-auditable":true},"firewall_schemas-paused":{"description":"When true, indicates that the rule is currently paused.","example":false,"type":"boolean","x-auditable":true},"firewall_schemas-priority":{"description":"The priority of the rule to control the processing order. A lower number indicates higher priority. If not provided, any rules with a configured priority will be processed before rules without a priority.","example":5,"type":"number","x-auditable":true},"firewall_schemas-ref":{"description":"A short reference tag. Allows you to select related filters.","example":"FIL-100","maxLength":50,"type":"string"},"firewall_schemas-rule":{"allOf":[{"$ref":"#/components/schemas/firewall_rule"},{"properties":{"scope":{"description":"All zones owned by the user will have the rule applied.","properties":{"email":{"$ref":"#/components/schemas/firewall_email"},"id":{"$ref":"#/components/schemas/firewall_identifier"},"type":{"description":"Defines the scope of the rule.","enum":["user","organization"],"example":"user","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"type":"object"}],"required":["id","mode","allowed_modes","configuration","scope"],"type":"object"},"firewall_schemas-urls":{"description":"The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.","items":{"example":"api.mysite.com/some/endpoint*","type":"string","x-auditable":true},"type":"array"},"firewall_schemes":{"description":"The HTTP schemes to match. You can specify one scheme (`['HTTPS']`), both schemes (`['HTTP','HTTPS']`), or all schemes (`['_ALL_']`). This field is optional.","example":["HTTP","HTTPS"],"items":{"description":"An HTTP scheme or `_ALL_` to indicate all schemes.","example":"HTTPS","type":"string"},"type":"array","x-auditable":true},"firewall_sensitivity":{"default":"high","description":"The sensitivity of the WAF package.","enum":["high","medium","low","off"],"type":"string"},"firewall_status":{"default":"active","description":"When set to `active`, indicates that the WAF package will be applied to the zone.","enum":["active"],"readOnly":true,"type":"string"},"firewall_threshold":{"description":"The threshold that will trigger the configured mitigation action. Configure this value along with the `period` property to establish a threshold per period.","example":60,"minimum":1,"type":"number","x-auditable":true},"firewall_timeout":{"description":"The time in seconds during which Cloudflare will perform the mitigation action. Must be an integer value greater than or equal to the period.\nNotes: If \"mode\" is \"challenge\", \"managed_challenge\", or \"js_challenge\", Cloudflare will use the zone's Challenge Passage time and you should not provide this value.","example":86400,"maximum":86400,"minimum":1,"type":"number","x-auditable":true},"firewall_ua_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `ua` when specifying a user agent in the rule.","enum":["ua"],"example":"ua","type":"string"},"value":{"description":"the user agent to exactly match","example":"Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1)","type":"string","x-auditable":true}},"title":"A user agent configuration.","type":"object"},"firewall_uri_search":{"description":"A single URI to search for in the list of URLs of existing rules.","example":"/some/path","type":"string","x-auditable":true},"firewall_url":{"description":"The URL pattern to match, composed of a host and a path such as `example.org/path*`. Normalization is applied before the pattern is matched. `*` wildcards are expanded to match applicable traffic. Query strings are not matched. Set the value to `*` to match all traffic to your zone.","example":"*.example.org/path*","maxLength":1024,"type":"string","x-auditable":true},"firewall_urls":{"description":"The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.","items":{"example":"shop.example.com/*","type":"string","x-auditable":true},"type":"array"},"firewall_waf_action":{"description":"The WAF rule action to apply.","enum":["challenge","block","simulate","disable","default"]},"firewall_waf_rewrite_action":{"description":"The WAF rule action to apply.","enum":["challenge","block","simulate","disable","default"],"x-auditable":true},"firewall_zonelockdown":{"additionalProperties":false,"properties":{"configurations":{"$ref":"#/components/schemas/firewall_configurations"},"created_on":{"$ref":"#/components/schemas/firewall_created_on"},"description":{"$ref":"#/components/schemas/firewall_lockdowns_components-schemas-description"},"id":{"$ref":"#/components/schemas/firewall_lockdowns_components-schemas-id"},"modified_on":{"$ref":"#/components/schemas/firewall_modified_on"},"paused":{"$ref":"#/components/schemas/firewall_schemas-paused"},"urls":{"$ref":"#/components/schemas/firewall_schemas-urls"}},"required":["id","created_on","modified_on","paused","description","urls","configurations"],"type":"object"},"firewall_zonelockdown_response_collection":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/firewall_zonelockdown"},"type":"array"}},"required":["result"],"type":"object"}]},"firewall_zonelockdown_response_single":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/firewall_zonelockdown"}},"required":["result"],"type":"object"}]},"healthchecks_address":{"description":"The hostname or IP address of the origin server to run health checks on.","example":"www.example.com","type":"string","x-auditable":true},"healthchecks_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/healthchecks_api-response-common"},{"properties":{"result":{"items":{},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/healthchecks_result_info"}}}],"type":"object"},"healthchecks_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/healthchecks_messages"},"messages":{"$ref":"#/components/schemas/healthchecks_messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"healthchecks_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/healthchecks_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/healthchecks_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"healthchecks_api-response-single":{"allOf":[{"$ref":"#/components/schemas/healthchecks_api-response-common"},{"properties":{"result":{"oneOf":[{"type":"object"},{"type":"string"}]}},"type":"object"}],"type":"object"},"healthchecks_check_regions":{"description":"A list of regions from which to run health checks. Null means Cloudflare will pick a default region.","example":["WEU","ENAM"],"items":{"description":"WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, IN: India, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (BUSINESS and ENTERPRISE customers only).","enum":["WNAM","ENAM","WEU","EEU","NSAM","SSAM","OC","ME","NAF","SAF","IN","SEAS","NEAS","ALL_REGIONS"],"type":"string"},"nullable":true,"type":"array","x-auditable":true},"healthchecks_consecutive_fails":{"default":1,"description":"The number of consecutive fails required from a health check before changing the health to unhealthy.","type":"integer","x-auditable":true},"healthchecks_consecutive_successes":{"default":1,"description":"The number of consecutive successes required from a health check before changing the health to healthy.","type":"integer","x-auditable":true},"healthchecks_description":{"description":"A human-readable description of the health check.","example":"Health check for www.example.com","type":"string","x-auditable":true},"healthchecks_failure_reason":{"description":"The current failure reason if status is unhealthy.","example":"","readOnly":true,"type":"string","x-auditable":true},"healthchecks_healthchecks":{"properties":{"address":{"$ref":"#/components/schemas/healthchecks_address"},"check_regions":{"$ref":"#/components/schemas/healthchecks_check_regions"},"consecutive_fails":{"$ref":"#/components/schemas/healthchecks_consecutive_fails"},"consecutive_successes":{"$ref":"#/components/schemas/healthchecks_consecutive_successes"},"created_on":{"$ref":"#/components/schemas/healthchecks_timestamp"},"description":{"$ref":"#/components/schemas/healthchecks_description"},"failure_reason":{"$ref":"#/components/schemas/healthchecks_failure_reason"},"http_config":{"$ref":"#/components/schemas/healthchecks_http_config"},"id":{"$ref":"#/components/schemas/healthchecks_identifier"},"interval":{"$ref":"#/components/schemas/healthchecks_interval"},"modified_on":{"$ref":"#/components/schemas/healthchecks_timestamp"},"name":{"$ref":"#/components/schemas/healthchecks_name"},"retries":{"$ref":"#/components/schemas/healthchecks_retries"},"status":{"$ref":"#/components/schemas/healthchecks_status"},"suspended":{"$ref":"#/components/schemas/healthchecks_suspended"},"tcp_config":{"$ref":"#/components/schemas/healthchecks_tcp_config"},"timeout":{"$ref":"#/components/schemas/healthchecks_timeout"},"type":{"$ref":"#/components/schemas/healthchecks_type"}},"type":"object"},"healthchecks_http_config":{"description":"Parameters specific to an HTTP or HTTPS health check.","nullable":true,"properties":{"allow_insecure":{"default":false,"description":"Do not validate the certificate when the health check uses HTTPS.","type":"boolean","x-auditable":true},"expected_body":{"default":"","description":"A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy.","example":"success","type":"string","x-auditable":true},"expected_codes":{"default":"200","description":"The expected HTTP response codes (e.g. \"200\") or code ranges (e.g. \"2xx\" for all codes starting with 2) of the health check.","example":["2xx","302"],"items":{"type":"string"},"nullable":true,"type":"array","x-auditable":true},"follow_redirects":{"default":false,"description":"Follow redirects if the origin returns a 3xx status code.","type":"boolean","x-auditable":true},"header":{"additionalProperties":{"items":{"type":"string","x-auditable":true},"type":"array"},"description":"The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden.","example":{"Host":["example.com"],"X-App-ID":["abc123"]},"nullable":true,"type":"object"},"method":{"default":"GET","description":"The HTTP method to use for the health check.","enum":["GET","HEAD"],"type":"string","x-auditable":true},"path":{"default":"/","description":"The endpoint path to health check against.","example":"/health","type":"string","x-auditable":true},"port":{"default":80,"description":"Port number to connect to for the health check. Defaults to 80 if type is HTTP or 443 if type is HTTPS.","type":"integer","x-auditable":true}},"type":"object"},"healthchecks_id_response":{"allOf":[{"$ref":"#/components/schemas/healthchecks_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/healthchecks_identifier"}},"type":"object"}},"type":"object"}]},"healthchecks_identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"healthchecks_interval":{"default":60,"description":"The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.","type":"integer","x-auditable":true},"healthchecks_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"healthchecks_name":{"description":"A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.","example":"server-1","type":"string","x-auditable":true},"healthchecks_query_healthcheck":{"properties":{"address":{"$ref":"#/components/schemas/healthchecks_address"},"check_regions":{"$ref":"#/components/schemas/healthchecks_check_regions"},"consecutive_fails":{"$ref":"#/components/schemas/healthchecks_consecutive_fails"},"consecutive_successes":{"$ref":"#/components/schemas/healthchecks_consecutive_successes"},"description":{"$ref":"#/components/schemas/healthchecks_description"},"http_config":{"$ref":"#/components/schemas/healthchecks_http_config"},"interval":{"$ref":"#/components/schemas/healthchecks_interval"},"name":{"$ref":"#/components/schemas/healthchecks_name"},"retries":{"$ref":"#/components/schemas/healthchecks_retries"},"suspended":{"$ref":"#/components/schemas/healthchecks_suspended"},"tcp_config":{"$ref":"#/components/schemas/healthchecks_tcp_config"},"timeout":{"$ref":"#/components/schemas/healthchecks_timeout"},"type":{"$ref":"#/components/schemas/healthchecks_type"}},"required":["name","address"],"type":"object"},"healthchecks_response_collection":{"allOf":[{"$ref":"#/components/schemas/healthchecks_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/healthchecks_healthchecks"},"type":"array"}}}]},"healthchecks_result_info":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters","example":2000,"type":"number"}},"type":"object"},"healthchecks_retries":{"default":2,"description":"The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.","type":"integer","x-auditable":true},"healthchecks_single_response":{"allOf":[{"$ref":"#/components/schemas/healthchecks_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/healthchecks_healthchecks"}},"type":"object"}]},"healthchecks_status":{"description":"The current status of the origin server according to the health check.","enum":["unknown","healthy","unhealthy","suspended"],"example":"healthy","readOnly":true,"type":"string","x-auditable":true},"healthchecks_suspended":{"default":false,"description":"If suspended, no health checks are sent to the origin.","type":"boolean","x-auditable":true},"healthchecks_tcp_config":{"description":"Parameters specific to TCP health check.","nullable":true,"properties":{"method":{"default":"connection_established","description":"The TCP connection method to use for the health check.","enum":["connection_established"],"type":"string","x-auditable":true},"port":{"default":80,"description":"Port number to connect to for the health check. Defaults to 80.","type":"integer","x-auditable":true}},"type":"object"},"healthchecks_timeout":{"default":5,"description":"The timeout (in seconds) before marking the health check as failed.","type":"integer","x-auditable":true},"healthchecks_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"healthchecks_type":{"default":"HTTP","description":"The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.","example":"HTTPS","type":"string","x-auditable":true},"hyperdrive_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_api-response-common"},{"properties":{"result_info":{"$ref":"#/components/schemas/hyperdrive_result_info"}},"type":"object"}],"type":"object"},"hyperdrive_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/hyperdrive_messages"},"messages":{"$ref":"#/components/schemas/hyperdrive_messages"},"result":{"type":"object"},"success":{"description":"Return the status of the API call success.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"hyperdrive_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Return the status of the API call success.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"hyperdrive_api-response-single":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_api-response-common"}],"type":"object"},"hyperdrive_hyperdrive-caching":{"discriminator":{"mapping":{"false":"#/components/schemas/hyperdrive-caching-enabled","true":"#/components/schemas/hyperdrive-caching-disabled"},"propertyName":"disabled"},"oneOf":[{"$ref":"#/components/schemas/hyperdrive_hyperdrive-caching-disabled"},{"$ref":"#/components/schemas/hyperdrive_hyperdrive-caching-enabled"}],"type":"object"},"hyperdrive_hyperdrive-caching-common":{"properties":{"disabled":{"description":"Set to true to disable caching of SQL responses. Default is false.","type":"boolean","x-auditable":true}},"type":"object"},"hyperdrive_hyperdrive-caching-disabled":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_hyperdrive-caching-common"}],"type":"object"},"hyperdrive_hyperdrive-caching-enabled":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_hyperdrive-caching-common"},{"properties":{"max_age":{"description":"Specify the maximum duration items should persist in the cache. Not returned if set to the default (60).","example":60,"type":"integer","x-auditable":true},"stale_while_revalidate":{"description":"Specify the number of seconds the cache may serve a stale response. Omitted if set to the default (15).","example":15,"type":"integer","x-auditable":true}},"type":"object"}],"type":"object"},"hyperdrive_hyperdrive-config":{"properties":{"caching":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-caching"},"created_on":{"description":"Defines the creation time of the Hyperdrive configuration.","example":"2017-01-01T00:00:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/hyperdrive_identifier"},"modified_on":{"description":"Defines the last modified time of the Hyperdrive configuration.","example":"2017-01-01T00:00:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"mtls":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-mtls"},"name":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-name"},"origin":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/hyperdrive_hyperdrive-database-full"},{"$ref":"#/components/schemas/hyperdrive_internet-origin"}],"title":"Public Database"},{"allOf":[{"$ref":"#/components/schemas/hyperdrive_hyperdrive-database-full"},{"$ref":"#/components/schemas/hyperdrive_over-access-origin"}],"title":"Access-protected Database behind Cloudflare Tunnel"}],"type":"object"},"origin_connection_limit":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-origin-connection-limit"}},"required":["id","name","origin"],"type":"object"},"hyperdrive_hyperdrive-config-patch":{"properties":{"caching":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-caching"},"mtls":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-mtls"},"name":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-name"},"origin":{"anyOf":[{"$ref":"#/components/schemas/hyperdrive_hyperdrive-database"},{"oneOf":[{"$ref":"#/components/schemas/hyperdrive_internet-origin"},{"$ref":"#/components/schemas/hyperdrive_over-access-origin"}],"title":"Origin Database"}],"type":"object"},"origin_connection_limit":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-origin-connection-limit"}},"type":"object"},"hyperdrive_hyperdrive-config-response":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_hyperdrive-config"}],"required":["caching"],"type":"object"},"hyperdrive_hyperdrive-database":{"properties":{"database":{"description":"Set the name of your origin database.","example":"postgres","type":"string","x-auditable":true},"password":{"description":"Set the password needed to access your origin database. The API never returns this write-only value.","type":"string","writeOnly":true,"x-sensitive":true},"scheme":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-scheme"},"user":{"description":"Set the user of your origin database.","example":"postgres","type":"string","x-auditable":true}},"title":"Connection Options","type":"object"},"hyperdrive_hyperdrive-database-full":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_hyperdrive-database"}],"required":["scheme","database","user","password"],"type":"object"},"hyperdrive_hyperdrive-mtls":{"properties":{"ca_certificate_id":{"description":"Define CA certificate ID obtained after uploading CA cert.","example":"00000000-0000-0000-0000-0000000000","type":"string"},"mtls_certificate_id":{"description":"Define mTLS certificate ID obtained after uploading client cert.","example":"00000000-0000-0000-0000-0000000000","type":"string"},"sslmode":{"description":"Set SSL mode to 'require', 'verify-ca', or 'verify-full' to verify the CA.","example":"verify-full","type":"string"}},"title":"mTLS","type":"object"},"hyperdrive_hyperdrive-name":{"example":"example-hyperdrive","type":"string","x-auditable":true},"hyperdrive_hyperdrive-origin":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_hyperdrive-database"},{"oneOf":[{"$ref":"#/components/schemas/hyperdrive_internet-origin"},{"$ref":"#/components/schemas/hyperdrive_over-access-origin"}]}],"type":"object"},"hyperdrive_hyperdrive-origin-connection-limit":{"description":"The (soft) maximum number of connections the Hyperdrive is allowed to make to the origin database.","example":60,"maximum":100,"minimum":5,"type":"integer","x-auditable":true},"hyperdrive_hyperdrive-scheme":{"description":"Specifies the URL scheme used to connect to your origin database.","enum":["postgres","postgresql","mysql"],"type":"string","x-auditable":true},"hyperdrive_identifier":{"description":"Define configurations using a unique string identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"hyperdrive_internet-origin":{"properties":{"host":{"description":"Defines the host (hostname or IP) of your origin database.","example":"database.example.com","type":"string","x-auditable":true},"port":{"description":"Defines the port (default: 5432 for Postgres) of your origin database.","example":"5432","type":"integer","x-auditable":true}},"required":["host","port"],"title":"Public Database","type":"object"},"hyperdrive_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"hyperdrive_over-access-origin":{"properties":{"access_client_id":{"description":"Defines the Client ID of the Access token to use when connecting to the origin database.","example":"0123456789abcdef0123456789abcdef.access","type":"string","x-auditable":true},"access_client_secret":{"description":"Defines the Client Secret of the Access Token to use when connecting to the origin database. The API never returns this write-only value.","example":"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef","type":"string","writeOnly":true,"x-sensitive":true},"host":{"description":"Defines the host (hostname or IP) of your origin database.","example":"database.example.com","type":"string","x-auditable":true}},"required":["host","access_client_id","access_client_secret"],"title":"Access-protected Database behind Cloudflare Tunnel","type":"object"},"hyperdrive_result_info":{"properties":{"count":{"description":"Defines the total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Defines the current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Defines the number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Defines the total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"},"iam_access":{"description":"Allow or deny operations against the resources.","enum":["allow","deny"],"example":"allow","type":"string","x-auditable":true},"iam_account":{"properties":{"created_on":{"description":"Timestamp for the creation of the account","example":"2014-03-01T12:21:02.0000Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"},"managed_by":{"description":"Parent container details","properties":{"parent_org_id":{"description":"ID of the parent Organization, if one exists","example":"4536bcfad5faccb111b47003c79917fa","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"parent_org_name":{"description":"Name of the parent Organization, if one exists","example":"Demo Parent Organization","readOnly":true,"type":"string","x-auditable":true}},"type":"object"},"name":{"description":"Account name","example":"Demo Account","maxLength":100,"type":"string","x-auditable":true},"settings":{"description":"Account settings","properties":{"abuse_contact_email":{"description":"Sets an abuse contact email to notify for abuse reports.","type":"string","x-auditable":true},"enforce_twofactor":{"default":false,"description":"Indicates whether membership in this account requires that\nTwo-Factor Authentication is enabled","type":"boolean","x-auditable":true}},"type":"object"},"type":{"$ref":"#/components/schemas/iam_account-type"}},"required":["id","name","type"],"type":"object"},"iam_account-type":{"enum":["standard","enterprise"]},"iam_account_identifier":{"allOf":[{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"}],"description":"Account identifier tag.","title":"Account Identifier"},"iam_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-common"},{"properties":{"result_info":{"$ref":"#/components/schemas/iam_result_info"}}}],"type":"object"},"iam_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/iam_schemas-messages"},"messages":{"$ref":"#/components/schemas/iam_schemas-messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"iam_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/iam_schemas-messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/iam_schemas-messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"iam_api-response-single":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-common"}],"type":"object"},"iam_api-response-single-id":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"}},"required":["id"],"type":"object"}}}],"type":"object"},"iam_api_access_enabled":{"description":"Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.","example":true,"nullable":true,"type":"boolean","x-auditable":true},"iam_cidr_list":{"description":"List of IPv4/IPv6 CIDR addresses.","example":["199.27.128.0/21","2400:cb00::/32"],"items":{"description":"IPv4/IPv6 CIDR.","example":"199.27.128.0/21","type":"string","x-auditable":true},"type":"array"},"iam_code":{"description":"The unique activation code for the account membership.","example":"05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0","maxLength":64,"readOnly":true,"type":"string"},"iam_collection_member_response_with_policies":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/iam_member_with_policies"},"type":"array"}},"type":"object"}],"title":"Members with Policies"},"iam_collection_membership_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/iam_membership"},"type":"array"}},"type":"object"}],"title":"memberships_with_roles"},"iam_collection_membership_response_with_policies":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/iam_membership-with-policies"},"type":"array"}},"type":"object"}],"title":"memberships_with_policies"},"iam_collection_organization_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/iam_organization"},"type":"array"}},"type":"object"}]},"iam_collection_permission_groups_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/iam_permission_groups"}},"type":"object"}],"title":"List of Resource groups"},"iam_collection_resource_groups_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/iam_resource_groups"}},"type":"object"}],"title":"List of Resource groups"},"iam_collection_role_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/iam_role"},"type":"array"}},"type":"object"}]},"iam_collection_tokens_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/iam_token_base"},"type":"array"}},"type":"object"}],"title":"Response with a list of tokens"},"iam_common_components-schemas-identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"minLength":32,"type":"string","x-auditable":true},"iam_components-schemas-account":{"allOf":[{"$ref":"#/components/schemas/iam_account"}]},"iam_components-schemas-status":{"description":"Whether the user is a member of the organization or has an invitation pending.","enum":["member","invited"],"example":"member","type":"string","x-auditable":true},"iam_condition":{"properties":{"request_ip":{"$ref":"#/components/schemas/iam_request_ip"}},"type":"object"},"iam_country":{"description":"The country in which the user lives.","example":"US","maxLength":30,"nullable":true,"type":"string"},"iam_create-account":{"properties":{"name":{"description":"Account name","type":"string"},"type":{"$ref":"#/components/schemas/iam_account-type"},"unit":{"description":"information related to the tenant unit, and optionally, an id of the unit to create the account on. see https://developers.cloudflare.com/tenant/how-to/manage-accounts/","properties":{"id":{"description":"Tenant unit ID","example":"f267e341f3dd4697bd3b9f71dd96247f","type":"string","x-auditable":true}},"type":"object"}},"required":["name"],"title":"Create account","type":"object"},"iam_create-member-with-policies":{"properties":{"email":{"$ref":"#/components/schemas/iam_email"},"policies":{"description":"Array of policies associated with this member.","items":{"$ref":"#/components/schemas/iam_create_member_policy"},"type":"array"},"status":{"default":"pending","enum":["accepted","pending"],"x-auditable":true}},"required":["email","policies"],"title":"Add Member with Policies","type":"object"},"iam_create-member-with-roles":{"properties":{"email":{"$ref":"#/components/schemas/iam_email"},"roles":{"description":"Array of roles associated with this member.","items":{"$ref":"#/components/schemas/iam_role_components-schemas-identifier"},"type":"array"},"status":{"default":"pending","enum":["accepted","pending"],"x-auditable":true}},"required":["email","roles"],"title":"Add Member with Account Roles","type":"object"},"iam_create-scope":{"description":"A scope is a combination of scope objects which provides additional context.","properties":{"key":{"$ref":"#/components/schemas/iam_create_resource_group_scope_scope_key"},"objects":{"description":"A list of scope objects for additional context. The number of Scope objects should not be zero.","items":{"$ref":"#/components/schemas/iam_create_resource_group_scope_scope_object"},"type":"array"}},"required":["key","objects"],"type":"object"},"iam_create_member_policy":{"properties":{"access":{"$ref":"#/components/schemas/iam_access"},"id":{"$ref":"#/components/schemas/iam_policy_identifier"},"permission_groups":{"$ref":"#/components/schemas/iam_member_permission_groups"},"resource_groups":{"$ref":"#/components/schemas/iam_member_resource_groups"}},"required":["id","access","permission_groups","resource_groups"],"title":"create_member_policy"},"iam_create_payload":{"properties":{"condition":{"$ref":"#/components/schemas/iam_condition"},"expires_on":{"$ref":"#/components/schemas/iam_expires_on"},"name":{"$ref":"#/components/schemas/iam_name"},"not_before":{"$ref":"#/components/schemas/iam_not_before"},"policies":{"$ref":"#/components/schemas/iam_token_policies"}},"required":["name","policies"],"type":"object"},"iam_create_resource_group_scope_scope_key":{"description":"This is a combination of pre-defined resource name and identifier (like Account ID etc.)","example":"com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4"},"iam_create_resource_group_scope_scope_object":{"description":"A scope object represents any resource that can have actions applied against invite.","properties":{"key":{"$ref":"#/components/schemas/iam_create_resource_group_scope_scope_object_key"}},"required":["key"],"type":"object"},"iam_create_resource_group_scope_scope_object_key":{"description":"This is a combination of pre-defined resource name and identifier (like Zone ID etc.)","example":"com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5"},"iam_create_user_group_body":{"properties":{"name":{"description":"Name of the User group.","example":"My New User Group","type":"string","x-auditable":true},"policies":{"description":"Policies attached to the User group","items":{"$ref":"#/components/schemas/iam_user_group_policy_write_body"},"title":"User Group Policies","type":"array"}},"required":["name","policies"],"title":"Create User group with a set of policies","type":"object"},"iam_created_resource_group_response":{"description":"A group of scoped resources.","properties":{"id":{"description":"Identifier of the group.","example":"6d7f2f5f5b1d4a0e9081fdc98d432fd1","readOnly":true,"type":"string","x-auditable":true},"meta":{"description":"Attributes associated to the resource group.","example":{"editable":"false"},"type":"object"},"scope":{"$ref":"#/components/schemas/iam_create-scope"}},"type":"object"},"iam_dns_verification_code":{"description":"DNS verification code. Add this entire string to the DNS TXT record of the email domain to validate ownership.","example":"cloudflare_dashboard_sso=023e105f4ecef8ad9ca31a8372d0c353","type":"string"},"iam_effect":{"description":"Allow or deny operations against the resources.","enum":["allow","deny"],"example":"allow","type":"string","x-auditable":true},"iam_email":{"description":"The contact email address of the user.","example":"user@example.com","maxLength":90,"type":"string","x-auditable":true},"iam_expires_on":{"description":"The expiration time on or after which the JWT MUST NOT be accepted for processing.","example":"2020-01-01T00:00:00Z","format":"date-time","type":"string","x-auditable":true},"iam_first_name":{"description":"User's first name","example":"John","maxLength":60,"nullable":true,"type":"string","x-auditable":true},"iam_grants":{"example":{"read":true,"write":false},"properties":{"read":{"example":true,"type":"boolean","x-auditable":true},"write":{"example":true,"type":"boolean","x-auditable":true}},"type":"object"},"iam_invite_components-schemas-identifier":{"description":"Invite identifier tag.","example":"4f5f0c14a2a41d5063dd301b2f829f04","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"iam_invited_by":{"description":"The email address of the user who created the invite.","example":"user@example.com","maxLength":90,"type":"string","x-auditable":true},"iam_invited_member_email":{"description":"Email address of the user to add to the organization.","example":"user@example.com","maxLength":90,"type":"string","x-auditable":true},"iam_invited_on":{"description":"When the invite was sent.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"iam_issued_on":{"description":"The time on which the token was created.","example":"2018-07-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"iam_last_name":{"description":"User's last name","example":"Appleseed","maxLength":60,"nullable":true,"type":"string","x-auditable":true},"iam_last_used_on":{"description":"Last time the token was used.","example":"2020-01-02T12:34:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"iam_list_member_policy":{"properties":{"access":{"$ref":"#/components/schemas/iam_access"},"id":{"$ref":"#/components/schemas/iam_policy_identifier"},"permission_groups":{"$ref":"#/components/schemas/iam_permission_groups"},"resource_groups":{"$ref":"#/components/schemas/iam_resource_groups"}},"title":"list_member_policy"},"iam_member_permission_group":{"description":"A group of permissions.","properties":{"id":{"description":"Identifier of the group.","example":"c8fed203ed3043cba015a93ad1616f1f","type":"string","x-auditable":true}},"required":["id"],"type":"object"},"iam_member_permission_groups":{"description":"A set of permission groups that are specified to the policy.","example":[{"id":"c8fed203ed3043cba015a93ad1616f1f"},{"id":"82e64a83756745bbbb1c9c2701bf816b"}],"items":{"$ref":"#/components/schemas/iam_member_permission_group"},"type":"array"},"iam_member_resource_group":{"description":"A group of scoped resources.","properties":{"id":{"description":"Identifier of the group.","example":"6d7f2f5f5b1d4a0e9081fdc98d432fd1","type":"string","x-auditable":true}},"required":["id"],"type":"object"},"iam_member_resource_groups":{"description":"A list of resource groups that the policy applies to.","items":{"$ref":"#/components/schemas/iam_member_resource_group"},"type":"array"},"iam_member_with_policies":{"properties":{"email":{"$ref":"#/components/schemas/iam_email"},"id":{"$ref":"#/components/schemas/iam_membership_components-schemas-identifier"},"policies":{"description":"Access policy for the membership","items":{"$ref":"#/components/schemas/iam_list_member_policy"},"type":"array"},"roles":{"description":"Roles assigned to this Member.","items":{"$ref":"#/components/schemas/iam_role"},"type":"array"},"status":{"description":"A member's status in the account.","enum":["accepted","pending"],"example":"accepted","readOnly":true,"x-auditable":true},"user":{"description":"Details of the user associated to the membership.","properties":{"email":{"$ref":"#/components/schemas/iam_email"},"first_name":{"$ref":"#/components/schemas/iam_first_name"},"id":{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"},"last_name":{"$ref":"#/components/schemas/iam_last_name"},"two_factor_authentication_enabled":{"$ref":"#/components/schemas/iam_two_factor_authentication_enabled"}},"readOnly":true,"required":["email"],"type":"object"}},"type":"object"},"iam_membership":{"properties":{"account":{"$ref":"#/components/schemas/iam_schemas-account"},"api_access_enabled":{"$ref":"#/components/schemas/iam_api_access_enabled"},"id":{"$ref":"#/components/schemas/iam_membership_components-schemas-identifier"},"permissions":{"allOf":[{"$ref":"#/components/schemas/iam_permissions"}],"description":"All access permissions for the user at the account.","readOnly":true},"roles":{"$ref":"#/components/schemas/iam_role_names"},"status":{"$ref":"#/components/schemas/iam_schemas-status"}},"type":"object"},"iam_membership-with-policies":{"properties":{"account":{"$ref":"#/components/schemas/iam_schemas-account"},"api_access_enabled":{"$ref":"#/components/schemas/iam_api_access_enabled"},"id":{"$ref":"#/components/schemas/iam_membership_components-schemas-identifier"},"permissions":{"allOf":[{"$ref":"#/components/schemas/iam_permissions"}],"description":"All access permissions for the user at the account.","readOnly":true},"policies":{"description":"Access policy for the membership","items":{"$ref":"#/components/schemas/iam_list_member_policy"},"type":"array"},"roles":{"$ref":"#/components/schemas/iam_role_names"},"status":{"$ref":"#/components/schemas/iam_schemas-status"}},"type":"object"},"iam_membership_components-schemas-identifier":{"description":"Membership identifier tag.","example":"4536bcfad5faccb111b47003c79917fa","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"iam_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"iam_modified_on":{"description":"Last time the token was modified.","example":"2018-07-02T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"iam_name":{"description":"Token name.","example":"readonly token","maxLength":120,"type":"string","x-auditable":true},"iam_not_before":{"description":"The time before which the token MUST NOT be accepted for processing.","example":"2018-07-01T05:20:00Z","format":"date-time","type":"string","x-auditable":true},"iam_organization":{"properties":{"id":{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/iam_schemas-name"},"permissions":{"$ref":"#/components/schemas/iam_schemas-permissions"},"roles":{"description":"List of roles that a user has within an organization.","items":{"example":"All Privileges - Super Administrator","maxLength":120,"type":"string","x-auditable":true},"readOnly":true,"type":"array"},"status":{"$ref":"#/components/schemas/iam_components-schemas-status"}},"type":"object"},"iam_permission_group":{"description":"A named group of permissions that map to a group of operations against resources.","properties":{"id":{"description":"Identifier of the permission group.","example":"6d7f2f5f5b1d4a0e9081fdc98d432fd1","type":"string","x-auditable":true},"meta":{"description":"Attributes associated to the permission group.","example":{"label":"load_balancer_admin","scopes":"com.cloudflare.api.account"},"properties":{"key":{"type":"string","x-auditable":true},"value":{"type":"string","x-auditable":true}},"type":"object"},"name":{"description":"Name of the permission group.","example":"Load Balancer","readOnly":true,"type":"string","x-auditable":true}},"required":["id"],"type":"object"},"iam_permission_group_identifier":{"allOf":[{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"}],"description":"Permission Group identifier tag.","title":"Permission Group Identifier"},"iam_permission_group_ids":{"description":"A set of permission groups that are specified to the policy.","example":[{"id":"c8fed203ed3043cba015a93ad1616f1f"},{"id":"82e64a83756745bbbb1c9c2701bf816b"}],"items":{"description":"A named group of permissions that map to a group of operations against resources.","properties":{"id":{"$ref":"#/components/schemas/iam_permission_group_identifier"}},"required":["id"],"type":"object"},"title":"Permission Group IDs","type":"array"},"iam_permission_groups":{"description":"A set of permission groups that are specified to the policy.","example":[{"id":"c8fed203ed3043cba015a93ad1616f1f","meta":{"label":"load_balancer_admin","scopes":"com.cloudflare.api.account"},"name":"Zone Read"},{"id":"82e64a83756745bbbb1c9c2701bf816b","meta":{"label":"fbm_user","scopes":"com.cloudflare.api.account"},"name":"Magic Network Monitoring"}],"items":{"$ref":"#/components/schemas/iam_permission_group"},"type":"array"},"iam_permissions":{"example":{"analytics":{"read":true,"write":false},"zones":{"read":true,"write":true}},"properties":{"analytics":{"$ref":"#/components/schemas/iam_grants"},"billing":{"$ref":"#/components/schemas/iam_grants"},"cache_purge":{"$ref":"#/components/schemas/iam_grants"},"dns":{"$ref":"#/components/schemas/iam_grants"},"dns_records":{"$ref":"#/components/schemas/iam_grants"},"lb":{"$ref":"#/components/schemas/iam_grants"},"logs":{"$ref":"#/components/schemas/iam_grants"},"organization":{"$ref":"#/components/schemas/iam_grants"},"ssl":{"$ref":"#/components/schemas/iam_grants"},"waf":{"$ref":"#/components/schemas/iam_grants"},"zone_settings":{"$ref":"#/components/schemas/iam_grants"},"zones":{"$ref":"#/components/schemas/iam_grants"}},"type":"object"},"iam_permissions_group_response_collection":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"example":[{"id":"7cf72faf220841aabcfdfab81c43c4f6","name":"Billing Read","scopes":["com.cloudflare.api.account"]},{"id":"9d24387c6e8544e2bc4024a03991339f","name":"Load Balancing: Monitors and Pools Read","scopes":["com.cloudflare.api.account"]},{"id":"d2a1802cc9a34e30852f8b33869b2f3c","name":"Load Balancing: Monitors and Pools Write","scopes":["com.cloudflare.api.account"]},{"id":"8b47d2786a534c08a1f94ee8f9f599ef","name":"Workers KV Storage Read","scopes":["com.cloudflare.api.account"]},{"id":"f7f0eda5697f475c90846e879bab8666","name":"Workers KV Storage Write","scopes":["com.cloudflare.api.account"]},{"id":"1a71c399035b4950a1bd1466bbe4f420","name":"Workers Scripts Read","scopes":["com.cloudflare.api.account"]},{"id":"e086da7e2179491d91ee5f35b3ca210a","name":"Workers Scripts Write","scopes":["com.cloudflare.api.account"]}],"items":{"properties":{"id":{"description":"Public ID.","type":"string","x-auditable":true},"name":{"description":"Permission Group Name","type":"string","x-auditable":true},"scopes":{"description":"Resources to which the Permission Group is scoped","items":{"enum":["com.cloudflare.api.account","com.cloudflare.api.account.zone","com.cloudflare.api.user","com.cloudflare.edge.r2.bucket"],"type":"string","x-auditable":true},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"}]},"iam_policy_identifier":{"description":"Policy identifier.","example":"f267e341f3dd4697bd3b9f71dd96247f","readOnly":true,"type":"string","x-auditable":true,"x-stainless-terraform-always-send":true},"iam_policy_with_permission_groups_and_resources":{"properties":{"effect":{"$ref":"#/components/schemas/iam_effect"},"id":{"$ref":"#/components/schemas/iam_policy_identifier"},"permission_groups":{"$ref":"#/components/schemas/iam_permission_groups"},"resources":{"$ref":"#/components/schemas/iam_resources"}},"required":["id","effect","permission_groups","resources"],"title":"Policy with Permission Groups and Resources","type":"object"},"iam_properties-name":{"description":"Account name","example":"Demo Account","maxLength":100,"type":"string","x-auditable":true},"iam_request_create_resource_group":{"properties":{"name":{"description":"Name of the resource group","example":"NewResourceGroup","type":"string"},"scope":{"$ref":"#/components/schemas/iam_create-scope"}},"required":["name","scope"],"title":"Create resource group","type":"object"},"iam_request_ip":{"description":"Client IP restrictions.","example":{"in":["123.123.123.0/24","2606:4700::/32"],"not_in":["123.123.123.100/24","2606:4700:4700::/48"]},"properties":{"in":{"$ref":"#/components/schemas/iam_cidr_list"},"not_in":{"$ref":"#/components/schemas/iam_cidr_list"}},"type":"object"},"iam_request_update_resource_group":{"properties":{"name":{"description":"Name of the resource group","example":"UpdatedResourceGroup","type":"string"},"scope":{"$ref":"#/components/schemas/iam_create-scope"}},"title":"Update resource group","type":"object"},"iam_resource_group":{"description":"A group of scoped resources.","properties":{"id":{"description":"Identifier of the resource group.","example":"6d7f2f5f5b1d4a0e9081fdc98d432fd1","readOnly":true,"type":"string","x-auditable":true},"meta":{"description":"Attributes associated to the resource group.","example":{"editable":"false"},"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"name":{"description":"Name of the resource group.","example":"com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4","readOnly":true,"type":"string","x-auditable":true},"scope":{"description":"The scope associated to the resource group","items":{"$ref":"#/components/schemas/iam_scope"},"type":"array"}},"required":["id","scope"],"type":"object"},"iam_resource_group_identifier":{"allOf":[{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"}],"description":"Resource Group identifier tag.","title":"Resource Group Identifier"},"iam_resource_group_ids":{"description":"A set of resource groups that are specified to the policy.","example":[{"id":"6d7f2f5f5b1d4a0e9081fdc98d432fd1"}],"items":{"description":"A group of scoped resources.","properties":{"id":{"$ref":"#/components/schemas/iam_resource_group_identifier"}},"required":["id"],"type":"object"},"title":"Resource Group IDs","type":"array"},"iam_resource_groups":{"description":"A list of resource groups that the policy applies to.","items":{"$ref":"#/components/schemas/iam_resource_group"},"type":"array"},"iam_resources":{"description":"A list of resource names that the policy applies to.","example":{"object":{"summary":"Nested object value","value":{"com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4":{"com.cloudflare.api.account.zone.*":"*"}}},"string":{"summary":"Single string value","value":{"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43":"*"}}},"oneOf":[{"$ref":"#/components/schemas/iam_resources_type_object_string"},{"$ref":"#/components/schemas/iam_resources_type_object_nested"}],"x-auditable":true},"iam_resources_type_object_nested":{"additionalProperties":{"additionalProperties":{"type":"string"},"description":"Nested permission object","type":"object"},"description":"Map of nested resource permissions","type":"object"},"iam_resources_type_object_string":{"additionalProperties":{"description":"Simple permission string like \"*\"","type":"string"},"description":"Map of simple string resource permissions","type":"object"},"iam_response_collection":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"items":{"type":"object"},"type":"array"}},"type":"object"}]},"iam_response_collection_accounts":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/iam_account"},"type":"array"}},"type":"object"}],"title":"Response with a list of accounts"},"iam_response_create":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"allOf":[{"type":"object"},{"properties":{"value":{"$ref":"#/components/schemas/iam_value"}},"type":"object"}]}},"type":"object"}]},"iam_response_single":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"iam_response_single_account":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_account"}},"type":"object"}],"title":"Response with a single account"},"iam_response_single_value":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_value"}},"type":"object"}]},"iam_result_info":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters","example":2000,"type":"number"}},"type":"object"},"iam_role":{"properties":{"description":{"description":"Description of role's permissions.","example":"Administrative access to the entire Account","readOnly":true,"type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/iam_role_components-schemas-identifier"},"name":{"description":"Role name.","example":"Account Administrator","maxLength":120,"readOnly":true,"type":"string","x-auditable":true},"permissions":{"allOf":[{"$ref":"#/components/schemas/iam_permissions"},{"readOnly":true}]}},"required":["id","name","description","permissions"],"type":"object"},"iam_role_components-schemas-identifier":{"description":"Role identifier tag.","example":"3536bcfad5faccb999b47003c79917fb","maxLength":32,"type":"string","x-auditable":true},"iam_role_names":{"description":"List of role names the membership has for this account.","items":{"example":"Account Administrator","maxLength":120,"type":"string","x-auditable":true},"readOnly":true,"type":"array"},"iam_schemas-account":{"allOf":[{"$ref":"#/components/schemas/iam_account"}],"readOnly":true},"iam_schemas-collection_invite_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/iam_user_invite"},"type":"array"}},"type":"object"}]},"iam_schemas-expires_on":{"description":"When the invite is no longer active.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"iam_schemas-messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"iam_schemas-name":{"description":"Organization name.","example":"Cloudflare, Inc.","maxLength":100,"type":"string","x-auditable":true},"iam_schemas-permissions":{"description":"Access permissions for this User.","items":{"example":"#zones:read","maxLength":160,"type":"string","x-auditable":true},"readOnly":true,"type":"array"},"iam_schemas-status":{"description":"Status of this membership.","enum":["accepted","pending","rejected"],"example":"accepted","type":"string","x-auditable":true},"iam_scope":{"description":"A scope is a combination of scope objects which provides additional context.","properties":{"key":{"$ref":"#/components/schemas/iam_scope_key"},"objects":{"description":"A list of scope objects for additional context.","items":{"$ref":"#/components/schemas/iam_scope_object"},"type":"array"}},"required":["key","objects"],"type":"object"},"iam_scope_key":{"description":"This is a combination of pre-defined resource name and identifier (like Account ID etc.)","example":"com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4","readOnly":true,"x-auditable":true},"iam_scope_object":{"description":"A scope object represents any resource that can have actions applied against invite.","properties":{"key":{"$ref":"#/components/schemas/iam_scope_object_key"}},"required":["key"],"type":"object"},"iam_scope_object_key":{"description":"This is a combination of pre-defined resource name and identifier (like Zone ID etc.)","example":"com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5","readOnly":true,"x-auditable":true},"iam_single_invite_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_user_invite"}},"type":"object"}]},"iam_single_member_response_with_policies":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_member_with_policies"}},"type":"object"}],"title":"Response with Policies"},"iam_single_membership_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_membership"}},"type":"object"}],"title":"response_with_roles"},"iam_single_membership_response_with_policies":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_membership-with-policies"}},"type":"object"}],"title":"response_with_policies"},"iam_single_organization_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"iam_single_permission_groups_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_permission_group"}},"type":"object"}],"title":"Response with Permission Groups"},"iam_single_role_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_role"}},"type":"object"}]},"iam_single_token_create_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_token_with_value"}},"type":"object"}],"title":"Response of a create request with a single token"},"iam_single_token_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_token_base"}},"type":"object"}],"title":"Response with a single token"},"iam_single_user_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"properties":{"betas":{"description":"Lists the betas that the user is participating in.","items":{"description":"User feature flag","example":"zone_level_access_beta","type":"string"},"readOnly":true,"type":"array"},"country":{"$ref":"#/components/schemas/iam_country"},"first_name":{"$ref":"#/components/schemas/iam_first_name"},"has_business_zones":{"default":false,"description":"Indicates whether user has any business zones","readOnly":true,"type":"boolean"},"has_enterprise_zones":{"default":false,"description":"Indicates whether user has any enterprise zones","readOnly":true,"type":"boolean"},"has_pro_zones":{"default":false,"description":"Indicates whether user has any pro zones","readOnly":true,"type":"boolean"},"id":{"description":"Identifier of the user.","example":"6d7f2f5f5b1d4a0e9081fdc98d432fd1","readOnly":true,"type":"string"},"last_name":{"$ref":"#/components/schemas/iam_last_name"},"organizations":{"items":{"$ref":"#/components/schemas/iam_organization"},"type":"array"},"suspended":{"default":false,"description":"Indicates whether user has been suspended","readOnly":true,"type":"boolean"},"telephone":{"$ref":"#/components/schemas/iam_telephone"},"two_factor_authentication_enabled":{"$ref":"#/components/schemas/iam_two_factor_authentication_enabled"},"two_factor_authentication_locked":{"$ref":"#/components/schemas/iam_two_factor_authentication_locked"},"zipcode":{"$ref":"#/components/schemas/iam_zipcode"}},"type":"object"}},"type":"object"}]},"iam_sso_connector":{"properties":{"created_on":{"description":"Timestamp for the creation of the SSO connector","example":"2025-01-01T12:21:02.0000Z","format":"date-time","type":"string"},"email_domain":{"example":"example.com","type":"string"},"enabled":{"example":false,"type":"boolean"},"id":{"$ref":"#/components/schemas/iam_sso_connector_identifier"},"updated_on":{"description":"Timestamp for the last update of the SSO connector","example":"2025-01-01T12:21:02.0000Z","format":"date-time","type":"string"},"use_fedramp_language":{"$ref":"#/components/schemas/iam_use_fedramp_language"},"verification":{"$ref":"#/components/schemas/iam_sso_connector_verification_info"}},"type":"object"},"iam_sso_connector_collection_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/iam_sso_connector"},"type":"array"}},"type":"object"}],"title":"Response of initializing a new sso connector"},"iam_sso_connector_identifier":{"allOf":[{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"}],"description":"SSO Connector identifier tag.","title":"SSO Connector Identifier"},"iam_sso_connector_response":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_sso_connector"}},"type":"object"}],"title":"Response of initializing a new sso connector"},"iam_sso_connector_verification_info":{"properties":{"code":{"$ref":"#/components/schemas/iam_dns_verification_code"},"status":{"description":"The status of the verification code from the verification process.","enum":["awaiting","pending","failed","verified"],"example":"pending","type":"string"}},"type":"object"},"iam_telephone":{"description":"User's telephone number","example":"+1 123-123-1234","maxLength":20,"nullable":true,"type":"string"},"iam_token_base":{"properties":{"condition":{"$ref":"#/components/schemas/iam_condition"},"expires_on":{"$ref":"#/components/schemas/iam_expires_on"},"id":{"$ref":"#/components/schemas/iam_token_identifier"},"issued_on":{"$ref":"#/components/schemas/iam_issued_on"},"last_used_on":{"$ref":"#/components/schemas/iam_last_used_on"},"modified_on":{"$ref":"#/components/schemas/iam_modified_on"},"name":{"$ref":"#/components/schemas/iam_name"},"not_before":{"$ref":"#/components/schemas/iam_not_before"},"policies":{"$ref":"#/components/schemas/iam_token_policies"},"status":{"$ref":"#/components/schemas/iam_token_status"}},"type":"object"},"iam_token_body":{"allOf":[{"$ref":"#/components/schemas/iam_token_base"},{"type":"object"},{"required":["name","policies"]}],"title":"Token defined in a request body"},"iam_token_identifier":{"description":"Token identifier tag.","example":"ed17574386854bf78a67040be0a770b0","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"iam_token_policies":{"description":"List of access policies assigned to the token.","items":{"$ref":"#/components/schemas/iam_policy_with_permission_groups_and_resources"},"type":"array"},"iam_token_status":{"description":"Status of the token.","enum":["active","disabled","expired"],"example":"active","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"iam_token_verify_response_single_segment":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"properties":{"expires_on":{"$ref":"#/components/schemas/iam_expires_on"},"id":{"$ref":"#/components/schemas/iam_token_identifier"},"not_before":{"$ref":"#/components/schemas/iam_not_before"},"status":{"$ref":"#/components/schemas/iam_token_status"}},"required":["id","status"]}},"type":"object"}]},"iam_token_with_value":{"allOf":[{"$ref":"#/components/schemas/iam_token_base"},{"properties":{"value":{"$ref":"#/components/schemas/iam_value"}}}],"title":"Create token response, with the token value"},"iam_two_factor_authentication_enabled":{"default":false,"description":"Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication.","readOnly":true,"type":"boolean"},"iam_two_factor_authentication_locked":{"default":false,"description":"Indicates whether two-factor authentication is required by one of the accounts that the user is a member of.","readOnly":true,"type":"boolean"},"iam_unit-identifier":{"description":"Tenant unit identifier.","example":"f267e341f3dd4697bd3b9f71dd96247f","readOnly":true,"type":"string","x-auditable":true},"iam_update-member-with-policies":{"properties":{"policies":{"description":"Array of policies associated with this member.","items":{"$ref":"#/components/schemas/iam_create_member_policy"},"type":"array"}},"required":["policies"],"title":"Update Member with Policies","type":"object"},"iam_update-member-with-roles":{"properties":{"id":{"$ref":"#/components/schemas/iam_membership_components-schemas-identifier"},"roles":{"description":"Roles assigned to this member.","items":{"$ref":"#/components/schemas/iam_role"},"type":"array"},"status":{"description":"A member's status in the account.","enum":["accepted","pending"],"example":"accepted","readOnly":true,"x-auditable":true},"user":{"description":"Details of the user associated to the membership.","properties":{"email":{"$ref":"#/components/schemas/iam_email"},"first_name":{"$ref":"#/components/schemas/iam_first_name"},"id":{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"},"last_name":{"$ref":"#/components/schemas/iam_last_name"},"two_factor_authentication_enabled":{"$ref":"#/components/schemas/iam_two_factor_authentication_enabled"}},"readOnly":true,"required":["email"],"type":"object"}},"title":"Update Member with Account Roles","type":"object"},"iam_update_user_group_body":{"properties":{"name":{"description":"Name of the User group.","example":"My New User Group","type":"string"},"policies":{"description":"Policies attached to the User group","items":{"allOf":[{"properties":{"id":{"description":"Policy identifier.","example":"f267e341f3dd4697bd3b9f71dd96247f","type":"string"}},"required":["id"],"type":"object"},{"$ref":"#/components/schemas/iam_user_group_policy_write_body"}]},"title":"User Group Policies","type":"array"}},"title":"Create User group with a set of policies","type":"object"},"iam_use_fedramp_language":{"default":false,"description":"Controls the display of FedRAMP language to the user during SSO login","example":false,"type":"boolean"},"iam_user_group":{"description":"A group of policies resources.","properties":{"created_on":{"description":"Timestamp for the creation of the user group","example":"2024-03-01T12:21:02.0000Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/iam_user_group_identifier"},"modified_on":{"description":"Last time the user group was modified.","example":"2024-03-01T12:21:02.0000Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"name":{"description":"Name of the user group.","example":"My New User Group","readOnly":true,"type":"string","x-auditable":true},"policies":{"description":"Policies attached to the User group","items":{"description":"Policy","properties":{"access":{"$ref":"#/components/schemas/iam_access"},"id":{"$ref":"#/components/schemas/iam_policy_identifier"},"permission_groups":{"$ref":"#/components/schemas/iam_permission_groups"},"resource_groups":{"$ref":"#/components/schemas/iam_resource_groups"}},"title":"Authorization Policy"},"title":"User Group Policies","type":"array"}},"required":["id","name","created_on","modified_on"],"type":"object"},"iam_user_group_identifier":{"allOf":[{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"}],"description":"User Group identifier tag.","title":"User Group Identifier"},"iam_user_group_member":{"description":"Member attached to a User Group.","properties":{"email":{"$ref":"#/components/schemas/iam_email"},"id":{"description":"Account member identifier.","example":"4f5f0c14a2a41d5063dd301b2f829f04","readOnly":true,"type":"string"},"status":{"description":"The member's status in the account.","enum":["accepted","pending"],"example":"accepted","readOnly":true}},"required":["id"],"type":"object"},"iam_user_group_member_identifier":{"allOf":[{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"}],"description":"The identifier of an existing account Member.","title":"User Group Member Identifier"},"iam_user_group_policy_write_body":{"properties":{"access":{"$ref":"#/components/schemas/iam_access"},"permission_groups":{"$ref":"#/components/schemas/iam_permission_group_ids"},"resource_groups":{"$ref":"#/components/schemas/iam_resource_group_ids"}},"required":["access","permission_groups","resource_groups"]},"iam_user_groups":{"description":"A list of user groups for the account.","items":{"$ref":"#/components/schemas/iam_user_group"},"title":"User Groups","type":"array"},"iam_user_invite":{"properties":{"expires_on":{"$ref":"#/components/schemas/iam_schemas-expires_on"},"id":{"$ref":"#/components/schemas/iam_invite_components-schemas-identifier"},"invited_by":{"$ref":"#/components/schemas/iam_invited_by"},"invited_member_email":{"$ref":"#/components/schemas/iam_invited_member_email"},"invited_member_id":{"description":"ID of the user to add to the organization.","example":"5a7805061c76ada191ed06f989cc3dac","maxLength":32,"nullable":true,"readOnly":true,"type":"string","x-auditable":true},"invited_on":{"$ref":"#/components/schemas/iam_invited_on"},"organization_id":{"description":"ID of the organization the user will be added to.","example":"5a7805061c76ada191ed06f989cc3dac","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"organization_is_enforcing_twofactor":{"example":true,"type":"boolean","x-auditable":true},"organization_name":{"description":"Organization name.","example":"Cloudflare, Inc.","maxLength":100,"readOnly":true,"type":"string","x-auditable":true},"roles":{"$ref":"#/components/schemas/iam_role_names"},"status":{"description":"Current status of the invitation.","enum":["pending","accepted","rejected","expired"],"example":"accepted","x-auditable":true}},"required":["invited_member_id","organization_id"],"type":"object"},"iam_value":{"description":"The token value.","example":"8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T","maxLength":80,"minLength":40,"readOnly":true,"type":"string","x-sensitive":true},"iam_zipcode":{"description":"The zipcode or postal code where the user lives.","example":"12345","maxLength":20,"nullable":true,"type":"string"},"images_account_identifier":{"description":"Account identifier tag.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"images_api-response-collection-v2":{"allOf":[{"$ref":"#/components/schemas/images_api-response-common"},{"properties":{"result":{"properties":{"continuation_token":{"$ref":"#/components/schemas/images_images_list_continuation_token"}},"type":"object"}}}],"type":"object"},"images_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/images_messages"},"messages":{"$ref":"#/components/schemas/images_messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean","x-auditable":true}},"required":["success","errors","messages","result"],"type":"object"},"images_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/images_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/images_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean","x-auditable":true}},"required":["success","errors","messages","result"],"type":"object"},"images_api-response-single":{"allOf":[{"$ref":"#/components/schemas/images_api-response-common"},{"properties":{"result":{"anyOf":[{"type":"object"},{"type":"string"}]}}}],"type":"object"},"images_deleted_response":{"allOf":[{"$ref":"#/components/schemas/images_api-response-single"},{"properties":{"result":{"example":{},"type":"object"}}}]},"images_image":{"properties":{"creator":{"$ref":"#/components/schemas/images_image_creator"},"filename":{"$ref":"#/components/schemas/images_image_filename"},"id":{"$ref":"#/components/schemas/images_image_identifier"},"meta":{"$ref":"#/components/schemas/images_image_metadata"},"requireSignedURLs":{"$ref":"#/components/schemas/images_image_requireSignedURLs"},"uploaded":{"$ref":"#/components/schemas/images_image_uploaded"},"variants":{"$ref":"#/components/schemas/images_image_variants"}},"type":"object"},"images_image_basic_upload":{"properties":{"creator":{"description":"Can set the creator field with an internal user ID.","maxLength":1024,"type":"string"},"file":{"description":"An image binary data. Only needed when type is uploading a file.","format":"binary","type":"string","x-auditable":true},"id":{"description":"An optional custom unique identifier for your image.","type":"string","x-auditable":true},"metadata":{"description":"User modifiable key-value store. Can use used for keeping references to another system of record for managing images.","type":"object"},"requireSignedURLs":{"default":false,"description":"Indicates whether the image requires a signature token for the access.","example":true,"type":"boolean","x-auditable":true},"url":{"description":"A URL to fetch an image from origin. Only needed when type is uploading from a URL.","example":"https://example.com/path/to/logo.png","type":"string","x-auditable":true}},"type":"object"},"images_image_creator":{"description":"Can set the creator field with an internal user ID.","example":"107b9558-dd06-4bbd-5fef-9c2c16bb7900","maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"images_image_direct_upload_request_v2":{"properties":{"creator":{"description":"Can set the creator field with an internal user ID.","type":"string"},"expiry":{"default":"Now + 30 minutes","description":"The date after which the upload will not be accepted. Minimum: Now + 2 minutes. Maximum: Now + 6 hours.","example":"2021-01-02T02:20:00Z","format":"date-time","type":"string","x-auditable":true},"id":{"description":"Optional Image Custom ID. Up to 1024 chars. Can include any number of subpaths, and utf8 characters. Cannot start nor end with a / (forward slash). Cannot be a UUID.","example":"this/is/my-customid","maxLength":1024,"type":"string","x-auditable":true},"metadata":{"description":"User modifiable key-value store. Can be used for keeping references to another system of record, for managing images.","type":"object"},"requireSignedURLs":{"default":false,"description":"Indicates whether the image requires a signature token to be accessed.","example":true,"type":"boolean","x-auditable":true}},"type":"object"},"images_image_direct_upload_response_v2":{"allOf":[{"$ref":"#/components/schemas/images_api-response-single"},{"properties":{"result":{"properties":{"id":{"description":"Image unique identifier.","example":"e22e9e6b-c02b-42fd-c405-6c32af5fe600","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"uploadURL":{"description":"The URL the unauthenticated upload can be performed to using a single HTTP POST (multipart/form-data) request.","example":"https://upload.imagedelivery.net/FxUufywByo0m2v3xhKSiU8/e22e9e6b-c02b-42fd-c405-6c32af5fe600","type":"string","x-auditable":true}}}}}]},"images_image_filename":{"description":"Image file name.","example":"logo.png","maxLength":255,"readOnly":true,"type":"string","x-auditable":true},"images_image_hero_url":{"description":"URI to hero variant for an image.","example":"https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero","format":"uri","readOnly":true,"type":"string","x-auditable":true},"images_image_identifier":{"description":"Image unique identifier.","example":"107b9558-dd06-4bbd-5fef-9c2c16bb7900","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"images_image_key_name":{"description":"Key name.","example":"default","readOnly":true,"type":"string","x-auditable":true},"images_image_key_response_collection":{"allOf":[{"$ref":"#/components/schemas/images_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/images_image_keys_response"}}}]},"images_image_key_value":{"description":"Key value.","example":"Oix0bbNaT8Rge9PuyxUBrjI6zrgnsyJ5=","readOnly":true,"type":"string","x-auditable":true},"images_image_keys":{"properties":{"name":{"$ref":"#/components/schemas/images_image_key_name"},"value":{"$ref":"#/components/schemas/images_image_key_value"}},"type":"object"},"images_image_keys_response":{"properties":{"keys":{"items":{"$ref":"#/components/schemas/images_image_keys"},"type":"array"}},"type":"object"},"images_image_metadata":{"description":"User modifiable key-value store. Can be used for keeping references to another system of record for managing images. Metadata must not exceed 1024 bytes.","example":{"key":"value"},"type":"object"},"images_image_original_url":{"description":"URI to original variant for an image.","example":"https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original","format":"uri","readOnly":true,"type":"string","x-auditable":true},"images_image_patch_request":{"properties":{"creator":{"description":"Can set the creator field with an internal user ID.","type":"string"},"metadata":{"description":"User modifiable key-value store. Can be used for keeping references to another system of record for managing images. No change if not specified.","type":"object"},"requireSignedURLs":{"description":"Indicates whether the image can be accessed using only its UID. If set to `true`, a signed token needs to be generated with a signing key to view the image. Returns a new UID on a change. No change if not specified.","example":true,"type":"boolean","x-auditable":true}},"type":"object"},"images_image_requireSignedURLs":{"default":false,"description":"Indicates whether the image can be a accessed only using it's UID. If set to true, a signed token needs to be generated with a signing key to view the image.","example":true,"type":"boolean","x-auditable":true},"images_image_response_blob":{"anyOf":[{"type":"string"},{"type":"object"}],"example":"\u003cimage blob data\u003e"},"images_image_response_single":{"allOf":[{"$ref":"#/components/schemas/images_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/images_image"}}}]},"images_image_thumbnail_url":{"description":"URI to thumbnail variant for an image.","example":"https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail","format":"uri","readOnly":true,"type":"string","x-auditable":true},"images_image_uploaded":{"description":"When the media item was uploaded.","example":"2014-01-02T02:20:00.123Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"images_image_variant_definition":{"properties":{"id":{"$ref":"#/components/schemas/images_image_variant_identifier"},"neverRequireSignedURLs":{"$ref":"#/components/schemas/images_image_variant_neverRequireSignedURLs"},"options":{"$ref":"#/components/schemas/images_image_variant_options"}},"required":["id","options"],"type":"object"},"images_image_variant_fit":{"description":"The fit property describes how the width and height dimensions should be interpreted.","enum":["scale-down","contain","cover","crop","pad"],"example":"scale-down","type":"string","x-auditable":true},"images_image_variant_height":{"description":"Maximum height in image pixels.","example":768,"minimum":1,"type":"number","x-auditable":true},"images_image_variant_identifier":{"example":"hero","maxLength":99,"pattern":"^[a-zA-Z0-9]$","type":"string","x-auditable":true},"images_image_variant_list_response":{"allOf":[{"$ref":"#/components/schemas/images_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/images_image_variants_response"}}}]},"images_image_variant_neverRequireSignedURLs":{"default":false,"description":"Indicates whether the variant can access an image without a signature, regardless of image access control.","example":true,"type":"boolean","x-auditable":true},"images_image_variant_options":{"description":"Allows you to define image resizing sizes for different use cases.","properties":{"fit":{"$ref":"#/components/schemas/images_image_variant_fit"},"height":{"$ref":"#/components/schemas/images_image_variant_height"},"metadata":{"$ref":"#/components/schemas/images_image_variant_schemas_metadata"},"width":{"$ref":"#/components/schemas/images_image_variant_width"}},"required":["fit","metadata","width","height"],"type":"object"},"images_image_variant_patch_request":{"properties":{"neverRequireSignedURLs":{"$ref":"#/components/schemas/images_image_variant_neverRequireSignedURLs"},"options":{"$ref":"#/components/schemas/images_image_variant_options"}},"required":["options"],"type":"object"},"images_image_variant_public_request":{"properties":{"hero":{"properties":{"id":{"$ref":"#/components/schemas/images_image_variant_identifier"},"neverRequireSignedURLs":{"$ref":"#/components/schemas/images_image_variant_neverRequireSignedURLs"},"options":{"$ref":"#/components/schemas/images_image_variant_options"}},"required":["id","options"],"type":"object"}},"type":"object"},"images_image_variant_response":{"properties":{"variant":{"$ref":"#/components/schemas/images_image_variant_definition"}},"type":"object"},"images_image_variant_schemas_metadata":{"description":"What EXIF data should be preserved in the output image.","enum":["keep","copyright","none"],"example":"none","type":"string","x-auditable":true},"images_image_variant_simple_response":{"allOf":[{"$ref":"#/components/schemas/images_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/images_image_variant_response"}}}]},"images_image_variant_width":{"description":"Maximum width in image pixels.","example":1366,"minimum":1,"type":"number","x-auditable":true},"images_image_variants":{"description":"Object specifying available variants for an image.","example":["https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail","https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero","https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original"],"items":{"anyOf":[{"$ref":"#/components/schemas/images_image_thumbnail_url"},{"$ref":"#/components/schemas/images_image_hero_url"},{"$ref":"#/components/schemas/images_image_original_url"}]},"readOnly":true,"type":"array"},"images_image_variants_response":{"properties":{"variants":{"$ref":"#/components/schemas/images_image_variant_public_request"}},"type":"object"},"images_images_list_continuation_token":{"description":"Continuation token to fetch next page. Passed as a query param when requesting List V2 api endpoint.","example":"iD0bxlWFSVUWsDHbzIqvDkgBW4otifAAuGXLz1n8BQA","maxLength":32,"nullable":true,"readOnly":true,"type":"string","x-auditable":true},"images_images_list_response":{"allOf":[{"$ref":"#/components/schemas/images_api-response-common"},{"properties":{"result":{"properties":{"images":{"items":{"$ref":"#/components/schemas/images_image"},"type":"array"}},"type":"object"}}}]},"images_images_list_response_v2":{"allOf":[{"$ref":"#/components/schemas/images_api-response-collection-v2"},{"properties":{"result":{"properties":{"images":{"items":{"$ref":"#/components/schemas/images_image"},"type":"array"}},"type":"object"}}}]},"images_images_stats":{"properties":{"count":{"$ref":"#/components/schemas/images_images_stats_count"}},"type":"object"},"images_images_stats_allowed":{"description":"Cloudflare Images allowed usage.","example":100000,"readOnly":true,"type":"number","x-auditable":true},"images_images_stats_count":{"properties":{"allowed":{"$ref":"#/components/schemas/images_images_stats_allowed"},"current":{"$ref":"#/components/schemas/images_images_stats_current"}},"type":"object"},"images_images_stats_current":{"description":"Cloudflare Images current usage.","example":1000,"readOnly":true,"type":"number","x-auditable":true},"images_images_stats_response":{"allOf":[{"$ref":"#/components/schemas/images_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/images_images_stats"}}}]},"images_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer","x-auditable":true},"message":{"type":"string","x-auditable":true}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"images_signing_key_identifier":{"example":"someKey","maxLength":20,"pattern":"^[a-zA-Z0-9]$","type":"string","x-auditable":true},"infra_AccountTag":{"description":"Account identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"title":"account_id","type":"string"},"infra_ConnectivityServiceArray":{"items":{"$ref":"#/components/schemas/infra_ServiceConfig"},"type":"array"},"infra_DualStackHost":{"example":{"ipv4":"10.0.0.1","ipv6":"fe80::1","network":{"tunnel_id":"0191dce4-9ab4-7fce-b660-8e5dec5172da"}},"properties":{"ipv4":{"example":"10.0.0.1","type":"string"},"ipv6":{"example":"fe80::1","type":"string"},"network":{"$ref":"#/components/schemas/infra_Network"}},"required":["ipv4","ipv6","network"],"type":"object"},"infra_HostnameHost":{"example":{"hostname":"example.com","resolver_network":{"resolver_ips":["10.0.0.1"],"tunnel_id":"0191dce4-9ab4-7fce-b660-8e5dec5172da"}},"properties":{"hostname":{"example":"example.com","type":"string"},"resolver_network":{"$ref":"#/components/schemas/infra_ResolverNetwork"}},"required":["hostname","resolver_network"],"type":"object"},"infra_HttpServiceConfig":{"allOf":[{"$ref":"#/components/schemas/infra_ServiceCommon"},{"properties":{"http_port":{"example":8080,"format":"int32","minimum":1,"nullable":true,"type":"integer"},"https_port":{"example":8443,"format":"int32","minimum":1,"nullable":true,"type":"integer"}},"type":"object"}],"example":{"host":{"ipv4":"10.0.0.1","network":{"tunnel_id":"0191dce4-9ab4-7fce-b660-8e5dec5172da"}},"http_port":8080,"https_port":8443,"name":"web-app","type":"http"}},"infra_IPInfo":{"description":"The IPv4/IPv6 address that identifies where to reach a target","properties":{"ipv4":{"description":"The target's IPv4 address","properties":{"ip_addr":{"description":"IP address of the target","example":"187.26.29.249","type":"string","x-auditable":true},"virtual_network_id":{"description":"(optional) Private virtual network identifier for the target. If omitted, the default virtual network ID will be used.","example":"c77b744e-acc8-428f-9257-6878c046ed55","format":"uuid","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"}},"type":"object"},"ipv6":{"description":"The target's IPv6 address","properties":{"ip_addr":{"description":"IP address of the target","example":"64c0:64e8:f0b4:8dbf:7104:72b0:ec8f:f5e0","type":"string","x-auditable":true},"virtual_network_id":{"description":"(optional) Private virtual network identifier for the target. If omitted, the default virtual network ID will be used.","example":"c77b744e-acc8-428f-9257-6878c046ed55","format":"uuid","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"}},"type":"object"}},"type":"object"},"infra_IPv4Host":{"example":{"ipv4":"10.0.0.1","network":{"tunnel_id":"0191dce4-9ab4-7fce-b660-8e5dec5172da"}},"properties":{"ipv4":{"example":"10.0.0.1","type":"string"},"network":{"$ref":"#/components/schemas/infra_Network"}},"required":["ipv4","network"],"type":"object"},"infra_IPv6Host":{"example":{"ipv6":"fe80::1","network":{"tunnel_id":"0191dce4-9ab4-7fce-b660-8e5dec5172da"}},"properties":{"ipv6":{"example":"fe80::1","type":"string"},"network":{"$ref":"#/components/schemas/infra_Network"}},"required":["ipv6","network"],"type":"object"},"infra_Network":{"properties":{"tunnel_id":{"example":"0191dce4-9ab4-7fce-b660-8e5dec5172da","format":"uuid","type":"string"}},"required":["tunnel_id"],"type":"object"},"infra_ResolverNetwork":{"properties":{"resolver_ips":{"items":{"type":"string"},"nullable":true,"type":"array"},"tunnel_id":{"example":"0191dce4-9ab4-7fce-b660-8e5dec5172da","format":"uuid","type":"string"}},"required":["tunnel_id"],"type":"object"},"infra_ServiceCommon":{"properties":{"created_at":{"example":"2024-01-15T09:30:00Z","format":"date-time","readOnly":true,"type":"string"},"host":{"$ref":"#/components/schemas/infra_ServiceHost"},"name":{"example":"web-server","type":"string"},"service_id":{"example":"550e8400-e29b-41d4-a716-446655440000","format":"uuid","readOnly":true,"type":"string"},"type":{"$ref":"#/components/schemas/infra_ServiceType"},"updated_at":{"example":"2024-01-15T10:45:00Z","format":"date-time","readOnly":true,"type":"string"}},"required":["name","type","host"],"type":"object"},"infra_ServiceConfig":{"discriminator":{"mapping":{"http":"#/components/schemas/infra_HttpServiceConfig"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/infra_HttpServiceConfig"}]},"infra_ServiceHost":{"oneOf":[{"$ref":"#/components/schemas/infra_IPv4Host"},{"$ref":"#/components/schemas/infra_IPv6Host"},{"$ref":"#/components/schemas/infra_DualStackHost"},{"$ref":"#/components/schemas/infra_HostnameHost"}]},"infra_ServiceType":{"enum":["http"],"type":"string"},"infra_SortingDirection":{"enum":["asc","desc"],"type":"string"},"infra_Target":{"properties":{"created_at":{"description":"Date and time at which the target was created","example":"2019-08-24T14:15:22Z","format":"date-time","type":"string"},"hostname":{"description":"A non-unique field that refers to a target","example":"infra-access-target","type":"string"},"id":{"$ref":"#/components/schemas/infra_TargetId"},"ip":{"$ref":"#/components/schemas/infra_IPInfo"},"modified_at":{"description":"Date and time at which the target was modified","example":"2019-08-24T14:15:22Z","format":"date-time","type":"string"}},"required":["id","hostname","ip","created_at","modified_at"],"type":"object"},"infra_TargetArray":{"items":{"$ref":"#/components/schemas/infra_Target"},"type":"array"},"infra_TargetId":{"description":"Target identifier","example":"0191dce4-9ab4-7fce-b660-8e5dec5172da","format":"uuid","maxLength":36,"title":"target_id","type":"string","x-auditable":true},"infra_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/infra_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"infra_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/infra_messages"},"messages":{"$ref":"#/components/schemas/infra_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"infra_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/infra_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/infra_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"infra_api-response-single":{"allOf":[{"$ref":"#/components/schemas/infra_api-response-common"}],"type":"object"},"infra_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"intel-sinkholes_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/intel-sinkholes_messages"},"messages":{"$ref":"#/components/schemas/intel-sinkholes_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"intel-sinkholes_empty_object_response":{"type":"object"},"intel-sinkholes_get_sinkholes_response":{"allOf":[{"$ref":"#/components/schemas/intel-sinkholes_api-response-common"},{"properties":{"result":{"example":[{"account_tag":"233f45e61fd1f7e21e1e154ede4q2859","created_on":"2023-05-12T12:21:56.777653Z","description":"user specified description 1","id":1,"modified_on":"2023-06-18T03:13:34.123321Z","name":"sinkhole_1","r2_bucket":"my_bucket","r2_id":"\u003cr2_id\u003e"},{"account_tag":"233f45e61fd1f7e21e1e154ede4q2859","created_on":"2023-05-21T21:43:52.867525Z","description":"user specified description 2","id":2,"modified_on":"2023-06-28T18:46:18.764425Z","name":"sinkhole_1","r2_bucket":"my_bucket","r2_id":"\u003cr2_id\u003e"}],"items":{"$ref":"#/components/schemas/intel-sinkholes_sinkhole_item"},"type":"array"}}}]},"intel-sinkholes_id":{"description":"The unique identifier for the sinkhole","type":"integer"},"intel-sinkholes_identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"intel-sinkholes_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"intel-sinkholes_name":{"description":"The name of the sinkhole","type":"string"},"intel-sinkholes_sinkhole_item":{"example":{"account_tag":"233f45e61fd1f7e21e1e154ede4q2859","created_on":"2023-05-12T12:21:56.777653Z","description":"user specified description 1","id":1,"modified_on":"2023-06-18T03:13:34.123321Z","name":"sinkhole_1","r2_bucket":"my_bucket","r2_id":"\u003cr2_id\u003e"},"properties":{"account_tag":{"description":"The account tag that owns this sinkhole","type":"string"},"created_on":{"description":"The date and time when the sinkhole was created","format":"date-time","type":"string"},"id":{"$ref":"#/components/schemas/intel-sinkholes_id"},"modified_on":{"description":"The date and time when the sinkhole was last modified","format":"date-time","type":"string"},"name":{"$ref":"#/components/schemas/intel-sinkholes_name"},"r2_bucket":{"description":"The name of the R2 bucket to store results","type":"string"},"r2_id":{"description":"The id of the R2 instance","type":"string"}}},"intel_additional_information":{"description":"Additional information related to the host name.","properties":{"suspected_malware_family":{"description":"Suspected DGA malware family.","example":"","type":"string","x-auditable":true}},"type":"object"},"intel_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/intel_api-response-common"},{"properties":{"result":{"items":{"oneOf":[{"type":"string"},{"type":"object"}]},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/intel_result_info"}},"type":"object"}],"type":"object"},"intel_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/intel_messages"},"messages":{"$ref":"#/components/schemas/intel_messages"},"result":{"anyOf":[{"type":"object"},{"items":{"oneOf":[{"type":"string"},{"type":"object"}]},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"intel_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/intel_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/intel_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"intel_api-response-single":{"allOf":[{"$ref":"#/components/schemas/intel_schemas-api-response-common"}],"type":"object"},"intel_application":{"description":"Application that the hostname belongs to.","properties":{"id":{"type":"integer","x-auditable":true},"name":{"example":"CLOUDFLARE","type":"string","x-auditable":true}},"type":"object"},"intel_asn":{"type":"integer","x-auditable":true},"intel_asn_components-schemas-response":{"allOf":[{"$ref":"#/components/schemas/intel_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/intel_asn"}},"type":"object"}],"type":"object"},"intel_asn_country":{"example":"US","type":"string","x-auditable":true},"intel_asn_description":{"example":"CLOUDFLARENET","type":"string","x-auditable":true},"intel_asn_type":{"description":"Infrastructure type of this ASN.","enum":["hosting_provider","isp","organization"],"example":"hosting_provider","type":"string","x-auditable":true},"intel_categories_with_super_category_ids_example_empty":{"example":[],"items":{"$ref":"#/components/schemas/intel_category_with_super_category_id"},"type":"array"},"intel_category_with_super_category_id":{"properties":{"id":{"type":"integer","x-auditable":true},"name":{"type":"string","x-auditable":true},"super_category_id":{"type":"integer","x-auditable":true}},"type":"object"},"intel_collection_response":{"allOf":[{"$ref":"#/components/schemas/intel_api-response-collection"},{"properties":{"result":{"items":{"properties":{"additional_information":{"$ref":"#/components/schemas/intel_additional_information"},"application":{"$ref":"#/components/schemas/intel_application"},"content_categories":{"$ref":"#/components/schemas/intel_content_categories"},"domain":{"$ref":"#/components/schemas/intel_domain_name"},"inherited_content_categories":{"$ref":"#/components/schemas/intel_inherited_content_categories"},"inherited_from":{"$ref":"#/components/schemas/intel_inherited_from"},"inherited_risk_types":{"$ref":"#/components/schemas/intel_inherited_risk_types"},"popularity_rank":{"$ref":"#/components/schemas/intel_popularity_rank"},"risk_score":{"$ref":"#/components/schemas/intel_risk_score"},"risk_types":{"$ref":"#/components/schemas/intel_risk_types"}},"type":"object"},"type":"array"}},"type":"object"}],"type":"object"},"intel_components-schemas-response":{"allOf":[{"$ref":"#/components/schemas/intel_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/intel_ip-list"},"type":"array"}},"type":"object"}],"type":"object"},"intel_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/intel_schemas-api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/intel_passive-dns-by-ip"}},"type":"object"}],"type":"object"},"intel_content_categories":{"example":[{"id":155,"name":"Technology","super_category_id":26}],"items":{"description":"Current content categories.","properties":{"id":{"type":"integer","x-auditable":true},"name":{"type":"string","x-auditable":true},"super_category_id":{"type":"integer","x-auditable":true}},"type":"object"},"type":"array"},"intel_count":{"description":"Total results returned based on your search parameters.","example":1,"type":"number"},"intel_domain":{"properties":{"additional_information":{"$ref":"#/components/schemas/intel_additional_information"},"application":{"$ref":"#/components/schemas/intel_application"},"content_categories":{"$ref":"#/components/schemas/intel_content_categories"},"domain":{"$ref":"#/components/schemas/intel_domain_name"},"inherited_content_categories":{"$ref":"#/components/schemas/intel_inherited_content_categories"},"inherited_from":{"$ref":"#/components/schemas/intel_inherited_from"},"inherited_risk_types":{"$ref":"#/components/schemas/intel_inherited_risk_types"},"popularity_rank":{"$ref":"#/components/schemas/intel_popularity_rank"},"resolves_to_refs":{"$ref":"#/components/schemas/intel_resolves_to_refs"},"risk_score":{"$ref":"#/components/schemas/intel_risk_score"},"risk_types":{"$ref":"#/components/schemas/intel_risk_types"}},"type":"object"},"intel_domain-history":{"properties":{"categorizations":{"items":{"properties":{"categories":{"example":[{"id":155,"name":"Technology"}],"items":{"properties":{"id":{"example":155,"type":"integer"},"name":{"example":"Technology","type":"string"}},"type":"object"},"type":"array"},"end":{"example":"2021-04-30","format":"date","type":"string","x-auditable":true},"start":{"example":"2021-04-01","format":"date","type":"string","x-auditable":true}},"type":"object"},"type":"array"},"domain":{"$ref":"#/components/schemas/intel_domain_name"}},"type":"object"},"intel_domain_name":{"example":"cloudflare.com","type":"string","x-auditable":true},"intel_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"intel_inherited_content_categories":{"$ref":"#/components/schemas/intel_categories_with_super_category_ids_example_empty"},"intel_inherited_from":{"description":"Domain from which `inherited_content_categories` and `inherited_risk_types` are inherited, if applicable.","type":"string","x-auditable":true},"intel_inherited_risk_types":{"$ref":"#/components/schemas/intel_categories_with_super_category_ids_example_empty"},"intel_ip":{"anyOf":[{"$ref":"#/components/schemas/intel_ipv4"},{"$ref":"#/components/schemas/intel_ipv6"}],"type":"string","x-auditable":true},"intel_ip-list":{"properties":{"description":{"type":"string","x-auditable":true},"id":{"type":"integer","x-auditable":true},"name":{"example":"Malware","type":"string","x-auditable":true}},"type":"object"},"intel_ipv4":{"example":"192.0.2.0","format":"ipv4","type":"string","x-auditable":true},"intel_ipv6":{"example":"2001:0DB8::","format":"ipv6","type":"string","x-auditable":true},"intel_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"intel_miscategorization":{"properties":{"content_adds":{"description":"Content category IDs to add.","example":[82],"items":{"type":"integer","x-auditable":true},"type":"array"},"content_removes":{"description":"Content category IDs to remove.","example":[155],"items":{"type":"integer","x-auditable":true},"type":"array"},"indicator_type":{"enum":["domain","ipv4","ipv6","url"],"example":"domain","type":"string","x-auditable":true},"ip":{"description":"Provide only if indicator_type is `ipv4` or `ipv6`.","nullable":true,"type":"string","x-auditable":true},"security_adds":{"description":"Security category IDs to add.","example":[117,131],"items":{"type":"integer","x-auditable":true},"type":"array"},"security_removes":{"description":"Security category IDs to remove.","example":[83],"items":{"type":"integer","x-auditable":true},"type":"array"},"url":{"description":"Provide only if indicator_type is `domain` or `url`. Example if indicator_type is `domain`: `example.com`. Example if indicator_type is `url`: `https://example.com/news/`.","type":"string","x-auditable":true}},"type":"object"},"intel_page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"intel_passive-dns-by-ip":{"properties":{"count":{"description":"Total results returned based on your search parameters.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"reverse_records":{"description":"Reverse DNS look-ups observed during the time period.","items":{"properties":{"first_seen":{"description":"First seen date of the DNS record during the time period.","example":"2021-04-01","format":"date","type":"string","x-auditable":true},"hostname":{"description":"Hostname that the IP was observed resolving to.","type":"string","x-auditable":true},"last_seen":{"description":"Last seen date of the DNS record during the time period.","example":"2021-04-30","format":"date","type":"string","x-auditable":true}},"type":"object"},"type":"array"}},"type":"object"},"intel_per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"intel_phishing-url-info":{"properties":{"categorizations":{"description":"List of categorizations applied to this submission.","items":{"properties":{"category":{"description":"Name of the category applied.","example":"PHISHING","type":"string","x-auditable":true},"verification_status":{"description":"Result of human review for this categorization.","example":"confirmed","type":"string","x-auditable":true}},"type":"object"},"type":"array"},"model_results":{"description":"List of model results for completed scans.","items":{"properties":{"model_name":{"description":"Name of the model.","example":"MACHINE_LEARNING_v2","type":"string","x-auditable":true},"model_score":{"description":"This is the score that is outputted by the model for this submission.","example":0.024,"type":"number"}},"type":"object"},"type":"array"},"rule_matches":{"description":"List of signatures that matched against site content found when crawling the URL.","items":{"properties":{"banning":{"description":"For internal use.","type":"boolean"},"blocking":{"description":"For internal use.","type":"boolean"},"description":{"description":"Description of the signature that matched.","example":"Match frequently used social followers phishing kit","type":"string","x-auditable":true},"name":{"description":"Name of the signature that matched.","example":"phishkit.social_followers","type":"string","x-auditable":true}},"type":"object"},"type":"array"},"scan_status":{"description":"Status of the most recent scan found.","properties":{"last_processed":{"description":"Timestamp of when the submission was processed.","example":"Wed, 26 Oct 2022 16:04:51 GMT","type":"string","x-auditable":true},"scan_complete":{"description":"For internal use.","type":"boolean"},"status_code":{"description":"Status code that the crawler received when loading the submitted URL.","type":"integer","x-auditable":true},"submission_id":{"description":"ID of the most recent submission.","type":"integer","x-auditable":true}},"type":"object"},"screenshot_download_signature":{"description":"For internal use.","type":"string"},"screenshot_path":{"description":"For internal use.","type":"string"},"url":{"description":"URL that was submitted.","example":"https://www.cloudflare.com","type":"string","x-auditable":true}},"type":"object"},"intel_phishing-url-info_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/intel_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/intel_phishing-url-info"}},"type":"object"}],"type":"object"},"intel_phishing-url-submit":{"properties":{"excluded_urls":{"description":"URLs that were excluded from scanning because their domain is in our no-scan list.","items":{"properties":{"url":{"description":"URL that was excluded.","example":"https://developers.cloudflare.com","type":"string","x-auditable":true}},"type":"object"},"type":"array"},"skipped_urls":{"description":"URLs that were skipped because the same URL is currently being scanned.","items":{"properties":{"url":{"description":"URL that was skipped.","example":"https://www.cloudflare.com/developer-week/","type":"string","x-auditable":true},"url_id":{"description":"ID of the submission of that URL that is currently scanning.","example":2,"type":"integer","x-auditable":true}},"type":"object"},"type":"array"},"submitted_urls":{"description":"URLs that were successfully submitted for scanning.","items":{"properties":{"url":{"description":"URL that was submitted.","example":"https://www.cloudflare.com","type":"string","x-auditable":true},"url_id":{"description":"ID assigned to this URL submission. Used to retrieve scanning results.","example":1,"type":"integer","x-auditable":true}},"type":"object"},"type":"array"}},"type":"object"},"intel_phishing-url-submit_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/intel_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/intel_phishing-url-submit"}},"type":"object"}],"type":"object"},"intel_popularity_rank":{"description":"Global Cloudflare 100k ranking for the last 30 days, if available for the hostname. The top ranked domain is 1, the lowest ranked domain is 100,000.","type":"integer","x-auditable":true},"intel_resolves_to_ref":{"properties":{"id":{"$ref":"#/components/schemas/intel_stix_identifier"},"value":{"description":"IP address or domain name.","example":"192.0.2.0","type":"string","x-auditable":true}},"type":"object"},"intel_resolves_to_refs":{"description":"Specifies a list of references to one or more IP addresses or domain names that the domain name currently resolves to.","items":{"$ref":"#/components/schemas/intel_resolves_to_ref"},"type":"array"},"intel_response":{"allOf":[{"$ref":"#/components/schemas/intel_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/intel_domain-history"},"type":"array"}},"type":"object"}],"type":"object"},"intel_result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"},"intel_risk_score":{"description":"Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest risk).","type":"number"},"intel_risk_types":{"$ref":"#/components/schemas/intel_categories_with_super_category_ids_example_empty"},"intel_schemas-api-response-collection":{"allOf":[{"$ref":"#/components/schemas/intel_schemas-api-response-common"},{"properties":{"result_info":{"$ref":"#/components/schemas/intel_schemas-result_info"}},"type":"object"}],"type":"object"},"intel_schemas-api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/intel_schemas-messages"},"messages":{"$ref":"#/components/schemas/intel_schemas-messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"intel_schemas-asn":{"properties":{"asn":{"$ref":"#/components/schemas/intel_asn"},"country":{"$ref":"#/components/schemas/intel_asn_country"},"description":{"$ref":"#/components/schemas/intel_asn_description"},"domain_count":{"type":"integer","x-auditable":true},"top_domains":{"example":["example.com"],"items":{"type":"string","x-auditable":true},"type":"array"},"type":{"$ref":"#/components/schemas/intel_asn_type"}},"type":"object"},"intel_schemas-ip":{"properties":{"belongs_to_ref":{"description":"Specifies a reference to the autonomous systems (AS) that the IP address belongs to.","properties":{"country":{"example":"US","type":"string","x-auditable":true},"description":{"example":"CLOUDFLARENET","type":"string","x-auditable":true},"id":{"example":"autonomous-system--2fa28d71-3549-5a38-af05-770b79ad6ea8","type":"string","x-auditable":true},"type":{"description":"Infrastructure type of this ASN.","enum":["hosting_provider","isp","organization"],"example":"hosting_provider","type":"string","x-auditable":true},"value":{"type":"string","x-auditable":true}},"type":"object"},"ip":{"$ref":"#/components/schemas/intel_ip"},"risk_types":{"example":[{"id":131,"name":"Phishing","super_category_id":21}],"items":{"properties":{"id":{"type":"number"},"name":{"type":"string","x-auditable":true},"super_category_id":{"type":"number"}},"type":"object"},"type":"array"}},"type":"object"},"intel_schemas-messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"intel_schemas-response":{"allOf":[{"$ref":"#/components/schemas/intel_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/intel_schemas-ip"},"type":"array"}},"type":"object"}],"type":"object"},"intel_schemas-result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"},"intel_schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/intel_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/intel_whois"}},"type":"object"}],"type":"object"},"intel_single_response":{"allOf":[{"$ref":"#/components/schemas/intel_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/intel_domain"}},"type":"object"}],"type":"object"},"intel_start_end_params":{"properties":{"end":{"description":"Defaults to the current date.","example":"2021-04-30","format":"date","type":"string","x-auditable":true},"start":{"description":"Defaults to 30 days before the end parameter value.","example":"2021-04-01","format":"date","type":"string","x-auditable":true}},"type":"object"},"intel_stix_identifier":{"description":"STIX 2.1 identifier: https://docs.oasis-open.org/cti/stix/v2.1/cs02/stix-v2.1-cs02.html#_64yvzeku5a5c.","example":"ipv4-addr--baa568ec-6efe-5902-be55-0663833db537","type":"string","x-auditable":true},"intel_url":{"description":"URL(s) to filter submissions results by.","example":"https://www.cloudflare.com","format":"uri","type":"string","x-auditable":true},"intel_url_param":{"properties":{"url":{"$ref":"#/components/schemas/intel_url"}},"type":"object"},"intel_whois":{"properties":{"created_date":{"example":"2009-02-17","format":"date","type":"string","x-auditable":true},"domain":{"$ref":"#/components/schemas/intel_domain_name"},"nameservers":{"example":["ns3.cloudflare.com","ns4.cloudflare.com","ns5.cloudflare.com","ns6.cloudflare.com","ns7.cloudflare.com"],"items":{"type":"string","x-auditable":true},"type":"array"},"registrant":{"example":"DATA REDACTED","type":"string","x-auditable":true},"registrant_country":{"example":"United States","type":"string","x-auditable":true},"registrant_email":{"example":"https://domaincontact.cloudflareregistrar.com/cloudflare.com","type":"string","x-auditable":true},"registrant_org":{"example":"DATA REDACTED","type":"string","x-auditable":true},"registrar":{"example":"Cloudflare, Inc.","type":"string","x-auditable":true},"updated_date":{"example":"2017-05-24","format":"date","type":"string","x-auditable":true}},"type":"object"},"lists_account_id":{"description":"The Account ID for this resource.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"minLength":32,"readOnly":true,"type":"string","x-auditable":true},"lists_api-response-collection":{"allOf":[{"properties":{"result":{"items":{"type":"object"},"nullable":true,"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/lists_api-response-common"}],"type":"object"},"lists_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/lists_messages"},"messages":{"$ref":"#/components/schemas/lists_messages"},"result":{"anyOf":[{"type":"object"},{"items":{"type":"object"},"type":"array"}]},"success":{"description":"Defines whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"lists_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/lists_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/lists_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Defines whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"lists_bulk-operation-response-single":{"allOf":[{"properties":{"result":{"$ref":"#/components/schemas/lists_operation"}},"type":"object"},{"$ref":"#/components/schemas/lists_api-response-common"}]},"lists_bulk_operation_completed":{"properties":{"completed":{"$ref":"#/components/schemas/lists_completed"},"id":{"$ref":"#/components/schemas/lists_operation_id"},"status":{"description":"The current status of the asynchronous operation.","enum":["completed"],"example":"completed","readOnly":true,"type":"string","x-auditable":true}},"required":["id","status","completed"],"type":"object"},"lists_bulk_operation_failed":{"properties":{"completed":{"$ref":"#/components/schemas/lists_completed"},"error":{"description":"A message describing the error when the status is `failed`.","example":"This list is at the maximum number of items","readOnly":true,"type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/lists_operation_id"},"status":{"description":"The current status of the asynchronous operation.","enum":["failed"],"example":"failed","readOnly":true,"type":"string","x-auditable":true}},"required":["id","status","error","completed"],"type":"object"},"lists_bulk_operation_pending_or_running":{"properties":{"id":{"$ref":"#/components/schemas/lists_operation_id"},"status":{"description":"The current status of the asynchronous operation.","enum":["pending","running"],"example":"pending","readOnly":true,"type":"string","x-auditable":true}},"required":["id","status"],"type":"object"},"lists_completed":{"description":"The RFC 3339 timestamp of when the operation was completed.","example":"2020-01-01T08:00:00Z","readOnly":true,"type":"string","x-auditable":true},"lists_created_on":{"description":"The RFC 3339 timestamp of when the list was created.","example":"2020-01-01T08:00:00Z","readOnly":true,"type":"string","x-auditable":true},"lists_description":{"description":"An informative summary of the list.","example":"This is a note","maxLength":500,"type":"string","x-auditable":true},"lists_item":{"oneOf":[{"$ref":"#/components/schemas/lists_list_item_ip_full"},{"$ref":"#/components/schemas/lists_list_item_hostname_full"},{"$ref":"#/components/schemas/lists_list_item_redirect_full"},{"$ref":"#/components/schemas/lists_list_item_asn_full"}]},"lists_item-response-single":{"allOf":[{"properties":{"result":{"$ref":"#/components/schemas/lists_item"}},"type":"object"},{"$ref":"#/components/schemas/lists_api-response-common"}]},"lists_item_asn":{"description":"Defines a non-negative 32 bit integer.","example":5567,"type":"integer","x-auditable":true},"lists_item_base":{"example":{"comment":"Private IP address","created_on":"2020-01-01T08:00:00Z","id":"2c0fc9fa937b11eaa1b71c4d701ab86e","modified_on":"2020-01-10T14:00:00Z"},"properties":{"comment":{"$ref":"#/components/schemas/lists_item_comment"},"created_on":{"$ref":"#/components/schemas/lists_created_on"},"id":{"$ref":"#/components/schemas/lists_item_id"},"modified_on":{"$ref":"#/components/schemas/lists_modified_on"}},"required":["id","created_on","modified_on"],"type":"object"},"lists_item_comment":{"description":"Defines an informative summary of the list item.","example":"Private IP address","type":"string","x-auditable":true},"lists_item_comment_object":{"properties":{"comment":{"$ref":"#/components/schemas/lists_item_comment"}},"type":"object"},"lists_item_hostname":{"description":"Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).","properties":{"exclude_exact_hostname":{"description":"Only applies to wildcard hostnames (e.g., *.example.com). When true (default), only subdomains are blocked. When false, both the root domain and subdomains are blocked.","example":true,"type":"boolean"},"url_hostname":{"example":"example.com","type":"string","x-auditable":true}},"required":["url_hostname"]},"lists_item_id":{"description":"Defines the unique ID of the item in the List.","example":"34b12448945f11eaa1b71c4d701ab86e","maxLength":32,"minLength":32,"readOnly":true,"type":"string","x-auditable":true},"lists_item_ip":{"description":"An IPv4 address, an IPv4 CIDR, an IPv6 address, or an IPv6 CIDR.","example":"10.0.0.1","type":"string","x-auditable":true},"lists_item_redirect":{"description":"The definition of the redirect.","properties":{"include_subdomains":{"default":false,"type":"boolean","x-auditable":true},"preserve_path_suffix":{"default":false,"type":"boolean","x-auditable":true},"preserve_query_string":{"default":false,"type":"boolean","x-auditable":true},"source_url":{"example":"example.com/arch","type":"string","x-auditable":true},"status_code":{"default":301,"enum":[301,302,307,308],"type":"integer","x-auditable":true},"subpath_matching":{"default":false,"type":"boolean","x-auditable":true},"target_url":{"example":"https://archlinux.org/","type":"string","x-auditable":true}},"required":["source_url","target_url"]},"lists_items":{"items":{"$ref":"#/components/schemas/lists_item"},"type":"array"},"lists_items-list-response-collection":{"allOf":[{"properties":{"result":{"$ref":"#/components/schemas/lists_items"},"result_info":{"properties":{"cursors":{"properties":{"after":{"example":"yyy","type":"string","x-auditable":true},"before":{"example":"xxx","type":"string","x-auditable":true}},"type":"object"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/lists_api-response-collection"}]},"lists_items-update-request-collection":{"items":{"oneOf":[{"$ref":"#/components/schemas/lists_list_item_ip_comment"},{"$ref":"#/components/schemas/lists_list_item_redirect_comment"},{"$ref":"#/components/schemas/lists_list_item_hostname_comment"},{"$ref":"#/components/schemas/lists_list_item_asn_comment"}]},"type":"array"},"lists_kind":{"description":"The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).","enum":["ip","redirect","hostname","asn"],"example":"ip"},"lists_list":{"properties":{"created_on":{"$ref":"#/components/schemas/lists_created_on"},"description":{"$ref":"#/components/schemas/lists_description"},"id":{"$ref":"#/components/schemas/lists_list_id"},"kind":{"$ref":"#/components/schemas/lists_kind"},"modified_on":{"$ref":"#/components/schemas/lists_modified_on"},"name":{"$ref":"#/components/schemas/lists_name"},"num_items":{"$ref":"#/components/schemas/lists_num_items"},"num_referencing_filters":{"$ref":"#/components/schemas/lists_num_referencing_filters"}},"required":["id","name","kind","num_items","num_referencing_filters","created_on","modified_on"],"type":"object"},"lists_list-delete-response-collection":{"allOf":[{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/lists_list_id"}},"required":["id"],"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/lists_api-response-common"}],"type":"object"},"lists_list-response-collection":{"allOf":[{"properties":{"result":{"$ref":"#/components/schemas/lists_list"}},"type":"object"},{"$ref":"#/components/schemas/lists_api-response-common"}],"type":"object"},"lists_list_id":{"description":"The unique ID of the list.","example":"2c0fc9fa937b11eaa1b71c4d701ab86e","maxLength":32,"minLength":32,"readOnly":true,"type":"string","x-auditable":true},"lists_list_item_asn_comment":{"allOf":[{"$ref":"#/components/schemas/lists_list_item_asn_object"},{"$ref":"#/components/schemas/lists_item_comment_object"}]},"lists_list_item_asn_full":{"allOf":[{"$ref":"#/components/schemas/lists_list_item_asn_object"},{"$ref":"#/components/schemas/lists_item_base"}]},"lists_list_item_asn_object":{"properties":{"asn":{"$ref":"#/components/schemas/lists_item_asn"}},"required":["asn"],"type":"object"},"lists_list_item_hostname_comment":{"allOf":[{"$ref":"#/components/schemas/lists_list_item_hostname_object"},{"$ref":"#/components/schemas/lists_item_comment_object"}]},"lists_list_item_hostname_full":{"allOf":[{"$ref":"#/components/schemas/lists_list_item_hostname_object"},{"$ref":"#/components/schemas/lists_item_base"}]},"lists_list_item_hostname_object":{"properties":{"hostname":{"$ref":"#/components/schemas/lists_item_hostname"}},"required":["hostname"],"type":"object"},"lists_list_item_ip_comment":{"allOf":[{"$ref":"#/components/schemas/lists_list_item_ip_object"},{"$ref":"#/components/schemas/lists_item_comment_object"}]},"lists_list_item_ip_full":{"allOf":[{"$ref":"#/components/schemas/lists_list_item_ip_object"},{"$ref":"#/components/schemas/lists_item_base"}]},"lists_list_item_ip_object":{"properties":{"ip":{"$ref":"#/components/schemas/lists_item_ip"}},"required":["ip"],"type":"object"},"lists_list_item_redirect_comment":{"allOf":[{"$ref":"#/components/schemas/lists_list_item_redirect_object"},{"$ref":"#/components/schemas/lists_item_comment_object"}]},"lists_list_item_redirect_full":{"allOf":[{"$ref":"#/components/schemas/lists_list_item_redirect_object"},{"$ref":"#/components/schemas/lists_item_base"}]},"lists_list_item_redirect_object":{"properties":{"redirect":{"$ref":"#/components/schemas/lists_item_redirect"}},"required":["redirect"],"type":"object"},"lists_lists-async-response":{"allOf":[{"properties":{"result":{"properties":{"operation_id":{"$ref":"#/components/schemas/lists_operation_id"}},"required":["operation_id"],"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/lists_api-response-collection"}]},"lists_lists-response-collection":{"allOf":[{"properties":{"result":{"items":{"$ref":"#/components/schemas/lists_list"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/lists_api-response-collection"}],"type":"object"},"lists_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"lists_modified_on":{"description":"The RFC 3339 timestamp of when the list was last modified.","example":"2020-01-10T14:00:00Z","readOnly":true,"type":"string","x-auditable":true},"lists_name":{"description":"An informative name for the list. Use this name in filter and rule expressions.","example":"list1","maxLength":50,"pattern":"^[a-zA-Z0-9_]+$","type":"string","x-auditable":true},"lists_num_items":{"description":"The number of items in the list.","example":10,"readOnly":true,"type":"number","x-auditable":true},"lists_num_referencing_filters":{"description":"The number of [filters](/api/resources/filters/) referencing the list.","example":2,"readOnly":true,"type":"number","x-auditable":true},"lists_operation":{"oneOf":[{"$ref":"#/components/schemas/lists_bulk_operation_pending_or_running"},{"$ref":"#/components/schemas/lists_bulk_operation_completed"},{"$ref":"#/components/schemas/lists_bulk_operation_failed"}]},"lists_operation_id":{"description":"The unique operation ID of the asynchronous action.","example":"4da8780eeb215e6cb7f48dd981c4ea02","readOnly":true,"type":"string","x-auditable":true},"load-balancing_Host":{"description":"The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.","items":{"example":"example.com","type":"string","x-auditable":true},"type":"array"},"load-balancing_adaptive_routing":{"description":"Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.","properties":{"failover_across_pools":{"default":false,"description":"Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.","example":true,"type":"boolean","x-auditable":true}},"type":"object"},"load-balancing_address":{"description":"The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.","example":"0.0.0.0","type":"string","x-auditable":true},"load-balancing_allow_insecure":{"default":false,"description":"Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.","example":true,"type":"boolean","x-auditable":true},"load-balancing_analytics":{"properties":{"id":{"default":1,"type":"integer"},"origins":{"example":[{"address":"198.51.100.4","changed":true,"enabled":true,"failure_reason":"No failures","healthy":true,"ip":"198.51.100.4","name":"some-origin"}],"items":{"$ref":"#/components/schemas/load-balancing_origin-analytics"},"type":"array"},"pool":{"example":{"changed":true,"healthy":true,"id":"74bc6a8b9b0dda3d651707a2928bad0c","minimum_origins":1,"name":"some-pool"},"type":"object"},"timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string"}},"type":"object"},"load-balancing_api-paginated-response-collection":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-common"},{"properties":{"result_info":{"$ref":"#/components/schemas/load-balancing_result_info"}},"type":"object"}],"required":["result_info"],"type":"object"},"load-balancing_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/load-balancing_messages"},"messages":{"$ref":"#/components/schemas/load-balancing_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"load-balancing_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/load-balancing_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/load-balancing_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"load-balancing_api-response-single":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-common"},{"properties":{"result":{"anyOf":[{"nullable":true,"type":"object"},{"nullable":true,"type":"string"}]}},"type":"object"}],"type":"object"},"load-balancing_check_regions":{"description":"A list of regions from which to run health checks. Null means every Cloudflare data center.","example":["WEU","ENAM"],"items":{"description":"WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (ENTERPRISE customers only).","enum":["WNAM","ENAM","WEU","EEU","NSAM","SSAM","OC","ME","NAF","SAF","SAS","SEAS","NEAS","ALL_REGIONS"],"type":"string","x-auditable":true},"nullable":true,"type":"array"},"load-balancing_components-schemas-description":{"description":"Object description.","example":"Load Balancer for www.example.com","type":"string","x-auditable":true},"load-balancing_components-schemas-enabled":{"default":true,"description":"Whether to enable (the default) this load balancer.","example":true,"type":"boolean","x-auditable":true},"load-balancing_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-identifier"}},"type":"object"}},"type":"object"}]},"load-balancing_components-schemas-identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"load-balancing_components-schemas-name":{"description":"The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.","example":"www.example.com","type":"string","x-auditable":true},"load-balancing_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-paginated-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/load-balancing_analytics"},"type":"array"}},"type":"object"}]},"load-balancing_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-single"},{"properties":{"result":{"description":"A list of countries and subdivisions mapped to a region.","example":{"iso_standard":"Country and subdivision codes follow ISO 3166-1 alpha-2 and ISO 3166-2","regions":[{"countries":[{"country_code_a2":"CA","country_name":"Canada","country_subdivisions":[{"subdivision_code_a2":"AB","subdivision_name":"Alberta"},{"subdivision_code_a2":"BC","subdivision_name":"British Columbia"}]},{"country_code_a2":"HT","country_name":"Haiti"},{"country_code_a2":"MX","country_name":"Mexico"},{"country_code_a2":"US","country_name":"United States","country_subdivisions":[{"subdivision_code_a2":"AZ","subdivision_name":"Arizona"},{"subdivision_code_a2":"CA","subdivision_name":"California"},{"subdivision_code_a2":"CO","subdivision_name":"Colorado"},{"subdivision_code_a2":"HI","subdivision_name":"Hawaii"},{"subdivision_code_a2":"MN","subdivision_name":"Minnesota"},{"subdivision_code_a2":"MO","subdivision_name":"Missouri"},{"subdivision_code_a2":"NV","subdivision_name":"Nevada"},{"subdivision_code_a2":"OR","subdivision_name":"Oregon"},{"subdivision_code_a2":"TX","subdivision_name":"Texas"},{"subdivision_code_a2":"UT","subdivision_name":"Utah"},{"subdivision_code_a2":"WA","subdivision_name":"Washington"}]}],"region_code":"WNAM"}]},"type":"object"}},"type":"object"}]},"load-balancing_components-schemas-zone-name":{"example":"example.com","type":"string","x-auditable":true},"load-balancing_consecutive_down":{"description":"To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.","type":"integer","x-auditable":true},"load-balancing_consecutive_up":{"description":"To be marked healthy the monitored origin must pass this healthcheck N consecutive times.","type":"integer","x-auditable":true},"load-balancing_country_pools":{"additionalProperties":{"description":"A `string:[string]` object of key-values. Country code maps to list of pool IDs.","items":{"type":"string","x-auditable":true},"type":"array"},"description":"A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.","example":{"GB":["abd90f38ced07c2e2f4df50b1f61d4194"],"US":["de90f38ced07c2e2f4df50b1f61d4194","00920f38ce07c2e2f4df50b1f61d4194"]},"type":"object"},"load-balancing_default_pools":{"description":"A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.","example":["17b5962d775c646f3f9725cbc7a53df4","9290f38c5d07c2e2f4df57b1f61d4196","00920f38ce07c2e2f4df50b1f61d4194"],"items":{"description":"A pool ID.","type":"string"},"type":"array"},"load-balancing_description":{"default":"","description":"Object description.","example":"Login page monitor","type":"string","x-auditable":true},"load-balancing_disabled_at":{"description":"This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"load-balancing_enabled":{"default":true,"description":"Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).","example":false,"type":"boolean","x-auditable":true},"load-balancing_expected_body":{"default":"","description":"A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.","example":"alive","type":"string","x-auditable":true},"load-balancing_expected_codes":{"default":"","description":"The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.","example":"2xx","type":"string","x-auditable":true},"load-balancing_fallback_pool":{"description":"The pool ID to use when all other pools are detected as unhealthy.","type":"string","x-auditable":true},"load-balancing_filter_options":{"description":"Filter options for a particular resource type (pool or origin). Use null to reset.","nullable":true,"properties":{"disable":{"default":false,"description":"If set true, disable notifications for this type of resource (pool or origin).","type":"boolean","x-auditable":true},"healthy":{"description":"If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).","nullable":true,"type":"boolean","x-auditable":true}},"type":"object"},"load-balancing_follow_redirects":{"default":false,"description":"Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.","example":true,"type":"boolean","x-auditable":true},"load-balancing_header":{"additionalProperties":{"items":{"type":"string","x-auditable":true},"type":"array"},"description":"The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.","example":{"Host":["example.com"],"X-App-ID":["abc123"]},"type":"object"},"load-balancing_health_details":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-single"},{"properties":{"result":{"description":"A list of regions from which to run health checks. Null means every Cloudflare data center.","example":{"pool_id":"17b5962d775c646f3f9725cbc7a53df4","pop_health":{"Amsterdam, NL":{"healthy":true,"origins":[{"2001:DB8::5":{"failure_reason":"No failures","healthy":true,"response_code":401,"rtt":"12.1ms"}}]}}},"properties":{"pool_id":{"description":"Pool ID.","example":"17b5962d775c646f3f9725cbc7a53df4","type":"string","x-auditable":true},"pop_health":{"description":"List of regions and associated health status.","properties":{"healthy":{"description":"Whether health check in region is healthy.","example":true,"type":"boolean","x-auditable":true},"origins":{"items":{"$ref":"#/components/schemas/load-balancing_origin-health"},"type":"array"}},"type":"object"}},"type":"object"}},"type":"object"}]},"load-balancing_id_response":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/load-balancing_identifier"}},"type":"object"}},"type":"object"}]},"load-balancing_identifier":{"example":"f1aba936b94213e5b8dca0c0dbf1f9cc","type":"string","x-auditable":true},"load-balancing_interval":{"default":60,"description":"The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.","type":"integer","x-auditable":true},"load-balancing_latitude":{"description":"The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.","type":"number","x-auditable":true},"load-balancing_load-balancer":{"properties":{"adaptive_routing":{"$ref":"#/components/schemas/load-balancing_adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/load-balancing_country_pools"},"created_on":{"$ref":"#/components/schemas/load-balancing_timestamp"},"default_pools":{"$ref":"#/components/schemas/load-balancing_default_pools"},"description":{"$ref":"#/components/schemas/load-balancing_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/load-balancing_components-schemas-enabled"},"fallback_pool":{"$ref":"#/components/schemas/load-balancing_fallback_pool"},"id":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-identifier"},"location_strategy":{"$ref":"#/components/schemas/load-balancing_location_strategy"},"modified_on":{"$ref":"#/components/schemas/load-balancing_timestamp"},"name":{"$ref":"#/components/schemas/load-balancing_components-schemas-name"},"networks":{"$ref":"#/components/schemas/load-balancing_networks"},"pop_pools":{"$ref":"#/components/schemas/load-balancing_pop_pools"},"proxied":{"$ref":"#/components/schemas/load-balancing_proxied"},"random_steering":{"$ref":"#/components/schemas/load-balancing_random_steering"},"region_pools":{"$ref":"#/components/schemas/load-balancing_region_pools"},"rules":{"$ref":"#/components/schemas/load-balancing_rules"},"session_affinity":{"$ref":"#/components/schemas/load-balancing_session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/load-balancing_session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/load-balancing_session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/load-balancing_steering_policy"},"ttl":{"$ref":"#/components/schemas/load-balancing_ttl"},"zone_name":{"$ref":"#/components/schemas/load-balancing_components-schemas-zone-name"}},"type":"object"},"load-balancing_load-balancer_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252","type":"string","x-auditable":true},"load-balancing_load-balancer_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-paginated-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/load-balancing_load-balancer"},"type":"array"}},"type":"object"}]},"load-balancing_load-balancer_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/load-balancing_load-balancer"}},"type":"object"}]},"load-balancing_load_shedding":{"description":"Configures load shedding policies and percentages for the pool.","properties":{"default_percent":{"default":0,"description":"The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.","maximum":100,"minimum":0,"type":"number","x-auditable":true},"default_policy":{"default":"random","description":"The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.","enum":["random","hash"],"type":"string","x-auditable":true},"session_percent":{"default":0,"description":"The percent of existing sessions to shed from the pool, according to the session policy.","maximum":100,"minimum":0,"type":"number","x-auditable":true},"session_policy":{"default":"hash","description":"Only the hash policy is supported for existing sessions (to avoid exponential decay).","enum":["hash"],"type":"string","x-auditable":true}},"type":"object"},"load-balancing_location_strategy":{"description":"Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected.","properties":{"mode":{"default":"pop","description":"Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.\n- `\"pop\"`: Use the Cloudflare PoP location.\n- `\"resolver_ip\"`: Use the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.","enum":["pop","resolver_ip"],"example":"resolver_ip","type":"string","x-auditable":true},"prefer_ecs":{"default":"proximity","description":"Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.\n- `\"always\"`: Always prefer ECS.\n- `\"never\"`: Never prefer ECS.\n- `\"proximity\"`: Prefer ECS only when `steering_policy=\"proximity\"`.\n- `\"geo\"`: Prefer ECS only when `steering_policy=\"geo\"`.","enum":["always","never","proximity","geo"],"example":"always","type":"string","x-auditable":true}},"type":"object"},"load-balancing_longitude":{"description":"The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.","type":"number","x-auditable":true},"load-balancing_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"load-balancing_method":{"description":"The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.","example":"GET","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"load-balancing_minimum_origins":{"default":1,"description":"The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.","type":"integer","x-auditable":true},"load-balancing_monitor":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-editable"},{"properties":{"created_on":{"$ref":"#/components/schemas/load-balancing_timestamp"},"id":{"$ref":"#/components/schemas/load-balancing_identifier"},"modified_on":{"$ref":"#/components/schemas/load-balancing_timestamp"}},"type":"object"}]},"load-balancing_monitor-editable":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/load-balancing_allow_insecure"},"consecutive_down":{"$ref":"#/components/schemas/load-balancing_consecutive_down"},"consecutive_up":{"$ref":"#/components/schemas/load-balancing_consecutive_up"},"description":{"$ref":"#/components/schemas/load-balancing_description"},"expected_body":{"$ref":"#/components/schemas/load-balancing_expected_body"},"expected_codes":{"$ref":"#/components/schemas/load-balancing_expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/load-balancing_follow_redirects"},"header":{"$ref":"#/components/schemas/load-balancing_header"},"interval":{"$ref":"#/components/schemas/load-balancing_interval"},"method":{"$ref":"#/components/schemas/load-balancing_method"},"path":{"$ref":"#/components/schemas/load-balancing_path"},"port":{"$ref":"#/components/schemas/load-balancing_port"},"probe_zone":{"$ref":"#/components/schemas/load-balancing_probe_zone"},"retries":{"$ref":"#/components/schemas/load-balancing_retries"},"timeout":{"$ref":"#/components/schemas/load-balancing_timeout"},"type":{"$ref":"#/components/schemas/load-balancing_type"}},"type":"object"},"load-balancing_monitor-group":{"properties":{"created_at":{"description":"The timestamp of when the monitor group was created","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"description":{"description":"A short description of the monitor group","example":"Primary datacenter monitors","type":"string"},"id":{"$ref":"#/components/schemas/load-balancing_monitor_group_id"},"members":{"description":"List of monitors in this group","items":{"$ref":"#/components/schemas/load-balancing_monitor-group-member"},"type":"array"},"updated_at":{"description":"The timestamp of when the monitor group was last updated","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"}},"required":["id","description","members"],"type":"object"},"load-balancing_monitor-group-member":{"properties":{"created_at":{"description":"The timestamp of when the monitor was added to the group","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"enabled":{"description":"Whether this monitor is enabled in the group","example":true,"type":"boolean"},"monitor_id":{"$ref":"#/components/schemas/load-balancing_monitor_id"},"monitoring_only":{"description":"Whether this monitor is used for monitoring only (does not affect pool health)","example":false,"type":"boolean"},"must_be_healthy":{"description":"Whether this monitor must be healthy for the pool to be considered healthy","example":true,"type":"boolean"},"updated_at":{"description":"The timestamp of when the monitor group member was last updated","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"}},"required":["monitor_id","enabled","monitoring_only","must_be_healthy"],"type":"object"},"load-balancing_monitor-group-references-response":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-common"},{"properties":{"result":{"description":"List of resources that reference a given monitor group.","example":[{"reference_type":"referrer","resource_id":"17b5962d775c646f3f9725cbc7a53df4","resource_name":"primary-dc-1","resource_type":"pool"}],"items":{"properties":{"reference_type":{"enum":["*","referral","referrer"],"type":"string","x-auditable":true},"resource_id":{"type":"string","x-auditable":true},"resource_name":{"type":"string","x-auditable":true},"resource_type":{"type":"string","x-auditable":true}},"type":"object"},"type":"array"}},"type":"object"}]},"load-balancing_monitor-group-response-collection":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/load-balancing_monitor-group"},"type":"array"},"result_info":{"$ref":"#/components/schemas/load-balancing_result_info"}}}]},"load-balancing_monitor-group-single-response":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/load-balancing_monitor-group"}}}]},"load-balancing_monitor-references-response":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-common"},{"properties":{"result":{"description":"List of resources that reference a given monitor.","example":[{"reference_type":"referrer","resource_id":"17b5962d775c646f3f9725cbc7a53df4","resource_name":"primary-dc-1","resource_type":"pool"}],"items":{"properties":{"reference_type":{"enum":["*","referral","referrer"],"type":"string","x-auditable":true},"resource_id":{"type":"string","x-auditable":true},"resource_name":{"type":"string","x-auditable":true},"resource_type":{"type":"string","x-auditable":true}},"type":"object"},"type":"array"}},"type":"object"}]},"load-balancing_monitor-response-collection":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-paginated-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/load-balancing_monitor"},"type":"array"}},"type":"object"}]},"load-balancing_monitor-response-single":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/load-balancing_monitor"}},"type":"object"}]},"load-balancing_monitor_group_id":{"description":"The ID of the Monitor Group to use for checking the health of origins within this pool.","type":"string","x-auditable":true},"load-balancing_monitor_id":{"description":"The ID of the Monitor to use for checking the health of origins within this pool.","type":"string","x-auditable":true},"load-balancing_name":{"description":"A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.","example":"primary-dc-1","type":"string","x-auditable":true},"load-balancing_networks":{"description":"List of networks where Load Balancer or Pool is enabled.","items":{"example":["cloudflare","jdcloud"],"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"type":"array"},"load-balancing_notification_email":{"default":"","description":"This field is now deprecated. It has been moved to Cloudflare's Centralized Notification service https://developers.cloudflare.com/fundamentals/notifications/. The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.","example":"someone@example.com,sometwo@example.com","type":"string","x-auditable":true},"load-balancing_notification_filter":{"description":"Filter pool and origin health notifications by resource type or health status. Use null to reset.","example":{"origin":{"disable":true},"pool":{"healthy":false}},"nullable":true,"properties":{"origin":{"$ref":"#/components/schemas/load-balancing_filter_options"},"pool":{"$ref":"#/components/schemas/load-balancing_filter_options"}},"type":"object"},"load-balancing_origin":{"properties":{"address":{"$ref":"#/components/schemas/load-balancing_address"},"disabled_at":{"$ref":"#/components/schemas/load-balancing_disabled_at"},"enabled":{"$ref":"#/components/schemas/load-balancing_schemas-enabled"},"header":{"$ref":"#/components/schemas/load-balancing_schemas-header"},"name":{"$ref":"#/components/schemas/load-balancing_schemas-name"},"port":{"$ref":"#/components/schemas/load-balancing_origin_port"},"virtual_network_id":{"$ref":"#/components/schemas/load-balancing_virtual_network_id"},"weight":{"$ref":"#/components/schemas/load-balancing_weight"}},"type":"object"},"load-balancing_origin-analytics":{"properties":{"address":{"$ref":"#/components/schemas/load-balancing_address"},"changed":{"$ref":"#/components/schemas/load-balancing_origin-changed"},"enabled":{"$ref":"#/components/schemas/load-balancing_schemas-enabled"},"failure_reason":{"$ref":"#/components/schemas/load-balancing_origin-failure-reason"},"healthy":{"$ref":"#/components/schemas/load-balancing_origin-healthy"},"ip":{"$ref":"#/components/schemas/load-balancing_origin-ip"},"name":{"$ref":"#/components/schemas/load-balancing_schemas-name"}},"type":"object"},"load-balancing_origin-changed":{"description":"Whether the origin has changed health status.","example":true,"type":"boolean","x-auditable":true},"load-balancing_origin-failure-reason":{"description":"Failure reason for un-healthy origin health check.","example":"No failures","type":"string","x-auditable":true},"load-balancing_origin-health":{"properties":{"ip":{"properties":{"failure_reason":{"description":"Failure reason.","example":"No failure reasons","type":"string","x-auditable":true},"healthy":{"description":"Origin health status.","example":true,"type":"boolean","x-auditable":true},"response_code":{"description":"Response code from origin health check.","example":200,"type":"number","x-auditable":true},"rtt":{"description":"Origin RTT (Round Trip Time) response.","example":"201.5ms","type":"string","x-auditable":true}},"type":"object"}},"type":"object"},"load-balancing_origin-healthy":{"description":"Whether the origin is reported as healthy.","example":true,"type":"boolean","x-auditable":true},"load-balancing_origin-ip":{"description":"The IP address (IPv4 or IPv6) of the origin.","example":"198.51.100.4","type":"string","x-auditable":true},"load-balancing_origin_health_data":{"description":"The origin ipv4/ipv6 address or domain name mapped to its health data.","example":{"failure_reason":"No failures","healthy":true,"response_code":200,"rtt":"66ms"},"properties":{"failure_reason":{"type":"string","x-auditable":true},"healthy":{"type":"boolean","x-auditable":true},"response_code":{"type":"number","x-auditable":true},"rtt":{"type":"string","x-auditable":true}},"type":"object"},"load-balancing_origin_healthy":{"default":true,"description":"If true, filter events where the origin status is healthy. If false, filter events where the origin status is unhealthy.","example":true,"type":"boolean","x-auditable":true},"load-balancing_origin_port":{"default":0,"description":"The port for upstream connections. A value of 0 means the default port for the protocol will be used.","type":"integer"},"load-balancing_origin_steering":{"description":"Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.","properties":{"policy":{"default":"random","description":"The type of origin steering policy to use.\n- `\"random\"`: Select an origin randomly.\n- `\"hash\"`: Select an origin by computing a hash over the CF-Connecting-IP address.\n- `\"least_outstanding_requests\"`: Select an origin by taking into consideration origin weights, as well as each origin's number of outstanding requests. Origins with more pending requests are weighted proportionately less relative to others.\n- `\"least_connections\"`: Select an origin by taking into consideration origin weights, as well as each origin's number of open connections. Origins with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.","enum":["random","hash","least_outstanding_requests","least_connections"],"type":"string","x-auditable":true}},"type":"object"},"load-balancing_origins":{"description":"The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.","items":{"$ref":"#/components/schemas/load-balancing_origin"},"type":"array"},"load-balancing_patch_pools_notification_email":{"description":"The email address to send health status notifications to. This field is now deprecated in favor of Cloudflare Notifications for Load Balancing, so only resetting this field with an empty string `\"\"` is accepted.","enum":[""],"example":"","type":"string"},"load-balancing_path":{"description":"The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.","example":"/health","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"load-balancing_pool":{"properties":{"check_regions":{"$ref":"#/components/schemas/load-balancing_check_regions"},"created_on":{"$ref":"#/components/schemas/load-balancing_timestamp"},"description":{"$ref":"#/components/schemas/load-balancing_schemas-description"},"disabled_at":{"$ref":"#/components/schemas/load-balancing_schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/load-balancing_enabled"},"id":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"},"latitude":{"$ref":"#/components/schemas/load-balancing_latitude"},"load_shedding":{"$ref":"#/components/schemas/load-balancing_load_shedding"},"longitude":{"$ref":"#/components/schemas/load-balancing_longitude"},"minimum_origins":{"$ref":"#/components/schemas/load-balancing_minimum_origins"},"modified_on":{"$ref":"#/components/schemas/load-balancing_timestamp"},"monitor":{"$ref":"#/components/schemas/load-balancing_monitor_id"},"monitor_group":{"$ref":"#/components/schemas/load-balancing_monitor_group_id"},"name":{"$ref":"#/components/schemas/load-balancing_name"},"networks":{"$ref":"#/components/schemas/load-balancing_networks"},"notification_email":{"$ref":"#/components/schemas/load-balancing_notification_email"},"notification_filter":{"$ref":"#/components/schemas/load-balancing_notification_filter"},"origin_steering":{"$ref":"#/components/schemas/load-balancing_origin_steering"},"origins":{"$ref":"#/components/schemas/load-balancing_origins"}},"type":"object"},"load-balancing_pool_name":{"description":"The name for the pool to filter.","example":"primary-dc","type":"string","x-auditable":true},"load-balancing_pools-references-response":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-common"},{"properties":{"result":{"description":"List of resources that reference a given pool.","example":[{"reference_type":"referrer","resource_id":"699d98642c564d2e855e9661899b7252","resource_name":"www.example.com","resource_type":"load_balancer"},{"reference_type":"referral","resource_id":"f1aba936b94213e5b8dca0c0dbf1f9cc","resource_name":"Login page monitor","resource_type":"monitor"}],"items":{"properties":{"reference_type":{"enum":["*","referral","referrer"],"type":"string","x-auditable":true},"resource_id":{"type":"string","x-auditable":true},"resource_name":{"type":"string","x-auditable":true},"resource_type":{"type":"string","x-auditable":true}},"type":"object"},"type":"array"}},"type":"object"}]},"load-balancing_pop_pools":{"additionalProperties":{"description":"A `string:[string]` object of key-values. PoP code maps to list of pool IDs.","items":{"type":"string","x-auditable":true},"type":"array"},"description":"Enterprise only: A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.","example":{"LAX":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"LHR":["abd90f38ced07c2e2f4df50b1f61d4194","f9138c5d07c2e2f4df57b1f61d4196"],"SJC":["00920f38ce07c2e2f4df50b1f61d4194"]},"type":"object"},"load-balancing_port":{"description":"The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).","type":"integer","x-auditable":true},"load-balancing_preview_id":{"example":"f1aba936b94213e5b8dca0c0dbf1f9cc"},"load-balancing_preview_response":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-single"},{"properties":{"result":{"properties":{"pools":{"additionalProperties":{"description":"The pool name associated with the pool ID.","type":"string","x-auditable":true},"description":"Monitored pool IDs mapped to their respective names.","example":{"abwlnp5jbqn45ecgxd03erbgtxtqai0d":"WNAM Datacenter","ve8h9lrcip5n5bbga9yqmdws28ay5d0l":"EEU Datacenter"},"type":"object"},"preview_id":{"$ref":"#/components/schemas/load-balancing_identifier"}},"type":"object"}},"type":"object"}]},"load-balancing_preview_result":{"additionalProperties":{"properties":{"healthy":{"type":"boolean","x-auditable":true},"origins":{"items":{"additionalProperties":{"$ref":"#/components/schemas/load-balancing_origin_health_data"},"maxProperties":1,"minProperties":1,"type":"object"},"type":"array"}},"type":"object"},"description":"Resulting health data from a preview operation.","example":{"abwlnp5jbqn45ecgxd03erbgtxtqai0d":{"healthy":true,"origins":[{"originone.example.com.":{"failure_reason":"No failures","healthy":true,"response_code":200,"rtt":"66ms"}}]}},"type":"object"},"load-balancing_preview_result_response":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/load-balancing_preview_result"}},"type":"object"}]},"load-balancing_probe_zone":{"default":"","description":"Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.","example":"example.com","type":"string","x-auditable":true},"load-balancing_proxied":{"default":false,"description":"Whether the hostname should be gray clouded (false) or orange clouded (true).","example":true,"type":"boolean","x-auditable":true},"load-balancing_random_steering":{"description":"Configures pool weights.\n- `steering_policy=\"random\"`: A random pool is selected with probability proportional to pool weights.\n- `steering_policy=\"least_outstanding_requests\"`: Use pool weights to scale each pool's outstanding requests.\n- `steering_policy=\"least_connections\"`: Use pool weights to scale each pool's open connections.","properties":{"default_weight":{"default":1,"description":"The default weight for pools in the load balancer that are not specified in the pool_weights map.","example":0.2,"maximum":1,"minimum":0,"multipleOf":0.1,"type":"number","x-auditable":true},"pool_weights":{"additionalProperties":{"type":"number","x-auditable":true},"description":"A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.","example":{"9290f38c5d07c2e2f4df57b1f61d4196":0.5,"de90f38ced07c2e2f4df50b1f61d4194":0.3},"type":"object"}},"type":"object"},"load-balancing_region_code":{"description":"A list of Cloudflare regions. WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia).","enum":["WNAM","ENAM","WEU","EEU","NSAM","SSAM","OC","ME","NAF","SAF","SAS","SEAS","NEAS"],"example":"WNAM","type":"string"},"load-balancing_region_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"load-balancing_region_pools":{"additionalProperties":{"description":"A `string:[string]` object of key-values. Region code maps to list of pool IDs.","items":{"type":"string","x-auditable":true},"type":"array"},"description":"A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.","example":{"ENAM":["00920f38ce07c2e2f4df50b1f61d4194"],"WNAM":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"]},"type":"object"},"load-balancing_resource_reference":{"description":"A reference to a load balancer resource.","properties":{"reference_type":{"description":"When listed as a reference, the type (direction) of the reference.","enum":["referral","referrer"],"type":"string","x-auditable":true},"references":{"description":"A list of references to (referrer) or from (referral) this resource.","example":[{"reference_type":"referrer","resource_id":"699d98642c564d2e855e9661899b7252","resource_name":"www.example.com","resource_type":"load_balancer"},{"reference_type":"referral","resource_id":"f1aba936b94213e5b8dca0c0dbf1f9cc","resource_name":"Login page monitor","resource_type":"monitor"}],"items":{"description":"A reference to a load balancer resource.","type":"object"},"type":"array"},"resource_id":{"example":"17b5962d775c646f3f9725cbc7a53df4","type":"string"},"resource_name":{"description":"The human-identifiable name of the resource.","example":"primary-dc-1","type":"string","x-auditable":true},"resource_type":{"description":"The type of the resource.","enum":["load_balancer","monitor","pool"],"example":"pool","type":"string","x-auditable":true}},"type":"object"},"load-balancing_result_info":{"properties":{"count":{"description":"Total number of results on the current page.","example":20,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"},"total_pages":{"description":"Total number of pages available.","example":100,"type":"number"}},"type":"object"},"load-balancing_retries":{"default":2,"description":"The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.","type":"integer","x-auditable":true},"load-balancing_rules":{"description":"BETA Field Not General Access: A list of rules for this load balancer to execute.","items":{"additionalProperties":false,"description":"A rule object containing conditions and overrides for this load balancer to evaluate.","properties":{"condition":{"description":"The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.","example":"http.request.uri.path contains \"/testing\"","type":"string","x-auditable":true},"disabled":{"default":false,"description":"Disable this specific rule. It will no longer be evaluated by this load balancer.","type":"boolean","x-auditable":true},"fixed_response":{"description":"A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.","properties":{"content_type":{"description":"The http 'Content-Type' header to include in the response.","example":"application/json","maxLength":32,"type":"string","x-auditable":true},"location":{"description":"The http 'Location' header to include in the response.","example":"www.example.com","maxLength":2048,"type":"string","x-auditable":true},"message_body":{"description":"Text to include as the http body.","example":"Testing Hello","maxLength":1024,"type":"string","x-auditable":true},"status_code":{"description":"The http status code to respond with.","type":"integer","x-auditable":true}},"type":"object"},"name":{"description":"Name of this rule. Only used for human readability.","example":"route the path /testing to testing datacenter.","maxLength":200,"type":"string","x-auditable":true},"overrides":{"description":"A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.","properties":{"adaptive_routing":{"$ref":"#/components/schemas/load-balancing_adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/load-balancing_country_pools"},"default_pools":{"$ref":"#/components/schemas/load-balancing_default_pools"},"fallback_pool":{"$ref":"#/components/schemas/load-balancing_fallback_pool"},"location_strategy":{"$ref":"#/components/schemas/load-balancing_location_strategy"},"pop_pools":{"$ref":"#/components/schemas/load-balancing_pop_pools"},"random_steering":{"$ref":"#/components/schemas/load-balancing_random_steering"},"region_pools":{"$ref":"#/components/schemas/load-balancing_region_pools"},"session_affinity":{"$ref":"#/components/schemas/load-balancing_session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/load-balancing_session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/load-balancing_session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/load-balancing_steering_policy"},"ttl":{"$ref":"#/components/schemas/load-balancing_ttl"}},"type":"object"},"priority":{"default":0,"description":"The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.","minimum":0,"type":"integer","x-auditable":true},"terminates":{"description":"If this rule's condition is true, this causes rule evaluation to stop after processing this rule.","type":"boolean","x-auditable":true}},"type":"object"},"type":"array"},"load-balancing_schemas-description":{"default":"","description":"A human-readable description of the pool.","example":"Primary data center - Provider XYZ","type":"string","x-auditable":true},"load-balancing_schemas-disabled_at":{"description":"This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"load-balancing_schemas-enabled":{"default":true,"description":"Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.","example":true,"type":"boolean","x-auditable":true},"load-balancing_schemas-header":{"description":"The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.","properties":{"Host":{"$ref":"#/components/schemas/load-balancing_Host"}},"type":"object"},"load-balancing_schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}},"type":"object"}},"type":"object"}]},"load-balancing_schemas-identifier":{"example":"17b5962d775c646f3f9725cbc7a53df4","type":"string","x-auditable":true},"load-balancing_schemas-name":{"description":"A human-identifiable name for the origin.","example":"app-server-1","type":"string","x-auditable":true},"load-balancing_schemas-preview_id":{"example":"p1aba936b94213e5b8dca0c0dbf1f9cc","type":"string"},"load-balancing_schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-paginated-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/load-balancing_pool"},"type":"array"}},"type":"object"}]},"load-balancing_schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/load-balancing_pool"}},"type":"object"}]},"load-balancing_search":{"properties":{"resources":{"description":"A list of resources matching the search query.","items":{"$ref":"#/components/schemas/load-balancing_resource_reference"},"type":"array"}},"type":"object"},"load-balancing_search_result":{"properties":{"result":{"$ref":"#/components/schemas/load-balancing_search"}},"type":"object"},"load-balancing_session_affinity":{"default":"none","description":"Specifies the type of session affinity the load balancer should use unless specified as `\"none\"`. The supported types are: - `\"cookie\"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used. - `\"ip_cookie\"`: Behaves the same as `\"cookie\"` except the initial origin selection is stable and based on the client's ip address. - `\"header\"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.","enum":["none","cookie","ip_cookie","header"],"example":"cookie","type":"string","x-auditable":true},"load-balancing_session_affinity_attributes":{"description":"Configures attributes for session affinity.","properties":{"drain_duration":{"description":"Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.","example":100,"type":"number","x-auditable":true},"headers":{"default":"none","description":"Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `\"cookie:\u003ccookie-name-1\u003e,\u003ccookie-name-2\u003e\"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `\"cookie\"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.","items":{"description":"An HTTP header name.","maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_-]+$","type":"string","x-auditable":true},"type":"array","uniqueItems":true},"require_all_headers":{"default":false,"description":"When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are: - `\"true\"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created. - `\"false\"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren't created.","type":"boolean","x-auditable":true},"samesite":{"default":"Auto","description":"Configures the SameSite attribute on session affinity cookie. Value \"Auto\" will be translated to \"Lax\" or \"None\" depending if Always Use HTTPS is enabled. Note: when using value \"None\", the secure attribute can not be set to \"Never\".","enum":["Auto","Lax","None","Strict"],"example":"Auto","type":"string","x-auditable":true},"secure":{"default":"Auto","description":"Configures the Secure attribute on session affinity cookie. Value \"Always\" indicates the Secure attribute will be set in the Set-Cookie header, \"Never\" indicates the Secure attribute will not be set, and \"Auto\" will set the Secure attribute depending if Always Use HTTPS is enabled.","enum":["Auto","Always","Never"],"example":"Auto","type":"string","x-auditable":true},"zero_downtime_failover":{"default":"none","description":"Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are: - `\"none\"`: No failover takes place for sessions pinned to the origin (default). - `\"temporary\"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. - `\"sticky\"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.","enum":["none","temporary","sticky"],"example":"sticky","type":"string","x-auditable":true}},"type":"object"},"load-balancing_session_affinity_ttl":{"description":"Time, in seconds, until a client's session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are: - `\"cookie\"` / `\"ip_cookie\"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800]. - `\"header\"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven't been used for the number of seconds specified.","example":1800,"type":"number","x-auditable":true},"load-balancing_steering_policy":{"default":"","description":"Steering Policy for this load balancer.\n- `\"off\"`: Use `default_pools`.\n- `\"geo\"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.\n- `\"random\"`: Select a pool randomly.\n- `\"dynamic_latency\"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).\n- `\"proximity\"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.\n- `\"least_outstanding_requests\"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.\n- `\"least_connections\"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool's number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.\n- `\"\"`: Will map to `\"geo\"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `\"off\"`.","enum":["off","geo","random","dynamic_latency","proximity","least_outstanding_requests","least_connections",""],"example":"dynamic_latency","type":"string","x-auditable":true},"load-balancing_subdivision_code_a2":{"description":"Two-letter subdivision code followed in ISO 3166-2.","example":"CA","type":"string","x-auditable":true},"load-balancing_timeout":{"default":5,"description":"The timeout (in seconds) before marking the health check as failed.","type":"integer","x-auditable":true},"load-balancing_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"load-balancing_ttl":{"description":"Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.","example":30,"type":"number","x-auditable":true},"load-balancing_type":{"default":"http","description":"The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.","enum":["http","https","tcp","udp_icmp","icmp_ping","smtp"],"example":"https","type":"string","x-auditable":true},"load-balancing_until":{"description":"End date and time of requesting data period in the ISO8601 format.","example":"2016-11-11T13:00:00Z","format":"date-time","type":"string","x-auditable":true},"load-balancing_virtual_network_id":{"description":"The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.","example":"a5624d4e-044a-4ff0-b3e1-e2465353d4b4","type":"string"},"load-balancing_weight":{"default":1,"description":"The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.\n- `origin_steering.policy=\"least_outstanding_requests\"`: Use weight to scale the origin's outstanding requests.\n- `origin_steering.policy=\"least_connections\"`: Use weight to scale the origin's open connections.","example":0.6,"maximum":1,"minimum":0,"multipleOf":0.01,"type":"number","x-auditable":true},"logcontrol_account_identifier":{"$ref":"#/components/schemas/logcontrol_identifier"},"logcontrol_allow_out_of_region_access":{"description":"Allow out of region access","example":false,"type":"boolean","x-auditable":true},"logcontrol_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/logcontrol_messages"},"messages":{"$ref":"#/components/schemas/logcontrol_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"logcontrol_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/logcontrol_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/logcontrol_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"logcontrol_api-response-single":{"allOf":[{"$ref":"#/components/schemas/logcontrol_api-response-common"}],"type":"object"},"logcontrol_cmb_config":{"nullable":true,"properties":{"allow_out_of_region_access":{"$ref":"#/components/schemas/logcontrol_allow_out_of_region_access"},"regions":{"$ref":"#/components/schemas/logcontrol_regions"}},"type":"object"},"logcontrol_cmb_config_response_single":{"allOf":[{"$ref":"#/components/schemas/logcontrol_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/logcontrol_cmb_config"}}}]},"logcontrol_flag":{"description":"The log retention flag for Logpull API.","example":true,"type":"boolean","x-auditable":true},"logcontrol_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"logcontrol_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"logcontrol_regions":{"description":"Name of the region.","example":"eu","maxLength":256,"pattern":"^[a-z]*$","type":"string","x-auditable":true},"logcontrol_retention_flag":{"nullable":true,"properties":{"flag":{"$ref":"#/components/schemas/logcontrol_flag"}},"type":"object"},"logcontrol_retention_flag_response_single":{"allOf":[{"$ref":"#/components/schemas/logcontrol_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/logcontrol_retention_flag"}}}]},"logcontrol_zone_identifier":{"$ref":"#/components/schemas/logcontrol_identifier"},"logpush_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/logpush_messages"},"messages":{"$ref":"#/components/schemas/logpush_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"logpush_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/logpush_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/logpush_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"logpush_api-response-single":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common"}],"type":"object"},"logpush_dataset":{"default":"http_requests","description":"Name of the dataset. A list of supported datasets can be found on the [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/).","enum":["access_requests","audit_logs","audit_logs_v2","biso_user_actions","casb_findings","device_posture_results","dex_application_tests","dex_device_state_events","dlp_forensic_copies","dns_firewall_logs","dns_logs","email_security_alerts","firewall_events","gateway_dns","gateway_http","gateway_network","http_requests","ipsec_logs","magic_ids_detections","nel_reports","network_analytics_logs","page_shield_events","sinkhole_http_logs","spectrum_events","ssh_logs","warp_config_changes","warp_toggle_changes","workers_trace_events","zaraz_events","zero_trust_network_sessions"],"example":"http_requests","nullable":true,"type":"string","x-auditable":true},"logpush_destination_conf":{"description":"Uniquely identifies a resource (such as an s3 bucket) where data. will be pushed. Additional configuration parameters supported by the destination may be included.","example":"s3://mybucket/logs?region=us-west-2","format":"uri","maxLength":4096,"type":"string"},"logpush_destination_exists_response":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"exists":{"example":false,"type":"boolean","x-auditable":true}},"type":"object"}},"type":"object"}]},"logpush_enabled":{"default":false,"description":"Flag that indicates if the job is enabled.","example":false,"type":"boolean","x-auditable":true},"logpush_error_message":{"description":"If not null, the job is currently failing. Failures are usually. repetitive (example: no permissions to write to destination bucket). Only the last failure is recorded. On successful execution of a job the error_message and last_error are set to null.","nullable":true,"type":"string","x-auditable":true},"logpush_fields":{"description":"Comma-separated list of fields.","example":"ClientIP,ClientRequestHost,ClientRequestMethod,ClientRequestURI,EdgeEndTimestamp,EdgeResponseBytes,EdgeResponseStatus,EdgeStartTimestamp,RayID","type":"string","x-auditable":true},"logpush_filter":{"description":"The filters to select the events to include and/or remove from your logs. For more information, refer to [Filters](https://developers.cloudflare.com/logs/reference/filters/).","example":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","nullable":true,"type":"string"},"logpush_frequency":{"default":"high","deprecated":true,"description":"This field is deprecated. Please use `max_upload_*` parameters instead. . The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.","enum":["high","low"],"example":"high","nullable":true,"type":"string","x-auditable":true},"logpush_get_ownership_response":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"filename":{"example":"logs/challenge-filename.txt","type":"string","x-auditable":true},"message":{"example":"","type":"string","x-auditable":true},"valid":{"example":true,"type":"boolean","x-auditable":true}},"type":"object"}},"type":"object"}]},"logpush_id":{"description":"Unique id of the job.","minimum":1,"type":"integer","x-auditable":true},"logpush_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"logpush_instant_logs_job":{"nullable":true,"properties":{"destination_conf":{"$ref":"#/components/schemas/logpush_schemas-destination_conf"},"fields":{"$ref":"#/components/schemas/logpush_fields"},"filter":{"$ref":"#/components/schemas/logpush_schemas-filter"},"sample":{"$ref":"#/components/schemas/logpush_sample"},"session_id":{"$ref":"#/components/schemas/logpush_session_id"}},"type":"object"},"logpush_instant_logs_job_response_collection":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/logpush_instant_logs_job"},"type":"array"}},"type":"object"}]},"logpush_instant_logs_job_response_single":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/logpush_instant_logs_job"}},"type":"object"}]},"logpush_kind":{"default":"","description":"The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs (when supported by the dataset).","enum":["","edge"],"example":"","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"logpush_last_complete":{"description":"Records the last time for which logs have been successfully pushed. If the last successful push was for logs range 2018-07-23T10:00:00Z to 2018-07-23T10:01:00Z then the value of this field will be 2018-07-23T10:01:00Z. If the job has never run or has just been enabled and hasn't run yet then the field will be empty.","format":"date-time","nullable":true,"type":"string","x-auditable":true},"logpush_last_error":{"description":"Records the last time the job failed. If not null, the job is currently. failing. If null, the job has either never failed or has run successfully at least once since last failure. See also the error_message field.","format":"date-time","nullable":true,"type":"string","x-auditable":true},"logpush_logpull_options":{"deprecated":true,"description":"This field is deprecated. Use `output_options` instead. Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.","example":"fields=RayID,ClientIP,EdgeStartTimestamp\u0026timestamps=rfc3339","format":"uri-reference","maxLength":4096,"nullable":true,"type":"string","x-auditable":true},"logpush_logpush_field_response_collection":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common"},{"properties":{"result":{"items":{"nullable":true,"properties":{"key":{"example":"value","type":"string","x-auditable":true}},"type":"object"},"type":"object"}},"type":"object"}]},"logpush_logpush_job":{"nullable":true,"properties":{"dataset":{"$ref":"#/components/schemas/logpush_dataset"},"destination_conf":{"$ref":"#/components/schemas/logpush_destination_conf"},"enabled":{"$ref":"#/components/schemas/logpush_enabled"},"error_message":{"$ref":"#/components/schemas/logpush_error_message"},"frequency":{"$ref":"#/components/schemas/logpush_frequency"},"id":{"$ref":"#/components/schemas/logpush_id"},"kind":{"$ref":"#/components/schemas/logpush_kind"},"last_complete":{"$ref":"#/components/schemas/logpush_last_complete"},"last_error":{"$ref":"#/components/schemas/logpush_last_error"},"logpull_options":{"$ref":"#/components/schemas/logpush_logpull_options"},"max_upload_bytes":{"$ref":"#/components/schemas/logpush_max_upload_bytes"},"max_upload_interval_seconds":{"$ref":"#/components/schemas/logpush_max_upload_interval_seconds"},"max_upload_records":{"$ref":"#/components/schemas/logpush_max_upload_records"},"name":{"$ref":"#/components/schemas/logpush_name"},"output_options":{"$ref":"#/components/schemas/logpush_output_options"}},"type":"object"},"logpush_logpush_job_response_collection":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/logpush_logpush_job"},"type":"array"}},"type":"object"}]},"logpush_logpush_job_response_single":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/logpush_logpush_job"}},"type":"object"}]},"logpush_max_upload_bytes":{"description":"The maximum uncompressed file size of a batch of logs. This setting value must be between `5 MB` and `1 GB`, or `0` to disable it. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size.","example":5000000,"nullable":true,"oneOf":[{"enum":[0],"type":"integer"},{"maximum":1000000000,"minimum":5000000,"type":"integer"}],"type":"integer","x-auditable":true},"logpush_max_upload_interval_seconds":{"description":"The maximum interval in seconds for log batches. This setting must be between 30 and 300 seconds (5 minutes), or `0` to disable it. Note that you cannot specify a minimum interval for log batches; this means that log files may be sent in shorter intervals than this.","example":30,"nullable":true,"oneOf":[{"enum":[0],"type":"integer"},{"maximum":300,"minimum":30,"type":"integer"}],"type":"integer","x-auditable":true},"logpush_max_upload_records":{"description":"The maximum number of log lines per batch. This setting must be between 1000 and 1,000,000 lines, or `0` to disable it. Note that you cannot specify a minimum number of log lines per batch; this means that log files may contain many fewer lines than this.","example":1000,"nullable":true,"oneOf":[{"enum":[0],"type":"integer"},{"maximum":1000000,"minimum":1000,"type":"integer"}],"type":"integer","x-auditable":true},"logpush_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"logpush_name":{"description":"Optional human readable job name. Not unique. Cloudflare suggests. that you set this to a meaningful string, like the domain name, to make it easier to identify your job.","example":"example.com","maxLength":512,"nullable":true,"pattern":"^[a-zA-Z0-9\\._-]*$","type":"string","x-auditable":true},"logpush_output_options":{"description":"The structured replacement for `logpull_options`. When including this field, the `logpull_option` field will be ignored.","nullable":true,"properties":{"CVE-2021-44228":{"description":"If set to true, will cause all occurrences of `${` in the generated files to be replaced with `x{`.","nullable":true,"type":"boolean","x-auditable":true},"batch_prefix":{"description":"String to be prepended before each batch.","nullable":true,"type":"string","x-auditable":true},"batch_suffix":{"description":"String to be appended after each batch.","nullable":true,"type":"string","x-auditable":true},"field_delimiter":{"description":"String to join fields. This field be ignored when `record_template` is set.","nullable":true,"type":"string","x-auditable":true},"field_names":{"description":"List of field names to be included in the Logpush output. For the moment, there is no option to add all fields at once, so you must specify all the fields names you are interested in.","example":["ClientIP","EdgeStartTimestamp","RayID"],"items":{"type":"string","x-auditable":true},"type":"array"},"output_type":{"description":"Specifies the output type, such as `ndjson` or `csv`. This sets default values for the rest of the settings, depending on the chosen output type. Some formatting rules, like string quoting, are different between output types.","enum":["ndjson","csv"],"example":"ndjson","type":"string","x-auditable":true},"record_delimiter":{"description":"String to be inserted in-between the records as separator.","nullable":true,"type":"string","x-auditable":true},"record_prefix":{"description":"String to be prepended before each record.","nullable":true,"type":"string","x-auditable":true},"record_suffix":{"description":"String to be appended after each record.","nullable":true,"type":"string","x-auditable":true},"record_template":{"description":"String to use as template for each record instead of the default json key value mapping. All fields used in the template must be present in `field_names` as well, otherwise they will end up as null. Format as a Go `text/template` without any standard functions, like conditionals, loops, sub-templates, etc.","nullable":true,"type":"string","x-auditable":true},"sample_rate":{"description":"Floating number to specify sampling rate. Sampling is applied on top of filtering, and regardless of the current `sample_interval` of the data.","format":"float","maximum":1,"minimum":0,"nullable":true,"type":"number","x-auditable":true},"timestamp_format":{"description":"String to specify the format for timestamps, such as `unixnano`, `unix`, or `rfc3339`.","enum":["unixnano","unix","rfc3339"],"type":"string","x-auditable":true}},"type":"object"},"logpush_ownership_challenge":{"description":"Ownership challenge token to prove destination ownership.","example":"00000000000000000000","maxLength":4096,"pattern":"^[a-zA-Z0-9/\\+\\._-]*$","type":"string","x-sensitive":true},"logpush_sample":{"description":"The sample parameter is the sample rate of the records set by the client: \"sample\": 1 is 100% of records \"sample\": 10 is 10% and so on.","example":1,"type":"integer","x-auditable":true},"logpush_schemas-destination_conf":{"description":"Unique WebSocket address that will receive messages from Cloudflare’s edge.","example":"wss://logs.cloudflare.com/instant-logs/ws/sessions/99d471b1ca3c23cc8e30b6acec5db987","format":"uri","maxLength":4096,"type":"string","x-auditable":true},"logpush_schemas-filter":{"description":"Filters to drill down into specific events.","example":"{\"where\":{\"and\":[{\"key\":\"ClientCountry\",\"operator\":\"neq\",\"value\":\"ca\"}]}}","type":"string","x-auditable":true},"logpush_session_id":{"description":"Unique session id of the job.","example":"99d471b1ca3c23cc8e30b6acec5db987","type":"string","x-auditable":true},"logpush_validate_ownership_response":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"valid":{"example":true,"type":"boolean","x-auditable":true}},"type":"object"}},"type":"object"}]},"logpush_validate_response":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"message":{"example":"","type":"string","x-auditable":true},"valid":{"example":true,"type":"boolean","x-auditable":true}},"type":"object"}},"type":"object"}]},"logshare_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/logshare_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/logshare_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"logshare_count":{"description":"When `?count=` is provided, the response will contain up to `count` results. Since results are not sorted, you are likely to get different data for repeated requests. `count` must be an integer \u003e 0.","minimum":1,"type":"integer","x-auditable":true},"logshare_end":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"Sets the (exclusive) end of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. `end` must be at least five minutes earlier than now and must be later than `start`. Difference between `start` and `end` must be not greater than one hour.","example":"2018-05-20T10:01:00Z","x-auditable":true},"logshare_fields":{"description":"The `/received` route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. Most customers require only a small subset of fields, but that subset varies from customer to customer; 2. Flat schema is much easier to work with downstream (importing into BigTable etc); 3. Performance (time to process, file size). If `?fields=` is not specified, default field set is returned. This default field set may change at any time. When `?fields=` is provided, each record is returned with the specified fields. `fields` must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified does not matter, and the order of fields in the response is not specified.","example":"ClientIP,RayID,EdgeStartTimestamp","type":"string","x-auditable":true},"logshare_fields_response":{"properties":{"key":{"example":"value","type":"string","x-auditable":true}},"type":"object"},"logshare_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"logshare_logs_response_json_lines":{"anyOf":[{"type":"string"},{"type":"object"}],"example":"{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}\n{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}\n{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}"},"logshare_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"logshare_ray_identifier":{"description":"Ray identifier.","example":"41ddf1740f67442d","maxLength":16,"readOnly":true,"type":"string","x-auditable":true},"logshare_sample":{"description":"When `?sample=` is provided, a sample of matching records is returned. If `sample=0.1` then 10% of records will be returned. Sampling is random: repeated calls will not only return different records, but likely will also vary slightly in number of returned records. When `?count=` is also specified, `count` is applied to the number of returned records, not the sampled records. So, with `sample=0.05` and `count=7`, when there is a total of 100 records available, approximately five will be returned. When there are 1000 records, seven will be returned. When there are 10,000 records, seven will be returned.","example":0.1,"maximum":1,"minimum":0,"type":"number","x-auditable":true},"logshare_start":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"Sets the (inclusive) beginning of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than seven days.","example":"2018-05-20T10:00:00Z","x-auditable":true},"logshare_timestamps":{"default":"unixnano","description":"By default, timestamps in responses are returned as Unix nanosecond integers. The `?timestamps=` argument can be set to change the format in which response timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`. Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns timestamps as strings.","enum":["unix","unixnano","rfc3339"],"example":"unixnano","type":"string","x-auditable":true},"logshare_zone_identifier":{"$ref":"#/components/schemas/logshare_identifier"},"magic-transit_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/magic-transit_messages"},"messages":{"$ref":"#/components/schemas/magic-transit_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"magic-transit_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/magic-transit_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/magic-transit_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"magic-transit_asn":{"description":"AS number associated with the node object.","type":"string"},"magic-transit_check_type":{"default":"icmp","description":"type of check to perform","enum":["icmp"],"example":"icmp","type":"string"},"magic-transit_colo":{"properties":{"city":{"$ref":"#/components/schemas/magic-transit_colo_city"},"name":{"$ref":"#/components/schemas/magic-transit_colo_name"}},"type":"object"},"magic-transit_colo_city":{"description":"Source colo city.","example":"Denver, CO, US","type":"string"},"magic-transit_colo_name":{"description":"Source colo name.","example":"den01","type":"string"},"magic-transit_colo_result":{"properties":{"colo":{"$ref":"#/components/schemas/magic-transit_colo"},"error":{"$ref":"#/components/schemas/magic-transit_error"},"hops":{"items":{"$ref":"#/components/schemas/magic-transit_hop_result"},"type":"array"},"target_summary":{"$ref":"#/components/schemas/magic-transit_target_summary"},"traceroute_time_ms":{"$ref":"#/components/schemas/magic-transit_traceroute_time_ms"}},"type":"object"},"magic-transit_colos":{"description":"If no source colo names specified, all colos will be used. China colos are unavailable for traceroutes.","example":["den","sin"],"items":{"description":"Source colo name.","type":"string"},"type":"array"},"magic-transit_endpoint_health_check":{"properties":{"check_type":{"$ref":"#/components/schemas/magic-transit_check_type"},"endpoint":{"description":"the IP address of the host to perform checks against","example":"203.0.113.1","type":"string"},"name":{"description":"Optional name associated with this check","example":"My Endpoint","type":"string"}},"required":["check_type","endpoint"],"type":"object"},"magic-transit_endpoint_health_check_response":{"allOf":[{"$ref":"#/components/schemas/magic-transit_endpoint_health_check"},{"properties":{"id":{"$ref":"#/components/schemas/magic-transit_uuid"}}}],"required":["id","check_type","endpoint"],"type":"object"},"magic-transit_endpoint_health_check_response_collection":{"allOf":[{"$ref":"#/components/schemas/magic-transit_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/magic-transit_endpoint_health_check_response"},"type":"array"}}}]},"magic-transit_endpoint_health_check_response_single":{"allOf":[{"$ref":"#/components/schemas/magic-transit_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/magic-transit_endpoint_health_check_response"}}}]},"magic-transit_error":{"description":"Errors resulting from collecting traceroute from colo to target.","enum":["","Could not gather traceroute data: Code 1","Could not gather traceroute data: Code 2","Could not gather traceroute data: Code 3","Could not gather traceroute data: Code 4"],"example":"","type":"string"},"magic-transit_hop_result":{"properties":{"nodes":{"description":"An array of node objects.","items":{"$ref":"#/components/schemas/magic-transit_node_result"},"type":"array"},"packets_lost":{"$ref":"#/components/schemas/magic-transit_packets_lost"},"packets_sent":{"$ref":"#/components/schemas/magic-transit_packets_sent"},"packets_ttl":{"$ref":"#/components/schemas/magic-transit_packets_ttl"}},"type":"object"},"magic-transit_identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"magic-transit_ip":{"description":"IP address of the node.","type":"string"},"magic-transit_labels":{"description":"Field appears if there is an additional annotation printed when the probe returns. Field also appears when running a GRE+ICMP traceroute to denote which traceroute a node comes from.","items":{"type":"string"},"type":"array"},"magic-transit_max_rtt_ms":{"description":"Maximum RTT in ms.","type":"number"},"magic-transit_max_ttl":{"default":15,"description":"Max TTL.","maximum":64,"minimum":0,"type":"integer"},"magic-transit_mean_rtt_ms":{"description":"Mean RTT in ms.","type":"number"},"magic-transit_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"magic-transit_min_rtt_ms":{"description":"Minimum RTT in ms.","type":"number"},"magic-transit_name":{"description":"Host name of the address, this may be the same as the IP address.","type":"string"},"magic-transit_node_result":{"example":{"asn":"AS13335","ip":"1.1.1.1","max_latency_ms":0.034,"mean_latency_ms":0.021,"min_latency_ms":0.014,"name":"one.one.one.one","packet_count":3,"std_dev_latency_ms":0.011269427669584647},"properties":{"asn":{"$ref":"#/components/schemas/magic-transit_asn"},"ip":{"$ref":"#/components/schemas/magic-transit_ip"},"labels":{"$ref":"#/components/schemas/magic-transit_labels"},"max_rtt_ms":{"$ref":"#/components/schemas/magic-transit_max_rtt_ms"},"mean_rtt_ms":{"$ref":"#/components/schemas/magic-transit_mean_rtt_ms"},"min_rtt_ms":{"$ref":"#/components/schemas/magic-transit_min_rtt_ms"},"name":{"$ref":"#/components/schemas/magic-transit_name"},"packet_count":{"$ref":"#/components/schemas/magic-transit_packet_count"},"std_dev_rtt_ms":{"$ref":"#/components/schemas/magic-transit_std_dev_rtt_ms"}},"type":"object"},"magic-transit_options":{"example":{"max_ttl":15,"packet_type":"icmp"},"properties":{"max_ttl":{"$ref":"#/components/schemas/magic-transit_max_ttl"},"packet_type":{"$ref":"#/components/schemas/magic-transit_packet_type"},"packets_per_ttl":{"$ref":"#/components/schemas/magic-transit_packets_per_ttl"},"port":{"$ref":"#/components/schemas/magic-transit_port"},"wait_time":{"$ref":"#/components/schemas/magic-transit_wait_time"}},"type":"object"},"magic-transit_packet_count":{"description":"Number of packets with a response from this node.","type":"integer"},"magic-transit_packet_type":{"default":"icmp","description":"Type of packet sent.","enum":["icmp","tcp","udp","gre","gre+icmp"],"example":"icmp","type":"string"},"magic-transit_packets_lost":{"description":"Number of packets where no response was received.","type":"integer"},"magic-transit_packets_per_ttl":{"default":3,"description":"Number of packets sent at each TTL.","maximum":10,"minimum":0,"type":"integer"},"magic-transit_packets_sent":{"description":"Number of packets sent with specified TTL.","type":"integer"},"magic-transit_packets_ttl":{"description":"The time to live (TTL).","type":"integer"},"magic-transit_port":{"default":0,"description":"For UDP and TCP, specifies the destination port. For ICMP, specifies the initial ICMP sequence value. Default value 0 will choose the best value to use for each protocol.","maximum":65535,"minimum":0,"type":"integer"},"magic-transit_std_dev_rtt_ms":{"description":"Standard deviation of the RTTs in ms.","type":"number"},"magic-transit_target":{"description":"The target hostname, IPv6, or IPv6 address.","example":"1.1.1.1","type":"string"},"magic-transit_target_result":{"properties":{"colos":{"items":{"$ref":"#/components/schemas/magic-transit_colo_result"},"type":"array"},"target":{"$ref":"#/components/schemas/magic-transit_target"}},"type":"object"},"magic-transit_target_summary":{"description":"Aggregated statistics from all hops about the target.","example":{"asn":"","ip":"1.1.1.1","max_latency_ms":0.034,"mean_latency_ms":0.021,"min_latency_ms":0.014,"name":"1.1.1.1","packet_count":3,"std_dev_latency_ms":0.011269427669584647},"type":"object"},"magic-transit_targets":{"example":["203.0.113.1","cloudflare.com"],"items":{"description":"Hosts as a hostname or IPv4/IPv6 address represented by strings.","example":"203.0.113.1","type":"string"},"maxLength":10,"type":"array"},"magic-transit_traceroute_response_collection":{"allOf":[{"$ref":"#/components/schemas/magic-transit_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/magic-transit_target_result"},"type":"array"}}}]},"magic-transit_traceroute_time_ms":{"description":"Total time of traceroute in ms.","type":"integer"},"magic-transit_uuid":{"description":"UUID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string"},"magic-transit_wait_time":{"default":1,"description":"Set the time (in seconds) to wait for a response to a probe.","maximum":5,"minimum":1,"type":"integer"},"magic-visibility-mnm_account_identifier":{"example":"6f91088a406011ed95aed352566e8d4c","type":"string","x-auditable":true},"magic-visibility-mnm_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common"},{"properties":{"result":{"items":{},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/magic-visibility-mnm_result_info"}}}],"type":"object"},"magic-visibility-mnm_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/magic-visibility-mnm_messages"},"messages":{"$ref":"#/components/schemas/magic-visibility-mnm_messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"magic-visibility-mnm_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"magic-visibility-mnm_api-response-single":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common"},{"properties":{"result":{"anyOf":[{"nullable":true,"type":"object"},{"nullable":true,"type":"string"}]}}}],"type":"object"},"magic-visibility-mnm_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"magic-visibility-mnm_mnm_config":{"properties":{"default_sampling":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_default_sampling"},"name":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_name"},"router_ips":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_router_ips"},"warp_devices":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_warp_devices"}},"required":["name","default_sampling","router_ips","warp_devices"],"type":"object"},"magic-visibility-mnm_mnm_config_default_sampling":{"default":1,"description":"Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.","minimum":1,"type":"number","x-auditable":true},"magic-visibility-mnm_mnm_config_name":{"description":"The account name.","example":"cloudflare user's account","type":"string","x-auditable":true},"magic-visibility-mnm_mnm_config_router_ip":{"description":"IPv4 CIDR of the router sourcing flow data. Only /32 addresses are currently supported.","example":"203.0.113.1","type":"string","x-auditable":true},"magic-visibility-mnm_mnm_config_router_ips":{"items":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_router_ip"},"type":"array"},"magic-visibility-mnm_mnm_config_single_response":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config"}},"type":"object"}]},"magic-visibility-mnm_mnm_config_warp_device":{"description":"Object representing a warp device with an ID and name.","properties":{"id":{"description":"Unique identifier for the warp device.","example":"5360368d-b351-4791-abe1-93550dabd351","type":"string","x-auditable":true},"name":{"description":"Name of the warp device.","example":"My warp device","type":"string","x-auditable":true},"router_ip":{"description":"IPv4 CIDR of the router sourcing flow data associated with this warp device. Only /32 addresses are currently supported.","example":"203.0.113.1","type":"string","x-auditable":true}},"required":["id","name","router_ip"],"type":"object"},"magic-visibility-mnm_mnm_config_warp_devices":{"items":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_warp_device"},"type":"array"},"magic-visibility-mnm_mnm_rule":{"nullable":true,"properties":{"automatic_advertisement":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_automatic_advertisement"},"bandwidth_threshold":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_bandwidth_threshold"},"duration":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_duration"},"id":{"$ref":"#/components/schemas/magic-visibility-mnm_rule_identifier"},"name":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_name"},"packet_threshold":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_packet_threshold"},"prefix_match":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_prefix_match"},"prefixes":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_ip_prefixes"},"type":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_type"},"zscore_sensitivity":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_zscore_sensitivity"},"zscore_target":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_zscore_target"}},"required":["name","prefixes","automatic_advertisement","type"],"type":"object"},"magic-visibility-mnm_mnm_rule_advertisable_response":{"nullable":true,"properties":{"automatic_advertisement":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_automatic_advertisement"}},"required":["automatic_advertisement"],"type":"object"},"magic-visibility-mnm_mnm_rule_advertisement_single_response":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_advertisable_response"}},"type":"object"}]},"magic-visibility-mnm_mnm_rule_automatic_advertisement":{"description":"Toggle on if you would like Cloudflare to automatically advertise the IP Prefixes within the rule via Magic Transit when the rule is triggered. Only available for users of Magic Transit.","example":"false","nullable":true,"type":"boolean","x-auditable":true},"magic-visibility-mnm_mnm_rule_bandwidth_threshold":{"description":"The number of bits per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.","example":1000,"minimum":1,"type":"number","x-auditable":true},"magic-visibility-mnm_mnm_rule_duration":{"default":"1m","description":"The amount of time that the rule threshold must be exceeded to send an alert notification. The final value must be equivalent to one of the following 8 values [\"1m\",\"5m\",\"10m\",\"15m\",\"20m\",\"30m\",\"45m\",\"60m\"].","enum":["1m","5m","10m","15m","20m","30m","45m","60m"],"example":"300s","type":"string","x-auditable":true},"magic-visibility-mnm_mnm_rule_ip_prefix":{"description":"The IP prefixes that are monitored for this rule. Must be a CIDR range like 203.0.113.0/24. Max 5000 different CIDR ranges.","example":"203.0.113.1/32","type":"string","x-auditable":true},"magic-visibility-mnm_mnm_rule_ip_prefixes":{"items":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_ip_prefix"},"type":"array"},"magic-visibility-mnm_mnm_rule_name":{"description":"The name of the rule. Must be unique. Supports characters A-Z, a-z, 0-9, underscore (_), dash (-), period (.), and tilde (~). You can’t have a space in the rule name. Max 256 characters.","example":"my_rule_1","type":"string","x-auditable":true},"magic-visibility-mnm_mnm_rule_packet_threshold":{"description":"The number of packets per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.","example":10000,"minimum":1,"type":"number","x-auditable":true},"magic-visibility-mnm_mnm_rule_prefix_match":{"description":"Prefix match type to be applied for a prefix auto advertisement when using an advanced_ddos rule.","enum":["exact","subnet","supernet"],"example":"exact","nullable":true,"type":"string","x-auditable":true},"magic-visibility-mnm_mnm_rule_type":{"description":"MNM rule type.","enum":["threshold","zscore","advanced_ddos"],"example":"zscore","type":"string","x-auditable":true},"magic-visibility-mnm_mnm_rule_zscore_sensitivity":{"description":"Level of sensitivity set for zscore rules.","enum":["low","medium","high"],"example":"high","nullable":true,"type":"string","x-auditable":true},"magic-visibility-mnm_mnm_rule_zscore_target":{"description":"Target of the zscore rule analysis.","enum":["bits","packets"],"example":"bits","nullable":true,"type":"string","x-auditable":true},"magic-visibility-mnm_mnm_rules_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule"},"nullable":true,"type":"array"}}}]},"magic-visibility-mnm_mnm_rules_single_response":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule"}},"type":"object"}]},"magic-visibility-mnm_mnm_vpc_flows_single_response":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_vpc_flows_token"}},"type":"object"}]},"magic-visibility-mnm_mnm_vpc_flows_token":{"description":"Authentication token to be used for VPC Flows export authentication.","example":"JWE/JWT auth token","type":"string","x-sensitive":true},"magic-visibility-mnm_result_info":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters","example":2000,"type":"number"}},"type":"object"},"magic-visibility-mnm_rule_identifier":{"description":"The id of the rule. Must be unique.","example":"2890e6fa406311ed9b5a23f70f6fb8cf","type":"string","x-auditable":true},"magic-visibility-pcaps_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_api-response-common"},{"properties":{"result":{"items":{},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/magic-visibility-pcaps_result_info"}},"type":"object"}],"type":"object"},"magic-visibility-pcaps_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/magic-visibility-pcaps_messages"},"messages":{"$ref":"#/components/schemas/magic-visibility-pcaps_messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"magic-visibility-pcaps_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"magic-visibility-pcaps_api-response-single":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_api-response-common"},{"properties":{"result":{"anyOf":[{"type":"object"},{"type":"string"}]}},"type":"object"}],"type":"object"},"magic-visibility-pcaps_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"magic-visibility-pcaps_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"magic-visibility-pcaps_pcaps_byte_limit":{"description":"The maximum number of bytes to capture. This field only applies to `full` packet captures.","example":500000,"maximum":1000000000,"minimum":1,"type":"number","x-auditable":true},"magic-visibility-pcaps_pcaps_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_api-response-collection"},{"properties":{"result":{"items":{"anyOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_response_simple"},{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_response_full"}]},"type":"array"}},"type":"object"}]},"magic-visibility-pcaps_pcaps_colo_name":{"description":"The name of the data center used for the packet capture. This can be a specific colo (ord02) or a multi-colo name (ORD). This field only applies to `full` packet captures.","example":"ord02","type":"string","x-auditable":true},"magic-visibility-pcaps_pcaps_destination_conf":{"description":"The full URI for the bucket. This field only applies to `full` packet captures.","example":"s3://pcaps-bucket?region=us-east-1","type":"string"},"magic-visibility-pcaps_pcaps_error_message":{"description":"An error message that describes why the packet capture failed. This field only applies to `full` packet captures.","example":"No packets matched the filter in the time limit given. Please modify the filter or try again.","type":"string"},"magic-visibility-pcaps_pcaps_filter_v1":{"description":"The packet capture filter. When this field is empty, all packets are captured.","properties":{"destination_address":{"description":"The destination IP address of the packet.","example":"1.2.3.4","type":"string","x-auditable":true},"destination_port":{"description":"The destination port of the packet.","example":80,"type":"number","x-auditable":true},"protocol":{"description":"The protocol number of the packet.","example":6,"type":"number","x-auditable":true},"source_address":{"description":"The source IP address of the packet.","example":"1.2.3.4","type":"string","x-auditable":true},"source_port":{"description":"The source port of the packet.","example":123,"type":"number","x-auditable":true}},"type":"object"},"magic-visibility-pcaps_pcaps_id":{"description":"The ID for the packet capture.","example":"66802ca5668e47a2b82c2e6746e45037","maxLength":32,"minLength":32,"type":"string","x-auditable":true},"magic-visibility-pcaps_pcaps_offset_time":{"description":"The RFC 3339 offset timestamp from which to query backwards for packets. Must be within the last 24h. When this field is empty, defaults to time of request.","example":"2020-01-01T08:00:00Z","format":"date-time","type":"string","x-auditable":true},"magic-visibility-pcaps_pcaps_ownership_challenge":{"description":"The ownership challenge filename stored in the bucket.","example":"ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt","type":"string"},"magic-visibility-pcaps_pcaps_ownership_collection":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_ownership_response"},"nullable":true,"type":"array"}},"type":"object"}]},"magic-visibility-pcaps_pcaps_ownership_request":{"properties":{"destination_conf":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_destination_conf"}},"required":["destination_conf"],"type":"object"},"magic-visibility-pcaps_pcaps_ownership_response":{"properties":{"destination_conf":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_destination_conf"},"filename":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_ownership_challenge"},"id":{"description":"The bucket ID associated with the packet captures API.","example":"9883874ecac311ec8475433579a6bf5f","maxLength":32,"minLength":32,"type":"string"},"status":{"description":"The status of the ownership challenge. Can be pending, success or failed.","enum":["pending","success","failed"],"example":"success","type":"string"},"submitted":{"description":"The RFC 3339 timestamp when the bucket was added to packet captures API.","example":"2020-01-01T08:00:00Z","type":"string"},"validated":{"description":"The RFC 3339 timestamp when the bucket was validated.","example":"2020-01-01T08:00:00Z","type":"string"}},"required":["id","status","submitted","destination_conf","filename"],"type":"object"},"magic-visibility-pcaps_pcaps_ownership_single_response":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_ownership_response"}},"type":"object"}]},"magic-visibility-pcaps_pcaps_ownership_validate_request":{"properties":{"destination_conf":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_destination_conf"},"ownership_challenge":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_ownership_challenge"}},"required":["destination_conf","ownership_challenge"],"type":"object"},"magic-visibility-pcaps_pcaps_packet_limit":{"description":"The limit of packets contained in a packet capture.","example":10000,"maximum":10000,"minimum":1,"type":"number","x-auditable":true},"magic-visibility-pcaps_pcaps_packets_captured":{"description":"The number of packets captured.","type":"integer"},"magic-visibility-pcaps_pcaps_request_full":{"properties":{"byte_limit":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_byte_limit"},"colo_name":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_colo_name"},"destination_conf":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_destination_conf"},"filter_v1":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_filter_v1"},"packet_limit":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_packet_limit"},"system":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_system"},"time_limit":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_time_limit_full"},"type":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_type"}},"required":["time_limit","type","system","colo_name","destination_conf"],"type":"object"},"magic-visibility-pcaps_pcaps_request_pcap":{"anyOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_request_simple"},{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_request_full"}]},"magic-visibility-pcaps_pcaps_request_simple":{"properties":{"filter_v1":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_filter_v1"},"offset_time":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_offset_time"},"packet_limit":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_packet_limit"},"system":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_system"},"time_limit":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_time_limit_sampled"},"type":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_type"}},"required":["time_limit","packet_limit","type","system"],"type":"object"},"magic-visibility-pcaps_pcaps_response_full":{"properties":{"byte_limit":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_byte_limit"},"colo_name":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_colo_name"},"destination_conf":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_destination_conf"},"error_message":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_error_message"},"filter_v1":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_filter_v1"},"id":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_id"},"packets_captured":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_packets_captured"},"status":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_status"},"stop_requested":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_stop_requested"},"submitted":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_submitted"},"system":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_system"},"time_limit":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_time_limit_full"},"type":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_type"}},"type":"object"},"magic-visibility-pcaps_pcaps_response_simple":{"properties":{"filter_v1":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_filter_v1"},"id":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_id"},"offset_time":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_offset_time"},"status":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_status"},"submitted":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_submitted"},"system":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_system"},"time_limit":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_time_limit_sampled"},"type":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_type"}},"type":"object"},"magic-visibility-pcaps_pcaps_single_response":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_api-response-single"},{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_response_simple"},{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_response_full"}]}},"type":"object"}]},"magic-visibility-pcaps_pcaps_status":{"description":"The status of the packet capture request.","enum":["unknown","success","pending","running","conversion_pending","conversion_running","complete","failed"],"example":"success","type":"string"},"magic-visibility-pcaps_pcaps_stop_requested":{"description":"The RFC 3339 timestamp when stopping the packet capture was requested. This field only applies to `full` packet captures.","format":"date-time","type":"string"},"magic-visibility-pcaps_pcaps_submitted":{"description":"The RFC 3339 timestamp when the packet capture was created.","example":"2020-01-01T08:00:00Z","type":"string"},"magic-visibility-pcaps_pcaps_system":{"description":"The system used to collect packet captures.","enum":["magic-transit"],"example":"magic-transit","type":"string","x-auditable":true},"magic-visibility-pcaps_pcaps_time_limit_full":{"description":"The packet capture duration in seconds.","example":86400,"maximum":86400,"minimum":1,"type":"number","x-auditable":true},"magic-visibility-pcaps_pcaps_time_limit_sampled":{"description":"The packet capture duration in seconds.","example":300,"maximum":300,"minimum":1,"type":"number","x-auditable":true},"magic-visibility-pcaps_pcaps_type":{"description":"The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.","enum":["simple","full"],"example":"simple","type":"string","x-auditable":true},"magic-visibility-pcaps_result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"},"magic_account_app":{"description":"Custom app defined for an account.","properties":{"account_app_id":{"$ref":"#/components/schemas/magic_account_app_id"},"hostnames":{"$ref":"#/components/schemas/magic_app_hostnames"},"ip_subnets":{"$ref":"#/components/schemas/magic_app_subnets"},"name":{"$ref":"#/components/schemas/magic_app_name"},"type":{"$ref":"#/components/schemas/magic_app_type"}},"required":["account_app_id"],"title":"Account App","type":"object"},"magic_account_app_id":{"description":"Magic account app ID.","example":"ac60d3d0435248289d446cedd870bcf4","type":"string"},"magic_acl":{"description":"Bidirectional ACL policy for network traffic within a site.","properties":{"description":{"description":"Description for the ACL.","example":"Allows local traffic between PIN pads and cash register.","type":"string"},"forward_locally":{"$ref":"#/components/schemas/magic_forward_locally"},"id":{"$ref":"#/components/schemas/magic_identifier"},"lan_1":{"$ref":"#/components/schemas/magic_lan-acl-configuration"},"lan_2":{"$ref":"#/components/schemas/magic_lan-acl-configuration"},"name":{"description":"The name of the ACL.","example":"PIN Pad - Cash Register","type":"string"},"protocols":{"items":{"description":"Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.","enum":["tcp","udp","icmp"],"type":"string"},"type":"array"},"unidirectional":{"$ref":"#/components/schemas/magic_unidirectional"}},"type":"object"},"magic_acl-port-range":{"description":"A valid port range value.","example":"8080-9000","type":"string"},"magic_acl-subnet":{"oneOf":[{"$ref":"#/components/schemas/magic_ip-address"},{"$ref":"#/components/schemas/magic_cidr"}]},"magic_acl_deleted_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_acl"}}}]},"magic_acl_modified_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_acl"}}}]},"magic_acl_single_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_acl"}}}]},"magic_acl_update_request":{"properties":{"description":{"description":"Description for the ACL.","example":"Allows local traffic between PIN pads and cash register.","type":"string"},"forward_locally":{"$ref":"#/components/schemas/magic_forward_locally"},"lan_1":{"$ref":"#/components/schemas/magic_lan-acl-configuration"},"lan_2":{"$ref":"#/components/schemas/magic_lan-acl-configuration"},"name":{"description":"The name of the ACL.","example":"PIN Pad - Cash Register","type":"string"},"protocols":{"items":{"description":"Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.","enum":["tcp","udp","icmp"],"type":"string"},"type":"array"},"unidirectional":{"$ref":"#/components/schemas/magic_unidirectional"}},"type":"object"},"magic_acls_add_single_request":{"description":"Bidirectional ACL policy for local network traffic within a site.","properties":{"description":{"description":"Description for the ACL.","example":"Allows local traffic between PIN pads and cash register.","type":"string"},"forward_locally":{"$ref":"#/components/schemas/magic_forward_locally"},"lan_1":{"$ref":"#/components/schemas/magic_lan-acl-configuration"},"lan_2":{"$ref":"#/components/schemas/magic_lan-acl-configuration"},"name":{"description":"The name of the ACL.","example":"PIN Pad - Cash Register","type":"string"},"protocols":{"items":{"description":"Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.","enum":["tcp","udp","icmp"],"type":"string"},"type":"array"},"unidirectional":{"$ref":"#/components/schemas/magic_unidirectional"}},"required":["name","lan_1","lan_2"],"type":"object"},"magic_acls_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/magic_acl"},"type":"array"}}}]},"magic_allow_null_cipher":{"description":"When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2).","example":true,"type":"boolean"},"magic_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/magic_messages"},"messages":{"$ref":"#/components/schemas/magic_messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"magic_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/magic_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/magic_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"magic_api-response-single":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-common"},{"properties":{"result":{"anyOf":[{"nullable":true,"type":"object"},{"nullable":true,"type":"string"}]}}}],"type":"object"},"magic_app":{"description":"Collection of Hostnames and/or IP Subnets to associate with traffic decisions.","oneOf":[{"$ref":"#/components/schemas/magic_account_app"},{"$ref":"#/components/schemas/magic_managed_app"}],"type":"object"},"magic_app_add_single_request":{"anyOf":[{"required":["hostnames"],"title":"Hostnames"},{"required":["ip_subnets"],"title":"Subnets"}],"properties":{"hostnames":{"$ref":"#/components/schemas/magic_app_hostnames"},"ip_subnets":{"$ref":"#/components/schemas/magic_app_subnets"},"name":{"$ref":"#/components/schemas/magic_app_name"},"type":{"$ref":"#/components/schemas/magic_app_type"}},"required":["name","type"],"type":"object"},"magic_app_breakout":{"description":"Whether to breakout traffic to the app's endpoints directly. Null preserves default behavior.","example":true,"type":"boolean"},"magic_app_breakout_preferred_wans":{"description":"WAN interfaces to prefer over default WANs, highest-priority first. Can only be specified for breakout rules (breakout must be true).","items":{"$ref":"#/components/schemas/magic_identifier"},"type":"array"},"magic_app_config":{"allOf":[{"properties":{"breakout":{"$ref":"#/components/schemas/magic_app_breakout"},"id":{"$ref":"#/components/schemas/magic_identifier"},"preferred_wans":{"$ref":"#/components/schemas/magic_app_breakout_preferred_wans"},"priority":{"$ref":"#/components/schemas/magic_app_priority"},"site_id":{"$ref":"#/components/schemas/magic_identifier"}},"required":["id","site_id"]},{"oneOf":[{"properties":{"account_app_id":{"$ref":"#/components/schemas/magic_account_app_id"}},"required":["account_app_id"],"title":"Account App"},{"properties":{"managed_app_id":{"$ref":"#/components/schemas/magic_managed_app_id"}},"required":["managed_app_id"],"title":"Managed App"}]}],"description":"Traffic decision configuration for an app.","type":"object"},"magic_app_config_add_single_request":{"allOf":[{"oneOf":[{"properties":{"account_app_id":{"$ref":"#/components/schemas/magic_account_app_id"}},"required":["account_app_id"],"title":"Account App"},{"properties":{"managed_app_id":{"$ref":"#/components/schemas/magic_managed_app_id"}},"required":["managed_app_id"],"title":"Managed App"}]},{"anyOf":[{"required":["breakout"],"title":"Breakout"},{"required":["priority"],"title":"Prioritize"}]},{"properties":{"breakout":{"$ref":"#/components/schemas/magic_app_breakout"},"preferred_wans":{"$ref":"#/components/schemas/magic_app_breakout_preferred_wans"},"priority":{"$ref":"#/components/schemas/magic_app_priority"}}}],"type":"object"},"magic_app_config_single_response":{"allOf":[{"$ref":"#/components/schemas/magic_apps-response-object"},{"properties":{"result":{"$ref":"#/components/schemas/magic_app_config"}}}]},"magic_app_config_update_request":{"properties":{"account_app_id":{"$ref":"#/components/schemas/magic_account_app_id"},"breakout":{"$ref":"#/components/schemas/magic_app_breakout"},"managed_app_id":{"$ref":"#/components/schemas/magic_managed_app_id"},"preferred_wans":{"$ref":"#/components/schemas/magic_app_breakout_preferred_wans"},"priority":{"$ref":"#/components/schemas/magic_app_priority"}},"type":"object"},"magic_app_configs_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic_apps-response-object"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/magic_app_config"},"type":"array"}}}]},"magic_app_hostnames":{"description":"FQDNs to associate with traffic decisions.","items":{"example":"auth.cloudflare.com","type":"string"},"type":"array"},"magic_app_name":{"description":"Display name for the app.","example":"Cloudflare Dashboard","type":"string"},"magic_app_priority":{"description":"Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)","maximum":1,"minimum":0,"type":"integer"},"magic_app_single_response":{"allOf":[{"$ref":"#/components/schemas/magic_apps-response-object"},{"properties":{"result":{"$ref":"#/components/schemas/magic_account_app"}}}]},"magic_app_subnets":{"description":"IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported)","items":{"allOf":[{"$ref":"#/components/schemas/magic_cidr"},{"example":"1.1.1.1/32"}]},"type":"array"},"magic_app_type":{"description":"Category of the app.","example":"Development","type":"string"},"magic_app_update_request":{"anyOf":[{"required":["name"],"title":"Update App Name"},{"required":["type"],"title":"Update App Type"},{"required":["hostnames"],"title":"Update App Hostnames"},{"required":["ip_subnets"],"title":"Update App Subnets"}],"properties":{"hostnames":{"$ref":"#/components/schemas/magic_app_hostnames"},"ip_subnets":{"$ref":"#/components/schemas/magic_app_subnets"},"name":{"$ref":"#/components/schemas/magic_app_name"},"type":{"$ref":"#/components/schemas/magic_app_type"}},"type":"object"},"magic_apps-response-array":{"properties":{"errors":{"$ref":"#/components/schemas/magic_messages"},"messages":{"$ref":"#/components/schemas/magic_messages"},"result":{"items":{},"nullable":true,"type":"array"},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"magic_apps-response-object":{"properties":{"errors":{"$ref":"#/components/schemas/magic_messages"},"messages":{"$ref":"#/components/schemas/magic_messages"},"result":{"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"magic_apps_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic_apps-response-array"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/magic_app"},"type":"array"}}}]},"magic_automatic_return_routing":{"default":false,"description":"True if automatic stateful return routing should be enabled for a tunnel, false otherwise.","example":true,"type":"boolean","x-auditable":true},"magic_bgp_config":{"properties":{"customer_asn":{"description":"ASN used on the customer end of the BGP session","format":"int32","minimum":0,"type":"integer"},"extra_prefixes":{"description":"Prefixes in this list will be advertised to the customer device, in addition to the routes in the Magic routing table.","items":{"format":"cidr","type":"string"},"type":"array"},"md5_key":{"description":"MD5 key to use for session authentication.\n\nNote that *this is not a security measure*. MD5 is not a valid security mechanism, and the\nkey is not treated as a secret value. This is *only* supported for preventing\nmisconfiguration, not for defending against malicious attacks.\n\nThe MD5 key, if set, must be of non-zero length and consist only of the following types of\ncharacter:\n\n* ASCII alphanumerics: `[a-zA-Z0-9]`\n* Special characters in the set `'!@#$%^\u0026*()+[]{}\u003c\u003e/.,;:_-~`= \\|`\n\nIn other words, MD5 keys may contain any printable ASCII character aside from newline (0x0A),\nquotation mark (`\"`), vertical tab (0x0B), carriage return (0x0D), tab (0x09), form feed\n(0x0C), and the question mark (`?`). Requests specifying an MD5 key with one or more of\nthese disallowed characters will be rejected.","type":"string"}},"required":["customer_asn"],"type":"object"},"magic_bgp_status_with_state":{"properties":{"bgp_state":{"type":"string"},"cf_speaker_ip":{"format":"ipv4","type":"string"},"cf_speaker_port":{"maximum":65535,"minimum":1,"type":"integer"},"customer_speaker_ip":{"format":"ipv4","type":"string"},"customer_speaker_port":{"maximum":65535,"minimum":1,"type":"integer"},"state":{"enum":["BGP_DOWN","BGP_UP","BGP_ESTABLISHING"],"type":"string"},"tcp_established":{"type":"boolean"},"updated_at":{"format":"date-time","type":"string"}},"required":["state","tcp_established","updated_at"],"type":"object"},"magic_cidr":{"description":"A valid CIDR notation representing an IP range.","example":"192.0.2.0/24","type":"string"},"magic_cloudflare_gre_endpoint":{"description":"The IP address assigned to the Cloudflare side of the GRE tunnel.","example":"203.0.113.1","type":"string","x-auditable":true},"magic_cloudflare_ipsec_endpoint":{"description":"The IP address assigned to the Cloudflare side of the IPsec tunnel.","example":"203.0.113.1","type":"string"},"magic_colo_name":{"description":"Scope colo name.","example":"den01","type":"string","x-auditable":true},"magic_colo_names":{"description":"List of colo names for the ECMP scope.","items":{"$ref":"#/components/schemas/magic_colo_name"},"type":"array"},"magic_colo_region":{"description":"Scope colo region.","example":"APAC","type":"string","x-auditable":true},"magic_colo_regions":{"description":"List of colo regions for the ECMP scope.","items":{"$ref":"#/components/schemas/magic_colo_region"},"type":"array","x-auditable":true},"magic_components-schemas-description":{"description":"An optional description forthe IPsec tunnel.","example":"Tunnel for ISP X","type":"string"},"magic_components-schemas-modified_tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_interconnects":{"items":{"$ref":"#/components/schemas/magic_interconnect"},"type":"array"}}}}}]},"magic_components-schemas-name":{"description":"The name of the interconnect. The name cannot share a name with other tunnels.","example":"pni_ord","type":"string"},"magic_components-schemas-tunnel_modified_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_interconnect":{"$ref":"#/components/schemas/magic_interconnect"}},"type":"object"}}}]},"magic_components-schemas-tunnel_single_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"interconnect":{"$ref":"#/components/schemas/magic_interconnect"}},"type":"object"}}}]},"magic_components-schemas-tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"interconnects":{"items":{"$ref":"#/components/schemas/magic_interconnect"},"type":"array"}}}}}]},"magic_connector-id":{"description":"Magic Connector identifier tag.","example":"ac60d3d0435248289d446cedd870bcf4","type":"string","x-auditable":true},"magic_create_gre_tunnel_request":{"properties":{"automatic_return_routing":{"$ref":"#/components/schemas/magic_automatic_return_routing"},"bgp":{"$ref":"#/components/schemas/magic_bgp_config"},"cloudflare_gre_endpoint":{"$ref":"#/components/schemas/magic_cloudflare_gre_endpoint"},"customer_gre_endpoint":{"$ref":"#/components/schemas/magic_customer_gre_endpoint"},"description":{"$ref":"#/components/schemas/magic_schemas-description"},"health_check":{"$ref":"#/components/schemas/magic_tunnel_health_check"},"interface_address":{"$ref":"#/components/schemas/magic_interface_address"},"interface_address6":{"$ref":"#/components/schemas/magic_interface_address6"},"mtu":{"$ref":"#/components/schemas/magic_mtu"},"name":{"$ref":"#/components/schemas/magic_gre_tunnel_name"},"ttl":{"$ref":"#/components/schemas/magic_ttl"}},"required":["name","customer_gre_endpoint","cloudflare_gre_endpoint","interface_address"],"type":"object"},"magic_create_gre_tunnel_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_gre-tunnel"}}}]},"magic_create_route_request":{"properties":{"description":{"$ref":"#/components/schemas/magic_description"},"nexthop":{"$ref":"#/components/schemas/magic_nexthop"},"prefix":{"$ref":"#/components/schemas/magic_prefix"},"priority":{"$ref":"#/components/schemas/magic_priority"},"scope":{"$ref":"#/components/schemas/magic_scope"},"weight":{"$ref":"#/components/schemas/magic_weight"}},"required":["prefix","nexthop","priority"],"type":"object"},"magic_create_route_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_route"}}}]},"magic_created_on":{"description":"When the route was created.","example":"2017-06-14T00:00:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"magic_custom_remote_identities":{"properties":{"fqdn_id":{"description":"A custom IKE ID of type FQDN that may be used to identity the IPsec tunnel. The\ngenerated IKE IDs can still be used even if this custom value is specified.\n\nMust be of the form `\u003ccustom label\u003e.\u003caccount ID\u003e.custom.ipsec.cloudflare.com`.\n\nThis custom ID does not need to be unique. Two IPsec tunnels may have the same custom \nfqdn_id. However, if another IPsec tunnel has the same value then the two tunnels \ncannot have the same cloudflare_endpoint.","type":"string"}},"type":"object"},"magic_customer_gre_endpoint":{"description":"The IP address assigned to the customer side of the GRE tunnel.","example":"203.0.113.1","type":"string","x-auditable":true},"magic_customer_ipsec_endpoint":{"description":"The IP address assigned to the customer side of the IPsec tunnel. Not required, but must be set for proactive traceroutes to work.","example":"203.0.113.1","type":"string"},"magic_description":{"description":"An optional human provided description of the static route.","example":"New route for new prefix 203.0.113.1","type":"string","x-auditable":true},"magic_forward_locally":{"description":"The desired forwarding action for this ACL policy. If set to \"false\", the policy will forward traffic to Cloudflare. If set to \"true\", the policy will forward traffic locally on the Magic Connector. If not included in request, will default to false.","type":"boolean"},"magic_gre":{"description":"The configuration specific to GRE interconnects.","properties":{"cloudflare_endpoint":{"description":"The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect.","example":"203.0.113.1","type":"string"}},"type":"object"},"magic_gre-tunnel":{"properties":{"automatic_return_routing":{"$ref":"#/components/schemas/magic_automatic_return_routing"},"bgp":{"$ref":"#/components/schemas/magic_bgp_config"},"bgp_status":{"$ref":"#/components/schemas/magic_bgp_status_with_state"},"cloudflare_gre_endpoint":{"$ref":"#/components/schemas/magic_cloudflare_gre_endpoint"},"created_on":{"$ref":"#/components/schemas/magic_schemas-created_on"},"customer_gre_endpoint":{"$ref":"#/components/schemas/magic_customer_gre_endpoint"},"description":{"$ref":"#/components/schemas/magic_schemas-description"},"health_check":{"$ref":"#/components/schemas/magic_tunnel_health_check"},"id":{"$ref":"#/components/schemas/magic_schemas-identifier"},"interface_address":{"$ref":"#/components/schemas/magic_interface_address"},"interface_address6":{"$ref":"#/components/schemas/magic_interface_address6"},"modified_on":{"$ref":"#/components/schemas/magic_schemas-modified_on"},"mtu":{"$ref":"#/components/schemas/magic_mtu"},"name":{"$ref":"#/components/schemas/magic_gre_tunnel_name"},"ttl":{"$ref":"#/components/schemas/magic_ttl"}},"required":["id","name","customer_gre_endpoint","cloudflare_gre_endpoint","interface_address"],"type":"object"},"magic_gre_tunnel_add_single_request":{"properties":{"automatic_return_routing":{"$ref":"#/components/schemas/magic_automatic_return_routing"},"cloudflare_gre_endpoint":{"$ref":"#/components/schemas/magic_cloudflare_gre_endpoint"},"customer_gre_endpoint":{"$ref":"#/components/schemas/magic_customer_gre_endpoint"},"description":{"$ref":"#/components/schemas/magic_schemas-description"},"health_check":{"$ref":"#/components/schemas/magic_tunnel_health_check"},"interface_address":{"$ref":"#/components/schemas/magic_interface_address"},"interface_address6":{"$ref":"#/components/schemas/magic_interface_address6"},"mtu":{"$ref":"#/components/schemas/magic_mtu"},"name":{"$ref":"#/components/schemas/magic_gre_tunnel_name"},"ttl":{"$ref":"#/components/schemas/magic_ttl"}},"required":["name","customer_gre_endpoint","cloudflare_gre_endpoint","interface_address"],"type":"object"},"magic_gre_tunnel_name":{"description":"The name of the tunnel. The name cannot contain spaces or special characters, must be 15 characters or less, and cannot share a name with another GRE tunnel.","example":"GRE_1","type":"string","x-auditable":true},"magic_gre_tunnel_update_request":{"allOf":[{"$ref":"#/components/schemas/magic_gre_tunnel_add_single_request"}]},"magic_health_check_base":{"properties":{"enabled":{"default":true,"description":"Determines whether to run healthchecks for a tunnel.","example":true,"type":"boolean","x-auditable":true},"rate":{"default":"mid","description":"How frequent the health check is run. The default value is `mid`.","enum":["low","mid","high"],"example":"low","type":"string","x-auditable":true},"target":{"description":"The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.","oneOf":[{"$ref":"#/components/schemas/magic_health_check_target"},{"type":"string"}]},"type":{"default":"reply","description":"The type of healthcheck to run, reply or request. The default value is `reply`.","enum":["reply","request"],"example":"request","type":"string","x-auditable":true}},"type":"object"},"magic_health_check_target":{"description":"The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.","properties":{"effective":{"description":"The effective health check target. If 'saved' is empty, then this field will be populated with the calculated default value on GET requests. Ignored in POST, PUT, and PATCH requests.","example":"203.0.113.1","readOnly":true,"type":"string","x-auditable":true},"saved":{"description":"The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used.","example":"203.0.113.1","type":"string","x-auditable":true}},"type":"object"},"magic_identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"magic_interconnect":{"properties":{"automatic_return_routing":{"$ref":"#/components/schemas/magic_automatic_return_routing"},"colo_name":{"$ref":"#/components/schemas/magic_components-schemas-name"},"created_on":{"$ref":"#/components/schemas/magic_schemas-created_on"},"description":{"$ref":"#/components/schemas/magic_interconnect_components-schemas-description"},"gre":{"$ref":"#/components/schemas/magic_gre"},"health_check":{"$ref":"#/components/schemas/magic_interconnect_health_check"},"id":{"$ref":"#/components/schemas/magic_schemas-identifier"},"interface_address":{"$ref":"#/components/schemas/magic_interface_address"},"interface_address6":{"$ref":"#/components/schemas/magic_interface_address6"},"modified_on":{"$ref":"#/components/schemas/magic_schemas-modified_on"},"mtu":{"$ref":"#/components/schemas/magic_schemas-mtu"},"name":{"$ref":"#/components/schemas/magic_components-schemas-name"}},"type":"object"},"magic_interconnect_components-schemas-description":{"description":"An optional description of the interconnect.","example":"Tunnel for Interconnect to ORD","type":"string"},"magic_interconnect_health_check":{"$ref":"#/components/schemas/magic_health_check_base"},"magic_interconnect_tunnel_update_request":{"properties":{"automatic_return_routing":{"$ref":"#/components/schemas/magic_automatic_return_routing"},"description":{"$ref":"#/components/schemas/magic_interconnect_components-schemas-description"},"gre":{"$ref":"#/components/schemas/magic_gre"},"health_check":{"$ref":"#/components/schemas/magic_interconnect_health_check"},"interface_address":{"$ref":"#/components/schemas/magic_interface_address"},"interface_address6":{"$ref":"#/components/schemas/magic_interface_address6"},"mtu":{"$ref":"#/components/schemas/magic_schemas-mtu"}},"type":"object"},"magic_interface_address":{"description":"A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.","example":"192.0.2.0/31","type":"string","x-auditable":true},"magic_interface_address6":{"description":"A 127 bit IPV6 prefix from within the virtual_subnet6 prefix space with the address being the first IP of the subnet and not same as the address of virtual_subnet6. Eg if virtual_subnet6 is 2606:54c1:7:0:a9fe:12d2::/127 , interface_address6 could be 2606:54c1:7:0:a9fe:12d2:1:200/127","example":"2606:54c1:7:0:a9fe:12d2:1:200/127","type":"string","x-auditable":true},"magic_ip-address":{"description":"A valid IPv4 address.","example":"192.0.2.1","type":"string"},"magic_ipsec-tunnel":{"properties":{"allow_null_cipher":{"$ref":"#/components/schemas/magic_allow_null_cipher"},"automatic_return_routing":{"$ref":"#/components/schemas/magic_automatic_return_routing"},"bgp":{"$ref":"#/components/schemas/magic_bgp_config"},"bgp_status":{"$ref":"#/components/schemas/magic_bgp_status_with_state"},"cloudflare_endpoint":{"$ref":"#/components/schemas/magic_cloudflare_ipsec_endpoint"},"created_on":{"$ref":"#/components/schemas/magic_schemas-created_on"},"custom_remote_identities":{"$ref":"#/components/schemas/magic_custom_remote_identities"},"customer_endpoint":{"$ref":"#/components/schemas/magic_customer_ipsec_endpoint"},"description":{"$ref":"#/components/schemas/magic_components-schemas-description"},"health_check":{"$ref":"#/components/schemas/magic_tunnel_health_check"},"id":{"$ref":"#/components/schemas/magic_schemas-identifier"},"interface_address":{"$ref":"#/components/schemas/magic_interface_address"},"interface_address6":{"$ref":"#/components/schemas/magic_interface_address6"},"modified_on":{"$ref":"#/components/schemas/magic_schemas-modified_on"},"name":{"$ref":"#/components/schemas/magic_ipsec_tunnel_name"},"psk_metadata":{"$ref":"#/components/schemas/magic_psk_metadata"},"replay_protection":{"$ref":"#/components/schemas/magic_replay_protection"}},"required":["id","name","cloudflare_endpoint","interface_address"],"type":"object"},"magic_ipsec_tunnel_add_request":{"allOf":[{"$ref":"#/components/schemas/magic_ipsec_tunnel_add_single_request"}]},"magic_ipsec_tunnel_add_single_request":{"properties":{"automatic_return_routing":{"$ref":"#/components/schemas/magic_automatic_return_routing"},"bgp":{"$ref":"#/components/schemas/magic_bgp_config"},"cloudflare_endpoint":{"$ref":"#/components/schemas/magic_cloudflare_ipsec_endpoint"},"customer_endpoint":{"$ref":"#/components/schemas/magic_customer_ipsec_endpoint"},"description":{"$ref":"#/components/schemas/magic_components-schemas-description"},"health_check":{"$ref":"#/components/schemas/magic_tunnel_health_check"},"interface_address":{"$ref":"#/components/schemas/magic_interface_address"},"interface_address6":{"$ref":"#/components/schemas/magic_interface_address6"},"name":{"$ref":"#/components/schemas/magic_ipsec_tunnel_name"},"psk":{"$ref":"#/components/schemas/magic_psk"},"replay_protection":{"$ref":"#/components/schemas/magic_replay_protection"}},"required":["name","cloudflare_endpoint","interface_address"],"type":"object"},"magic_ipsec_tunnel_name":{"description":"The name of the IPsec tunnel. The name cannot share a name with other tunnels.","example":"IPsec_1","type":"string"},"magic_ipsec_tunnel_update_request":{"allOf":[{"$ref":"#/components/schemas/magic_ipsec_tunnel_add_single_request"}]},"magic_lan":{"properties":{"ha_link":{"description":"mark true to use this LAN for HA probing. only works for site with HA turned on. only one LAN can be set as the ha_link.","type":"boolean"},"id":{"$ref":"#/components/schemas/magic_identifier"},"name":{"type":"string"},"nat":{"$ref":"#/components/schemas/magic_nat"},"physport":{"$ref":"#/components/schemas/magic_port"},"routed_subnets":{"items":{"$ref":"#/components/schemas/magic_routed_subnet"},"type":"array"},"site_id":{"$ref":"#/components/schemas/magic_identifier"},"static_addressing":{"$ref":"#/components/schemas/magic_lan_static_addressing"},"vlan_tag":{"$ref":"#/components/schemas/magic_vlan_tag"}},"type":"object"},"magic_lan-acl-configuration":{"properties":{"lan_id":{"description":"The identifier for the LAN you want to create an ACL policy with.","type":"string"},"lan_name":{"description":"The name of the LAN based on the provided lan_id.","type":"string"},"port_ranges":{"description":"Array of port ranges on the provided LAN that will be included in the ACL. If no ports or port rangess are provided, communication on any port on this LAN is allowed.","items":{"$ref":"#/components/schemas/magic_acl-port-range"},"type":"array"},"ports":{"description":"Array of ports on the provided LAN that will be included in the ACL. If no ports or port ranges are provided, communication on any port on this LAN is allowed.","items":{"$ref":"#/components/schemas/magic_port"},"type":"array"},"subnets":{"description":"Array of subnet IPs within the LAN that will be included in the ACL. If no subnets are provided, communication on any subnets on this LAN are allowed.","items":{"$ref":"#/components/schemas/magic_acl-subnet"},"type":"array"}},"required":["lan_id"],"type":"object"},"magic_lan_deleted_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_lan"}}}]},"magic_lan_dhcp_relay":{"properties":{"server_addresses":{"description":"List of DHCP server IPs.","items":{"$ref":"#/components/schemas/magic_ip-address"},"type":"array"}},"type":"object"},"magic_lan_dhcp_server":{"properties":{"dhcp_pool_end":{"$ref":"#/components/schemas/magic_ip-address"},"dhcp_pool_start":{"$ref":"#/components/schemas/magic_ip-address"},"dns_server":{"$ref":"#/components/schemas/magic_ip-address"},"dns_servers":{"items":{"$ref":"#/components/schemas/magic_ip-address"},"type":"array"},"reservations":{"additionalProperties":{"description":"IP address associated with the MAC address","type":"string"},"description":"Mapping of MAC addresses to IP addresses","example":{"00:11:22:33:44:55":"192.0.2.100","AA:BB:CC:DD:EE:FF":"192.168.1.101"},"type":"object"}},"type":"object"},"magic_lan_modified_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_lan"}}}]},"magic_lan_single_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_lan"}}}]},"magic_lan_static_addressing":{"description":"If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, static_address is required along with secondary and virtual address.","properties":{"address":{"$ref":"#/components/schemas/magic_cidr"},"dhcp_relay":{"$ref":"#/components/schemas/magic_lan_dhcp_relay"},"dhcp_server":{"$ref":"#/components/schemas/magic_lan_dhcp_server"},"secondary_address":{"$ref":"#/components/schemas/magic_cidr"},"virtual_address":{"$ref":"#/components/schemas/magic_cidr"}},"required":["address"],"type":"object"},"magic_lan_update_request":{"properties":{"name":{"type":"string"},"nat":{"$ref":"#/components/schemas/magic_nat"},"physport":{"$ref":"#/components/schemas/magic_port"},"routed_subnets":{"items":{"$ref":"#/components/schemas/magic_routed_subnet"},"type":"array"},"static_addressing":{"$ref":"#/components/schemas/magic_lan_static_addressing"},"vlan_tag":{"$ref":"#/components/schemas/magic_vlan_tag"}},"type":"object"},"magic_lans_add_single_request":{"properties":{"ha_link":{"description":"mark true to use this LAN for HA probing. only works for site with HA turned on. only one LAN can be set as the ha_link.","type":"boolean"},"name":{"type":"string"},"nat":{"$ref":"#/components/schemas/magic_nat"},"physport":{"$ref":"#/components/schemas/magic_port"},"routed_subnets":{"items":{"$ref":"#/components/schemas/magic_routed_subnet"},"type":"array"},"static_addressing":{"$ref":"#/components/schemas/magic_lan_static_addressing"},"vlan_tag":{"$ref":"#/components/schemas/magic_vlan_tag"}},"required":["physport"],"type":"object"},"magic_lans_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/magic_lan"},"type":"array"}}}]},"magic_managed_app":{"description":"Managed app defined by Cloudflare.","properties":{"hostnames":{"$ref":"#/components/schemas/magic_app_hostnames"},"ip_subnets":{"$ref":"#/components/schemas/magic_app_subnets"},"managed_app_id":{"$ref":"#/components/schemas/magic_managed_app_id"},"name":{"$ref":"#/components/schemas/magic_app_name"},"type":{"$ref":"#/components/schemas/magic_app_type"}},"required":["managed_app_id"],"title":"Managed App","type":"object"},"magic_managed_app_id":{"description":"Managed app ID.","example":"cloudflare","type":"string"},"magic_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"magic_modified_on":{"description":"When the route was last modified.","example":"2017-06-14T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"magic_modified_tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_gre_tunnels":{"items":{"$ref":"#/components/schemas/magic_gre-tunnel"},"type":"array"}}}}}]},"magic_mtu":{"default":1476,"description":"Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576.","type":"integer","x-auditable":true},"magic_multiple_route_delete_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"deleted":{"example":true,"type":"boolean"},"deleted_routes":{"items":{"$ref":"#/components/schemas/magic_route"},"type":"array"}}}}}]},"magic_multiple_route_modified_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_routes":{"items":{"$ref":"#/components/schemas/magic_route"},"type":"array"}}}}}]},"magic_nat":{"properties":{"static_prefix":{"$ref":"#/components/schemas/magic_cidr"}},"type":"object"},"magic_netflow_config":{"description":"NetFlow configuration for a site.","properties":{"active_timeout":{"description":"Timeout in seconds for active flows (defaults to 30).","example":30,"maximum":5400,"minimum":1,"type":"integer"},"collector_ip":{"description":"IPv4 address of the NetFlow collector.","example":"162.159.65.1","type":"string"},"collector_port":{"description":"UDP port of the NetFlow collector (defaults to 2055).","example":2055,"maximum":65535,"minimum":1,"type":"integer"},"inactive_timeout":{"description":"Timeout in seconds for inactive flows (defaults to 15).","example":15,"maximum":5400,"minimum":1,"type":"integer"},"sampling_rate":{"description":"Sampling rate for NetFlow records (1 = every packet, 1000 = 1 in 1000 packets). Defaults to 1.","example":100,"maximum":10000,"minimum":1,"type":"integer"}},"required":["collector_ip"],"type":"object"},"magic_netflow_config_request":{"properties":{"active_timeout":{"description":"Timeout in seconds for active flows.","example":30,"maximum":5400,"minimum":1,"type":"integer"},"collector_ip":{"description":"IPv4 address of the NetFlow collector.","example":"162.159.65.1","type":"string"},"collector_port":{"description":"UDP port of the NetFlow collector.","example":2055,"maximum":65535,"minimum":1,"type":"integer"},"inactive_timeout":{"description":"Timeout in seconds for inactive flows.","example":15,"maximum":5400,"minimum":1,"type":"integer"},"sampling_rate":{"description":"Sampling rate for NetFlow records (1 = every packet).","example":100,"maximum":10000,"minimum":1,"type":"integer"}},"type":"object"},"magic_netflow_config_single_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_netflow_config"}}}]},"magic_nexthop":{"description":"The next-hop IP Address for the static route.","example":"203.0.113.1","type":"string","x-auditable":true},"magic_port":{"example":1,"type":"integer"},"magic_prefix":{"description":"IP Prefix in Classless Inter-Domain Routing format.","example":"192.0.2.0/24","type":"string","x-auditable":true},"magic_priority":{"description":"Priority of the static route.","type":"integer","x-auditable":true},"magic_psk":{"description":"A randomly generated or provided string for use in the IPsec tunnel.","example":"O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy","type":"string"},"magic_psk_generation_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"ipsec_tunnel_id":{"$ref":"#/components/schemas/magic_identifier"},"psk":{"$ref":"#/components/schemas/magic_psk"},"psk_metadata":{"$ref":"#/components/schemas/magic_psk_metadata"}}}}}]},"magic_psk_metadata":{"description":"The PSK metadata that includes when the PSK was generated.","properties":{"last_generated_on":{"$ref":"#/components/schemas/magic_schemas-modified_on"}},"type":"object"},"magic_replay_protection":{"default":false,"description":"If `true`, then IPsec replay protection will be supported in the Cloudflare-to-customer direction.","example":false,"type":"boolean"},"magic_route":{"properties":{"created_on":{"$ref":"#/components/schemas/magic_created_on"},"description":{"$ref":"#/components/schemas/magic_description"},"id":{"$ref":"#/components/schemas/magic_identifier"},"modified_on":{"$ref":"#/components/schemas/magic_modified_on"},"nexthop":{"$ref":"#/components/schemas/magic_nexthop"},"prefix":{"$ref":"#/components/schemas/magic_prefix"},"priority":{"$ref":"#/components/schemas/magic_priority"},"scope":{"$ref":"#/components/schemas/magic_scope"},"weight":{"$ref":"#/components/schemas/magic_weight"}},"required":["id","prefix","nexthop","priority"],"type":"object"},"magic_route_add_single_request":{"properties":{"description":{"$ref":"#/components/schemas/magic_description"},"nexthop":{"$ref":"#/components/schemas/magic_nexthop"},"prefix":{"$ref":"#/components/schemas/magic_prefix"},"priority":{"$ref":"#/components/schemas/magic_priority"},"scope":{"$ref":"#/components/schemas/magic_scope"},"weight":{"$ref":"#/components/schemas/magic_weight"}},"required":["prefix","nexthop","priority"],"type":"object"},"magic_route_delete_id":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/magic_identifier"}},"required":["id"]}]},"magic_route_delete_many_request":{"properties":{"routes":{"items":{"$ref":"#/components/schemas/magic_route_delete_id"},"type":"array"}},"required":["routes"],"type":"object"},"magic_route_deleted_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"deleted":{"example":true,"type":"boolean"},"deleted_route":{"$ref":"#/components/schemas/magic_route"}},"type":"object"}}}]},"magic_route_modified_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_route":{"$ref":"#/components/schemas/magic_route"}},"type":"object"}}}]},"magic_route_single_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"route":{"$ref":"#/components/schemas/magic_route"}},"type":"object"}}}]},"magic_route_update_many_request":{"properties":{"routes":{"items":{"$ref":"#/components/schemas/magic_route_update_single_request"},"type":"array"}},"required":["routes"],"type":"object"},"magic_route_update_request":{"allOf":[{"$ref":"#/components/schemas/magic_route_add_single_request"}]},"magic_route_update_single_request":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/magic_identifier"}},"required":["id"]},{"$ref":"#/components/schemas/magic_route_add_single_request"}]},"magic_routed_subnet":{"properties":{"nat":{"$ref":"#/components/schemas/magic_nat"},"next_hop":{"$ref":"#/components/schemas/magic_ip-address"},"prefix":{"$ref":"#/components/schemas/magic_cidr"}},"required":["prefix","next_hop"],"type":"object"},"magic_routes_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"routes":{"items":{"$ref":"#/components/schemas/magic_route"},"type":"array"}}}}}]},"magic_schemas-create_ipsec_tunnel_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_ipsec-tunnel"}}}]},"magic_schemas-created_on":{"description":"The date and time the tunnel was created.","example":"2017-06-14T00:00:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"magic_schemas-description":{"description":"An optional description of the GRE tunnel.","example":"Tunnel for ISP X","type":"string","x-auditable":true},"magic_schemas-identifier":{"description":"Identifier","example":"c4a7362d577a6c3019a474fd6f485821","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"magic_schemas-modified_on":{"description":"The date and time the tunnel was last modified.","example":"2017-06-14T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"magic_schemas-modified_tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_ipsec_tunnels":{"items":{"$ref":"#/components/schemas/magic_ipsec-tunnel"},"type":"array"}}}}}]},"magic_schemas-mtu":{"default":1476,"description":"The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576.","type":"integer"},"magic_schemas-tunnel_deleted_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"deleted":{"example":true,"type":"boolean"},"deleted_ipsec_tunnel":{"$ref":"#/components/schemas/magic_ipsec-tunnel"}},"type":"object"}}}]},"magic_schemas-tunnel_modified_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_ipsec_tunnel":{"$ref":"#/components/schemas/magic_ipsec-tunnel"}},"type":"object"}}}]},"magic_schemas-tunnel_single_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"ipsec_tunnel":{"$ref":"#/components/schemas/magic_ipsec-tunnel"}},"type":"object"}}}]},"magic_schemas-tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"ipsec_tunnels":{"items":{"$ref":"#/components/schemas/magic_ipsec-tunnel"},"type":"array"}}}}}]},"magic_scope":{"description":"Used only for ECMP routes.","properties":{"colo_names":{"$ref":"#/components/schemas/magic_colo_names"},"colo_regions":{"$ref":"#/components/schemas/magic_colo_regions"}},"type":"object"},"magic_secondary-connector-id":{"description":"Magic Connector identifier tag. Used when high availability mode is on.","example":"8d67040d3835dbcf46ce29da440dc482","type":"string","x-auditable":true},"magic_site":{"properties":{"connector_id":{"$ref":"#/components/schemas/magic_connector-id"},"description":{"type":"string"},"ha_mode":{"description":"Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode.","example":true,"type":"boolean"},"id":{"$ref":"#/components/schemas/magic_identifier"},"location":{"$ref":"#/components/schemas/magic_site-location"},"name":{"$ref":"#/components/schemas/magic_site-name"},"secondary_connector_id":{"$ref":"#/components/schemas/magic_secondary-connector-id"}},"type":"object"},"magic_site-location":{"description":"Location of site in latitude and longitude.","properties":{"lat":{"description":"Latitude","example":37.6192,"type":"string","x-auditable":true},"lon":{"description":"Longitude","example":122.3816,"type":"string","x-auditable":true}},"type":"object"},"magic_site-name":{"description":"The name of the site.","example":"site_1","type":"string","x-auditable":true},"magic_site_deleted_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_site"}}}]},"magic_site_modified_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_site"}}}]},"magic_site_single_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_site"}}}]},"magic_site_update_request":{"properties":{"connector_id":{"$ref":"#/components/schemas/magic_connector-id"},"description":{"type":"string"},"location":{"$ref":"#/components/schemas/magic_site-location"},"name":{"$ref":"#/components/schemas/magic_site-name"},"secondary_connector_id":{"$ref":"#/components/schemas/magic_secondary-connector-id"}},"type":"object"},"magic_sites_add_single_request":{"properties":{"connector_id":{"$ref":"#/components/schemas/magic_connector-id"},"description":{"type":"string"},"ha_mode":{"description":"Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode.","example":true,"type":"boolean"},"location":{"$ref":"#/components/schemas/magic_site-location"},"name":{"$ref":"#/components/schemas/magic_site-name"},"secondary_connector_id":{"$ref":"#/components/schemas/magic_secondary-connector-id"}},"required":["name"],"type":"object"},"magic_sites_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/magic_site"},"type":"array"}}}]},"magic_ttl":{"default":64,"description":"Time To Live (TTL) in number of hops of the GRE tunnel.","type":"integer","x-auditable":true},"magic_tunnel_deleted_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"deleted":{"example":true,"type":"boolean"},"deleted_gre_tunnel":{"$ref":"#/components/schemas/magic_gre-tunnel"}},"type":"object"}}}]},"magic_tunnel_health_check":{"allOf":[{"$ref":"#/components/schemas/magic_health_check_base"},{"properties":{"direction":{"default":"unidirectional","description":"The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.","enum":["unidirectional","bidirectional"],"example":"bidirectional","type":"string"}}}]},"magic_tunnel_modified_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_gre_tunnel":{"$ref":"#/components/schemas/magic_gre-tunnel"}},"type":"object"}}}]},"magic_tunnel_single_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"gre_tunnel":{"$ref":"#/components/schemas/magic_gre-tunnel"}},"type":"object"}}}]},"magic_tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"properties":{"gre_tunnels":{"items":{"$ref":"#/components/schemas/magic_gre-tunnel"},"type":"array"}}}}}]},"magic_unidirectional":{"description":"The desired traffic direction for this ACL policy. If set to \"false\", the policy will allow bidirectional traffic. If set to \"true\", the policy will only allow traffic in one direction. If not included in request, will default to false.","type":"boolean"},"magic_vlan_tag":{"description":"VLAN ID. Use zero for untagged.","example":42,"type":"integer","x-auditable":true},"magic_wan":{"properties":{"health_check_rate":{"default":"mid","description":"Magic WAN health check rate for tunnels created on this link. The default value is `mid`.","enum":["low","mid","high"],"example":"low","type":"string"},"id":{"$ref":"#/components/schemas/magic_identifier"},"name":{"type":"string"},"physport":{"$ref":"#/components/schemas/magic_port"},"priority":{"description":"Priority of WAN for traffic loadbalancing.","type":"integer"},"site_id":{"$ref":"#/components/schemas/magic_identifier"},"static_addressing":{"$ref":"#/components/schemas/magic_wan_static_addressing"},"vlan_tag":{"$ref":"#/components/schemas/magic_vlan_tag"}},"type":"object"},"magic_wan_deleted_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_wan"}}}]},"magic_wan_modified_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_wan"}}}]},"magic_wan_single_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/magic_wan"}}}]},"magic_wan_static_addressing":{"description":"(optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode.","properties":{"address":{"$ref":"#/components/schemas/magic_cidr"},"gateway_address":{"$ref":"#/components/schemas/magic_ip-address"},"secondary_address":{"$ref":"#/components/schemas/magic_cidr"}},"required":["address","gateway_address"],"type":"object"},"magic_wan_update_request":{"properties":{"name":{"type":"string"},"physport":{"$ref":"#/components/schemas/magic_port"},"priority":{"type":"integer"},"static_addressing":{"$ref":"#/components/schemas/magic_wan_static_addressing"},"vlan_tag":{"$ref":"#/components/schemas/magic_vlan_tag"}},"type":"object"},"magic_wans_add_single_request":{"properties":{"name":{"type":"string"},"physport":{"$ref":"#/components/schemas/magic_port"},"priority":{"type":"integer"},"static_addressing":{"$ref":"#/components/schemas/magic_wan_static_addressing"},"vlan_tag":{"$ref":"#/components/schemas/magic_vlan_tag"}},"required":["physport"],"type":"object"},"magic_wans_collection_response":{"allOf":[{"$ref":"#/components/schemas/magic_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/magic_wan"},"type":"array"}}}]},"magic_weight":{"description":"Optional weight of the ECMP scope - if provided.","type":"integer","x-auditable":true},"mcn_account_id":{"type":"string","x-auditable":true},"mcn_apply_progress":{"properties":{"done":{"type":"integer","x-auditable":true},"total":{"type":"integer","x-auditable":true}},"required":["done","total"],"type":"object"},"mcn_aws_trust_policy":{"properties":{"aws_trust_policy":{"type":"string"},"item_type":{"type":"string","x-auditable":true}},"required":["item_type","aws_trust_policy"],"type":"object"},"mcn_azure_setup":{"properties":{"azure_consent_url":{"type":"string"},"integration_identity_tag":{"type":"string","x-auditable":true},"item_type":{"type":"string","x-auditable":true},"tag_cli_command":{"type":"string"}},"required":["item_type","azure_consent_url","integration_identity_tag","tag_cli_command"],"type":"object"},"mcn_bad_response":{"allOf":[{"$ref":"#/components/schemas/mcn_response"},{"properties":{"errors":{"items":{"$ref":"#/components/schemas/mcn_error"},"minLength":1,"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"}},"type":"object"}],"type":"object"},"mcn_catalog_sync":{"properties":{"description":{"type":"string"},"destination_id":{"$ref":"#/components/schemas/mcn_catalog_sync_destination_id"},"destination_type":{"$ref":"#/components/schemas/mcn_catalog_sync_destination_type"},"errors":{"additionalProperties":{"$ref":"#/components/schemas/mcn_error"},"type":"object"},"id":{"$ref":"#/components/schemas/mcn_catalog_sync_id"},"includes_discoveries_until":{"type":"string"},"last_attempted_update_at":{"type":"string"},"last_successful_update_at":{"type":"string"},"last_user_update_at":{"type":"string"},"name":{"type":"string"},"policy":{"type":"string"},"update_mode":{"$ref":"#/components/schemas/mcn_catalog_sync_update_mode"}},"required":["id","name","description","policy","destination_type","destination_id","destination_url","update_mode","last_user_update_at"],"type":"object"},"mcn_catalog_sync_destination_id":{"format":"uuid","type":"string","x-auditable":true},"mcn_catalog_sync_destination_type":{"enum":["NONE","ZERO_TRUST_LIST"],"type":"string","x-auditable":true},"mcn_catalog_sync_id":{"format":"uuid","type":"string"},"mcn_catalog_sync_update_mode":{"enum":["AUTO","MANUAL"],"type":"string","x-auditable":true},"mcn_catalog_syncs_prebuilt_policies_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mcn_catalog_syncs_prebuilt_policy"},"type":"array"}},"type":"object"}],"type":"object"},"mcn_catalog_syncs_prebuilt_policy":{"properties":{"applicable_destinations":{"items":{"$ref":"#/components/schemas/mcn_catalog_sync_destination_type"},"type":"array"},"policy_description":{"type":"string"},"policy_name":{"type":"string"},"policy_string":{"type":"string"}},"required":["policy_name","policy_description","policy_string","applicable_destinations"],"type":"object"},"mcn_cidr_prefix":{"description":"An IP address prefix in CIDR format.","example":"192.168.0.0/16","type":"string","x-auditable":true},"mcn_cloud_platform_client":{"properties":{"client_type":{"enum":["MAGIC_WAN_CLOUD_ONRAMP"],"type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/mcn_platform_client_id"},"name":{"type":"string","x-auditable":true}},"required":["client_type","name","id"],"type":"object"},"mcn_cloud_type":{"enum":["AWS","AZURE","GOOGLE","CLOUDFLARE"],"type":"string","x-auditable":true},"mcn_conduit_route_id":{"format":"uuid","type":"string","x-auditable":true},"mcn_conduit_tunnel_id":{"format":"uuid","type":"string","x-auditable":true},"mcn_cost":{"properties":{"currency":{"type":"string","x-auditable":true},"monthly_cost":{"format":"double","type":"number"}},"required":["monthly_cost","currency"],"type":"object"},"mcn_cost_diff":{"properties":{"currency":{"type":"string","x-auditable":true},"current_monthly_cost":{"format":"double","type":"number"},"diff":{"format":"double","type":"number"},"proposed_monthly_cost":{"format":"double","type":"number"}},"required":["current_monthly_cost","proposed_monthly_cost","diff","currency"],"type":"object"},"mcn_create_catalog_sync_request":{"properties":{"description":{"type":"string"},"destination_type":{"$ref":"#/components/schemas/mcn_catalog_sync_destination_type"},"name":{"type":"string"},"policy":{"type":"string"},"update_mode":{"$ref":"#/components/schemas/mcn_catalog_sync_update_mode"}},"required":["name","update_mode","destination_type"],"type":"object"},"mcn_create_catalog_sync_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_catalog_sync"}},"type":"object"}],"type":"object"},"mcn_create_onramp_request":{"properties":{"adopted_hub_id":{"$ref":"#/components/schemas/mcn_resource_id"},"attached_hubs":{"items":{"$ref":"#/components/schemas/mcn_resource_id"},"type":"array"},"attached_vpcs":{"items":{"$ref":"#/components/schemas/mcn_resource_id"},"type":"array"},"cloud_type":{"$ref":"#/components/schemas/mcn_onramp_cloud_type"},"description":{"type":"string"},"hub_provider_id":{"$ref":"#/components/schemas/mcn_provider_id"},"install_routes_in_cloud":{"type":"boolean","x-auditable":true},"install_routes_in_magic_wan":{"type":"boolean","x-auditable":true},"manage_hub_to_hub_attachments":{"type":"boolean","x-auditable":true},"manage_vpc_to_hub_attachments":{"type":"boolean","x-auditable":true},"name":{"type":"string"},"region":{"type":"string","x-auditable":true},"type":{"$ref":"#/components/schemas/mcn_onramp_type"},"vpc":{"$ref":"#/components/schemas/mcn_resource_id"}},"required":["name","type","cloud_type","install_routes_in_cloud","install_routes_in_magic_wan"],"type":"object"},"mcn_create_onramp_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_onramp"}},"type":"object"}],"type":"object"},"mcn_create_provider_request":{"properties":{"cloud_type":{"$ref":"#/components/schemas/mcn_cloud_type"},"description":{"type":"string","x-auditable":true},"friendly_name":{"type":"string","x-auditable":true}},"required":["friendly_name","cloud_type"],"type":"object"},"mcn_create_provider_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_provider"}},"type":"object"}],"type":"object"},"mcn_delete_catalog_sync_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_deleted_catalog_sync"}},"type":"object"}],"type":"object"},"mcn_delete_onramp_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_deleted_onramp"}},"type":"object"}],"type":"object"},"mcn_delete_provider_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_deleted_provider"}},"type":"object"}],"type":"object"},"mcn_delete_resource_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_deleted_resource"}},"type":"object"}],"type":"object"},"mcn_deleted_catalog_sync":{"properties":{"id":{"$ref":"#/components/schemas/mcn_catalog_sync_id"}},"required":["id"],"type":"object"},"mcn_deleted_onramp":{"properties":{"id":{"$ref":"#/components/schemas/mcn_onramp_id"}},"required":["id"],"type":"object"},"mcn_deleted_provider":{"properties":{"id":{"$ref":"#/components/schemas/mcn_provider_id"}},"required":["id"],"type":"object"},"mcn_deleted_resource":{"properties":{"id":{"$ref":"#/components/schemas/mcn_resource_id"}},"required":["id"],"type":"object"},"mcn_error":{"properties":{"code":{"enum":[1001,1002,1003,1004,1005,1006,1007,1008,1009,1010,1011,1012,1013,1014,1015,1016,1017,2001,2002,2003,2004,2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016,2017,2018,2019,2020,2021,2022,3001,3002,3003,3004,3005,3006,3007,4001,4002,4003,4004,4005,4006,4007,4008,4009,4010,4011,4012,4013,4014,4015,4016,4017,4018,4019,4020,4021,4022,4023,5001,5002,5003,5004,102000,102001,102002,102003,102004,102005,102006,102007,102008,102009,102010,102011,102012,102013,102014,102015,102016,102017,102018,102019,102020,102021,102022,102023,102024,102025,102026,102027,102028,102029,102030,102031,102032,102033,102034,102035,102036,102037,102038,102039,102040,102041,102042,102043,102044,102045,102046,102047,102048,102049,102050,102051,102052,102053,102054,102055,102056,102057,102058,102059,102060,102061,102062,102063,102064,102065,102066,103001,103002,103003,103004,103005,103006,103007,103008],"type":"integer","x-auditable":true},"documentation_url":{"type":"string"},"message":{"type":"string"},"meta":{"$ref":"#/components/schemas/mcn_error_meta"},"source":{"$ref":"#/components/schemas/mcn_error_source"}},"required":["code","message"],"type":"object"},"mcn_error_meta":{"properties":{"l10n_key":{"type":"string","x-auditable":true},"loggable_error":{"type":"string"},"template_data":{"type":"object"},"trace_id":{"type":"string","x-auditable":true}},"type":"object"},"mcn_error_source":{"properties":{"parameter":{"type":"string","x-auditable":true},"parameter_value_index":{"type":"integer","x-auditable":true},"pointer":{"type":"string","x-auditable":true}},"type":"object"},"mcn_gcp_setup":{"properties":{"integration_identity_tag":{"type":"string","x-auditable":true},"item_type":{"type":"string","x-auditable":true},"tag_cli_command":{"type":"string"}},"required":["item_type","integration_identity_tag","tag_cli_command"],"type":"object"},"mcn_get_magic_wan_address_space_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_magic_wan_address_space"}},"type":"object"}],"type":"object"},"mcn_get_onramp_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_onramp"}},"type":"object"}],"type":"object"},"mcn_good_response":{"allOf":[{"$ref":"#/components/schemas/mcn_response"},{"properties":{"errors":{"items":{"$ref":"#/components/schemas/mcn_error"},"maxLength":0,"type":"array"}},"type":"object"}],"type":"object"},"mcn_good_response_collection":{"allOf":[{"$ref":"#/components/schemas/mcn_response_collection"},{"properties":{"errors":{"items":{"$ref":"#/components/schemas/mcn_error"},"maxLength":0,"type":"array"}},"type":"object"}],"type":"object"},"mcn_list_item":{"properties":{"item_type":{"type":"string"},"list":{"items":{"discriminator":{"propertyName":"item_type"},"oneOf":[{"$ref":"#/components/schemas/mcn_string_item"},{"$ref":"#/components/schemas/mcn_resource_preview_item"}],"type":"object"},"type":"array"}},"required":["item_type","list"],"type":"object"},"mcn_list_onramps_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mcn_onramp"},"type":"array"}},"type":"object"}],"type":"object"},"mcn_magic_wan_address_space":{"properties":{"prefixes":{"items":{"$ref":"#/components/schemas/mcn_cidr_prefix"},"type":"array"}},"required":["prefixes"],"type":"object"},"mcn_observation":{"properties":{"first_observed_at":{"type":"string","x-auditable":true},"last_observed_at":{"type":"string","x-auditable":true},"provider_id":{"$ref":"#/components/schemas/mcn_provider_id"},"resource_id":{"$ref":"#/components/schemas/mcn_resource_id"}},"required":["provider_id","resource_id","first_observed_at","last_observed_at"],"type":"object"},"mcn_onramp":{"properties":{"attached_hubs":{"items":{"$ref":"#/components/schemas/mcn_resource_id"},"type":"array"},"attached_vpcs":{"items":{"$ref":"#/components/schemas/mcn_resource_id"},"type":"array"},"cloud_type":{"$ref":"#/components/schemas/mcn_onramp_cloud_type"},"description":{"type":"string","x-auditable":true},"hub":{"$ref":"#/components/schemas/mcn_resource_id"},"id":{"$ref":"#/components/schemas/mcn_onramp_id"},"install_routes_in_cloud":{"type":"boolean","x-auditable":true},"install_routes_in_magic_wan":{"type":"boolean","x-auditable":true},"last_applied_at":{"type":"string","x-auditable":true},"last_exported_at":{"type":"string","x-auditable":true},"last_planned_at":{"type":"string","x-auditable":true},"manage_hub_to_hub_attachments":{"type":"boolean","x-auditable":true},"manage_vpc_to_hub_attachments":{"type":"boolean","x-auditable":true},"name":{"type":"string","x-auditable":true},"planned_monthly_cost_estimate":{"$ref":"#/components/schemas/mcn_cost_diff"},"planned_resources":{"items":{"$ref":"#/components/schemas/mcn_resource_diff"},"type":"array"},"planned_resources_unavailable":{"type":"boolean","x-auditable":true},"post_apply_monthly_cost_estimate":{"$ref":"#/components/schemas/mcn_cost"},"post_apply_resources":{"additionalProperties":{"$ref":"#/components/schemas/mcn_resource_details"},"type":"object"},"post_apply_resources_unavailable":{"type":"boolean","x-auditable":true},"region":{"type":"string","x-auditable":true},"status":{"$ref":"#/components/schemas/mcn_onramp_status"},"type":{"$ref":"#/components/schemas/mcn_onramp_type"},"updated_at":{"type":"string"},"vpc":{"$ref":"#/components/schemas/mcn_resource_id"},"vpcs_by_id":{"additionalProperties":{"$ref":"#/components/schemas/mcn_resource_details"},"type":"object"},"vpcs_by_id_unavailable":{"description":"The list of vpc IDs for which resource details failed to generate.","items":{"$ref":"#/components/schemas/mcn_resource_id"},"type":"array"}},"required":["id","name","type","cloud_type","install_routes_in_cloud","install_routes_in_magic_wan","updated_at"],"type":"object"},"mcn_onramp_cloud_type":{"enum":["AWS","AZURE","GOOGLE"],"type":"string","x-auditable":true},"mcn_onramp_id":{"format":"uuid","type":"string","x-auditable":true},"mcn_onramp_lifecycle_state":{"enum":["OnrampNeedsApply","OnrampPendingPlan","OnrampPlanning","OnrampPlanFailed","OnrampPendingApproval","OnrampPendingApply","OnrampApplying","OnrampApplyFailed","OnrampActive","OnrampPendingDestroy","OnrampDestroying","OnrampDestroyFailed"],"type":"string","x-auditable":true},"mcn_onramp_status":{"properties":{"apply_progress":{"$ref":"#/components/schemas/mcn_apply_progress"},"lifecycle_errors":{"additionalProperties":{"$ref":"#/components/schemas/mcn_error"},"type":"object"},"lifecycle_state":{"$ref":"#/components/schemas/mcn_onramp_lifecycle_state"},"plan_progress":{"$ref":"#/components/schemas/mcn_plan_progress"},"routes":{"items":{"$ref":"#/components/schemas/mcn_conduit_route_id"},"type":"array"},"tunnels":{"items":{"$ref":"#/components/schemas/mcn_conduit_tunnel_id"},"type":"array"}},"required":["lifecycle_state","tunnels","routes","plan_progress","apply_progress"],"type":"object"},"mcn_onramp_type":{"enum":["OnrampTypeSingle","OnrampTypeHub"],"type":"string","x-auditable":true},"mcn_onramp_with_account":{"allOf":[{"$ref":"#/components/schemas/mcn_onramp"},{"properties":{"account_id":{"$ref":"#/components/schemas/mcn_account_id"}},"required":["account_id"],"type":"object"}],"type":"object"},"mcn_plan_progress":{"properties":{"done":{"type":"integer","x-auditable":true},"total":{"type":"integer","x-auditable":true}},"required":["done","total"],"type":"object"},"mcn_planned_action":{"enum":["no_op","create","update","replace","destroy"],"type":"string","x-auditable":true},"mcn_platform_client_id":{"format":"uuid","type":"string","x-auditable":true},"mcn_policy_result":{"type":"string"},"mcn_provider":{"properties":{"aws_arn":{"type":"string","x-auditable":true},"azure_subscription_id":{"type":"string","x-auditable":true},"azure_tenant_id":{"type":"string","x-auditable":true},"cloud_type":{"$ref":"#/components/schemas/mcn_cloud_type"},"description":{"type":"string"},"friendly_name":{"type":"string"},"gcp_project_id":{"type":"string","x-auditable":true},"gcp_service_account_email":{"type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/mcn_provider_id"},"last_updated":{"type":"string","x-auditable":true},"lifecycle_state":{"$ref":"#/components/schemas/mcn_provider_lifecycle_state"},"state":{"$ref":"#/components/schemas/mcn_provider_discovery_status"},"state_v2":{"$ref":"#/components/schemas/mcn_provider_discovery_status"},"status":{"$ref":"#/components/schemas/mcn_provider_status"}},"required":["id","friendly_name","cloud_type","last_updated","state","state_v2","lifecycle_state"],"type":"object"},"mcn_provider_discovery_progress":{"properties":{"done":{"type":"integer","x-auditable":true},"total":{"type":"integer","x-auditable":true},"unit":{"type":"string","x-auditable":true}},"required":["unit","done","total"],"type":"object"},"mcn_provider_discovery_status":{"enum":["UNSPECIFIED","PENDING","DISCOVERING","FAILED","SUCCEEDED"],"type":"string","x-auditable":true},"mcn_provider_id":{"format":"uuid","type":"string","x-auditable":true},"mcn_provider_initial_setup_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"discriminator":{"propertyName":"item_type"},"oneOf":[{"$ref":"#/components/schemas/mcn_aws_trust_policy"},{"$ref":"#/components/schemas/mcn_azure_setup"},{"$ref":"#/components/schemas/mcn_gcp_setup"}],"type":"object"}},"type":"object"}],"type":"object"},"mcn_provider_lifecycle_state":{"enum":["ACTIVE","PENDING_SETUP","RETIRED"],"type":"string","x-auditable":true},"mcn_provider_status":{"properties":{"credentials_good_since":{"type":"string","x-auditable":true},"credentials_missing_since":{"type":"string","x-auditable":true},"credentials_rejected_since":{"type":"string","x-auditable":true},"discovery_message":{"type":"string","x-auditable":true},"discovery_message_v2":{"type":"string","x-auditable":true},"discovery_progress":{"$ref":"#/components/schemas/mcn_provider_discovery_progress"},"discovery_progress_v2":{"$ref":"#/components/schemas/mcn_provider_discovery_progress"},"in_use_by":{"items":{"$ref":"#/components/schemas/mcn_cloud_platform_client"},"type":"array"},"last_discovery_completed_at":{"type":"string","x-auditable":true},"last_discovery_completed_at_v2":{"type":"string","x-auditable":true},"last_discovery_started_at":{"type":"string","x-auditable":true},"last_discovery_started_at_v2":{"type":"string","x-auditable":true},"last_discovery_status":{"$ref":"#/components/schemas/mcn_provider_discovery_status"},"last_discovery_status_v2":{"$ref":"#/components/schemas/mcn_provider_discovery_status"},"last_updated":{"type":"string","x-auditable":true},"regions":{"items":{"type":"string","x-auditable":true},"type":"array"}},"required":["last_discovery_status","last_discovery_status_v2","regions","discovery_status","discovery_status_v2","discovery_progress","discovery_progress_v2"],"type":"object"},"mcn_provider_with_account":{"allOf":[{"$ref":"#/components/schemas/mcn_provider"},{"properties":{"account_id":{"$ref":"#/components/schemas/mcn_account_id"}},"required":["account_id"],"type":"object"}],"type":"object"},"mcn_read_account_catalog_sync_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_catalog_sync"}},"type":"object"}],"type":"object"},"mcn_read_account_catalog_syncs_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mcn_catalog_sync"},"type":"array"}},"type":"object"}],"type":"object"},"mcn_read_account_provider_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_provider"}},"type":"object"}],"type":"object"},"mcn_read_account_providers_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mcn_provider"},"type":"array"}},"type":"object"}],"type":"object"},"mcn_read_account_resource_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_resource_details"}},"type":"object"}],"type":"object"},"mcn_read_account_resources_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response_collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mcn_resource_details"},"type":"array"},"result_info":{"$ref":"#/components/schemas/mcn_result_info"}},"type":"object"}],"type":"object"},"mcn_refresh_catalog_sync_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_policy_result"}},"type":"object"}],"type":"object"},"mcn_resource_details":{"properties":{"account_id":{"$ref":"#/components/schemas/mcn_account_id"},"cloud_type":{"$ref":"#/components/schemas/mcn_cloud_type"},"config":{"additionalProperties":true,"type":"object"},"deployment_provider":{"$ref":"#/components/schemas/mcn_provider_id"},"id":{"$ref":"#/components/schemas/mcn_resource_id"},"managed":{"type":"boolean","x-auditable":true},"managed_by":{"items":{"$ref":"#/components/schemas/mcn_cloud_platform_client"},"type":"array"},"monthly_cost_estimate":{"$ref":"#/components/schemas/mcn_cost"},"name":{"type":"string"},"native_id":{"type":"string"},"observations":{"additionalProperties":{"$ref":"#/components/schemas/mcn_observation"},"type":"object"},"provider_ids":{"items":{"$ref":"#/components/schemas/mcn_provider_id"},"type":"array"},"provider_names_by_id":{"additionalProperties":{"type":"string"},"type":"object"},"region":{"type":"string","x-auditable":true},"resource_group":{"type":"string","x-auditable":true},"resource_type":{"$ref":"#/components/schemas/mcn_resource_type"},"sections":{"items":{"$ref":"#/components/schemas/mcn_resource_details_section"},"type":"array"},"state":{"additionalProperties":true,"type":"object"},"tags":{"additionalProperties":{"type":"string"},"type":"object"},"updated_at":{"type":"string"},"url":{"type":"string"}},"required":["id","native_id","name","account_id","cloud_type","resource_type","managed","provider_ids","provider_names_by_id","region","resource_group","tags","updated_at","url","config","state","observations","deployment_provider","sections","monthly_cost_estimate"],"type":"object"},"mcn_resource_details_section":{"properties":{"help_text":{"type":"string"},"hidden_items":{"items":{"$ref":"#/components/schemas/mcn_resource_details_section_item"},"type":"array"},"name":{"type":"string"},"visible_items":{"items":{"$ref":"#/components/schemas/mcn_resource_details_section_item"},"type":"array"}},"required":["name","visible_items","hidden_items"],"type":"object"},"mcn_resource_details_section_item":{"properties":{"helpText":{"type":"string"},"name":{"type":"string"},"value":{"discriminator":{"propertyName":"item_type"},"oneOf":[{"$ref":"#/components/schemas/mcn_string_item"},{"$ref":"#/components/schemas/mcn_yaml_item"},{"$ref":"#/components/schemas/mcn_yaml_diff_item"},{"$ref":"#/components/schemas/mcn_resource_preview_item"},{"$ref":"#/components/schemas/mcn_list_item"}],"type":"object"}},"type":"object"},"mcn_resource_diff":{"properties":{"diff":{"$ref":"#/components/schemas/mcn_yaml_diff"},"keys_require_replace":{"items":{"type":"string"},"type":"array"},"monthly_cost_estimate_diff":{"$ref":"#/components/schemas/mcn_cost_diff"},"planned_action":{"$ref":"#/components/schemas/mcn_planned_action"},"resource":{"$ref":"#/components/schemas/mcn_resource_preview"}},"required":["resource","diff","planned_action","keys_require_replace","monthly_cost_estimate_diff"],"type":"object"},"mcn_resource_id":{"format":"uuid","type":"string","x-auditable":true},"mcn_resource_preview":{"properties":{"cloud_type":{"$ref":"#/components/schemas/mcn_cloud_type"},"detail":{"type":"string"},"id":{"$ref":"#/components/schemas/mcn_resource_id"},"name":{"type":"string"},"resource_type":{"$ref":"#/components/schemas/mcn_resource_type"},"title":{"type":"string"}},"required":["id","cloud_type","resource_type","name","title","detail"],"type":"object"},"mcn_resource_preview_item":{"properties":{"item_type":{"type":"string","x-auditable":true},"resource_preview":{"$ref":"#/components/schemas/mcn_resource_preview"}},"required":["item_type","resource_preview"],"type":"object"},"mcn_resource_type":{"enum":["aws_customer_gateway","aws_egress_only_internet_gateway","aws_internet_gateway","aws_instance","aws_network_interface","aws_route","aws_route_table","aws_route_table_association","aws_subnet","aws_vpc","aws_vpc_ipv4_cidr_block_association","aws_vpn_connection","aws_vpn_connection_route","aws_vpn_gateway","aws_security_group","aws_vpc_security_group_ingress_rule","aws_vpc_security_group_egress_rule","aws_ec2_managed_prefix_list","aws_ec2_transit_gateway","aws_ec2_transit_gateway_prefix_list_reference","aws_ec2_transit_gateway_vpc_attachment","azurerm_application_security_group","azurerm_lb","azurerm_lb_backend_address_pool","azurerm_lb_nat_pool","azurerm_lb_nat_rule","azurerm_lb_rule","azurerm_local_network_gateway","azurerm_network_interface","azurerm_network_interface_application_security_group_association","azurerm_network_interface_backend_address_pool_association","azurerm_network_interface_security_group_association","azurerm_network_security_group","azurerm_public_ip","azurerm_route","azurerm_route_table","azurerm_subnet","azurerm_subnet_route_table_association","azurerm_virtual_machine","azurerm_virtual_network_gateway_connection","azurerm_virtual_network","azurerm_virtual_network_gateway","google_compute_network","google_compute_subnetwork","google_compute_vpn_gateway","google_compute_vpn_tunnel","google_compute_route","google_compute_address","google_compute_global_address","google_compute_router","google_compute_interconnect_attachment","google_compute_ha_vpn_gateway","google_compute_forwarding_rule","google_compute_network_firewall_policy","google_compute_network_firewall_policy_rule","cloudflare_static_route","cloudflare_ipsec_tunnel"],"type":"string","x-auditable":true},"mcn_resources_catalog_policy_preview":{"type":"string"},"mcn_resources_catalog_policy_preview_request":{"properties":{"policy":{"type":"string"}},"required":["policy"],"type":"object"},"mcn_resources_catalog_policy_preview_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_resources_catalog_policy_preview"}},"type":"object"}],"type":"object"},"mcn_response":{"properties":{"messages":{"items":{"$ref":"#/components/schemas/mcn_error"},"type":"array"},"success":{"type":"boolean","x-auditable":true}},"required":["result","success","errors","messages"],"type":"object"},"mcn_response_collection":{"properties":{"messages":{"items":{"$ref":"#/components/schemas/mcn_error"},"type":"array"},"result_info":{"$ref":"#/components/schemas/mcn_result_info"},"success":{"type":"boolean"}},"required":["result","success","errors","messages"],"type":"object"},"mcn_result_info":{"properties":{"count":{"description":"The number of items in the current result set.","example":1,"type":"integer"},"page":{"description":"The current page (starts from zero).","example":1,"type":"integer"},"per_page":{"description":"The maximum numnber of items per page.","example":20,"type":"integer"},"total_count":{"description":"The total number of items in the entire result set.","example":2000,"type":"integer"},"total_pages":{"description":"The number of total pages in the entire result set.","example":200,"type":"integer"}},"required":["page","per_page","count","total_count"],"type":"object"},"mcn_string_item":{"properties":{"item_type":{"type":"string"},"string":{"type":"string"}},"required":["item_type","string"],"type":"object"},"mcn_update_catalog_sync_request":{"properties":{"description":{"type":"string"},"name":{"type":"string"},"policy":{"type":"string"},"update_mode":{"$ref":"#/components/schemas/mcn_catalog_sync_update_mode"}},"type":"object"},"mcn_update_catalog_sync_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_catalog_sync"}},"type":"object"}],"type":"object"},"mcn_update_magic_wan_address_space_request":{"properties":{"prefixes":{"items":{"$ref":"#/components/schemas/mcn_cidr_prefix"},"type":"array"}},"required":["prefixes"],"type":"object"},"mcn_update_magic_wan_address_space_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_magic_wan_address_space"}},"type":"object"}],"type":"object"},"mcn_update_onramp_request":{"properties":{"attached_hubs":{"items":{"$ref":"#/components/schemas/mcn_resource_id"},"type":"array"},"attached_vpcs":{"items":{"$ref":"#/components/schemas/mcn_resource_id"},"type":"array"},"description":{"type":"string"},"install_routes_in_cloud":{"type":"boolean","x-auditable":true},"install_routes_in_magic_wan":{"type":"boolean"},"manage_hub_to_hub_attachments":{"type":"boolean"},"manage_vpc_to_hub_attachments":{"type":"boolean"},"name":{"type":"string"},"vpc":{"$ref":"#/components/schemas/mcn_resource_id"}},"type":"object"},"mcn_update_onramp_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_onramp"}},"type":"object"}],"type":"object"},"mcn_update_provider_request":{"properties":{"aws_arn":{"type":"string","x-auditable":true},"azure_subscription_id":{"type":"string","x-auditable":true},"azure_tenant_id":{"type":"string","x-auditable":true},"description":{"type":"string","x-auditable":true},"friendly_name":{"type":"string","x-auditable":true},"gcp_project_id":{"type":"string","x-auditable":true},"gcp_service_account_email":{"type":"string","x-auditable":true}},"type":"object"},"mcn_update_provider_response":{"allOf":[{"$ref":"#/components/schemas/mcn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mcn_provider"}},"type":"object"}],"type":"object"},"mcn_yaml_diff":{"properties":{"diff":{"type":"string"},"left_description":{"type":"string"},"left_yaml":{"type":"string"},"right_description":{"type":"string"},"right_yaml":{"type":"string"}},"required":["left_yaml","left_description","right_yaml","right_description","diff"],"type":"object"},"mcn_yaml_diff_item":{"properties":{"item_type":{"type":"string"},"yaml_diff":{"$ref":"#/components/schemas/mcn_yaml_diff"}},"required":["item_type","yaml_diff"],"type":"object"},"mcn_yaml_item":{"properties":{"item_type":{"type":"string"},"yaml":{"type":"string"}},"required":["item_type","yaml"],"type":"object"},"mconn_account_id":{"description":"Account identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"mconn_admin_cohort":{"properties":{"desired_version":{"type":"string"},"id":{"$ref":"#/components/schemas/mconn_uuid"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"mconn_admin_cohort_create_request":{"$ref":"#/components/schemas/mconn_admin_cohort_fields"},"mconn_admin_cohort_create_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_cohort"}},"type":"object"}],"type":"object"},"mconn_admin_cohort_delete_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_cohort"}},"type":"object"}],"type":"object"},"mconn_admin_cohort_fetch_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_cohort"}},"type":"object"}],"type":"object"},"mconn_admin_cohort_fields":{"properties":{"desired_version":{"type":"string"},"name":{"type":"string"}},"type":"object"},"mconn_admin_cohort_list_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mconn_admin_cohort"},"type":"array"}},"type":"object"}],"type":"object"},"mconn_admin_cohort_replace_request":{"$ref":"#/components/schemas/mconn_admin_cohort_fields"},"mconn_admin_cohort_replace_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_cohort"}},"type":"object"}],"type":"object"},"mconn_admin_cohort_update_request":{"$ref":"#/components/schemas/mconn_admin_cohort_fields"},"mconn_admin_cohort_update_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_cohort"}},"type":"object"}],"type":"object"},"mconn_admin_connector":{"properties":{"account_id":{"$ref":"#/components/schemas/mconn_account_id"},"activated":{"type":"boolean"},"cloudflared_tunnel_id":{"type":"string"},"cloudflared_tunnel_token":{"type":"string"},"cohort_id":{"$ref":"#/components/schemas/mconn_uuid"},"desired_version":{"type":"string"},"device_id":{"$ref":"#/components/schemas/mconn_uuid"},"id":{"$ref":"#/components/schemas/mconn_uuid"},"interrupt_window_duration_hours":{"type":"number"},"interrupt_window_hour_of_day":{"type":"number"},"last_heartbeat":{"type":"string"},"last_seen_version":{"type":"string"},"last_updated":{"type":"string"},"notes":{"type":"string"},"timezone":{"type":"string"},"upgrade_asap":{"type":"boolean"}},"required":["id","account_id","notes","activated","last_updated","timezone","interrupt_window_hour_of_day","interrupt_window_duration_hours","upgrade_asap"],"type":"object"},"mconn_admin_connector_create_request":{"$ref":"#/components/schemas/mconn_admin_connector_fields"},"mconn_admin_connector_create_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_connector"}},"type":"object"}],"type":"object"},"mconn_admin_connector_delete_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_connector"}},"type":"object"}],"type":"object"},"mconn_admin_connector_fetch_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_connector"}},"type":"object"}],"type":"object"},"mconn_admin_connector_fields":{"properties":{"account_id":{"type":"number"},"activated":{"type":"boolean"},"cloudflared_tunnel_id":{"type":"string"},"cloudflared_tunnel_token":{"type":"string"},"cohort_id":{"type":"string"},"desired_version":{"type":"string"},"device_id":{"type":"string"},"interrupt_window_duration_hours":{"type":"number"},"interrupt_window_hour_of_day":{"type":"number"},"last_heartbeat":{"type":"string"},"last_seen_version":{"type":"string"},"last_updated":{"type":"string"},"notes":{"type":"string"},"timezone":{"type":"string"},"upgrade_asap":{"type":"boolean"}},"type":"object"},"mconn_admin_connector_list_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mconn_admin_connector"},"type":"array"}},"type":"object"}],"type":"object"},"mconn_admin_connector_replace_request":{"$ref":"#/components/schemas/mconn_admin_connector_fields"},"mconn_admin_connector_replace_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_connector"}},"type":"object"}],"type":"object"},"mconn_admin_connector_update_request":{"$ref":"#/components/schemas/mconn_admin_connector_fields"},"mconn_admin_connector_update_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_connector"}},"type":"object"}],"type":"object"},"mconn_admin_device":{"properties":{"crypt_key":{"type":"string","x-sensitive":true},"crypt_key_rotation_finished_at":{"type":"string"},"crypt_key_rotation_output":{"type":"string"},"crypt_key_rotation_started_at":{"type":"string"},"crypt_key_rotation_status_code":{"type":"number"},"device_type":{"type":"string"},"ek_cert":{"type":"string"},"id":{"$ref":"#/components/schemas/mconn_uuid"},"imaged_at":{"type":"string"},"last_crypt_key":{"type":"string","x-sensitive":true},"last_updated":{"type":"string"},"license_key_sha256":{"type":"string"},"metadata":{"type":"string"},"pki_rotation_finished_at":{"type":"string"},"pki_rotation_output":{"type":"string"},"pki_rotation_started_at":{"type":"string"},"pki_rotation_status_code":{"type":"number"},"serial_number":{"type":"string"}},"required":["id","metadata","crypt_key","last_updated"],"type":"object"},"mconn_admin_device_create_request":{"$ref":"#/components/schemas/mconn_admin_device_fields"},"mconn_admin_device_create_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_device"}},"type":"object"}],"type":"object"},"mconn_admin_device_credential":{"properties":{"device_id":{"$ref":"#/components/schemas/mconn_uuid"},"id":{"$ref":"#/components/schemas/mconn_uuid"},"provisioned_at":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"required":["id","device_id","type","provisioned_at","value"],"type":"object"},"mconn_admin_device_credential_list_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mconn_admin_device_credential"},"type":"array"}},"type":"object"}],"type":"object"},"mconn_admin_device_delete_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_device"}},"type":"object"}],"type":"object"},"mconn_admin_device_fetch_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_device"}},"type":"object"}],"type":"object"},"mconn_admin_device_fields":{"properties":{"crypt_key":{"type":"string","x-sensitive":true},"crypt_key_rotation_finished_at":{"type":"string"},"crypt_key_rotation_output":{"type":"string"},"crypt_key_rotation_started_at":{"type":"string"},"crypt_key_rotation_status_code":{"type":"number"},"device_type":{"type":"string"},"ek_cert":{"type":"string"},"imaged_at":{"type":"string"},"last_crypt_key":{"type":"string","x-sensitive":true},"last_updated":{"type":"string"},"license_key_sha256":{"type":"string"},"metadata":{"type":"string"},"pki_rotation_finished_at":{"type":"string"},"pki_rotation_output":{"type":"string"},"pki_rotation_started_at":{"type":"string"},"pki_rotation_status_code":{"type":"number"},"serial_number":{"type":"string"}},"type":"object"},"mconn_admin_device_list_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mconn_admin_device"},"type":"array"}},"type":"object"}],"type":"object"},"mconn_admin_device_replace_request":{"$ref":"#/components/schemas/mconn_admin_device_fields"},"mconn_admin_device_replace_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_device"}},"type":"object"}],"type":"object"},"mconn_admin_device_update_request":{"$ref":"#/components/schemas/mconn_admin_device_fields"},"mconn_admin_device_update_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_device"}},"type":"object"}],"type":"object"},"mconn_admin_event_get_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_recorded_event"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_admin_events_get_latest_result":{"properties":{"count":{"type":"number"},"items":{"items":{"$ref":"#/components/schemas/mconn_recorded_event"},"type":"array"}},"required":["items","count"],"type":"object"},"mconn_admin_events_get_latest_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_events_get_latest_result"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_admin_events_get_result":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/mconn_event_metadata"},"type":"array"}},"required":["items","count"],"type":"object"},"mconn_admin_events_get_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_events_get_result"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_admin_flare":{"properties":{"id":{"$ref":"#/components/schemas/mconn_uuid"},"triggered_at":{"type":"string"}},"required":["id","triggered_at"],"type":"object"},"mconn_admin_flare_replace_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_flare"}},"type":"object"}],"type":"object"},"mconn_admin_macros_diagnose_connector_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_macros_diagnose_connector_result"}},"type":"object"}],"type":"object"},"mconn_admin_macros_diagnose_connector_result":{"properties":{"connector":{"$ref":"#/components/schemas/mconn_admin_connector"},"device":{"$ref":"#/components/schemas/mconn_admin_device"},"site":{"$ref":"#/components/schemas/mconn_admin_site"}},"type":"object"},"mconn_admin_macros_provision_licensed_connector_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_macros_provision_licensed_connector_result"}},"type":"object"}],"type":"object"},"mconn_admin_macros_provision_licensed_connector_result":{"properties":{"connector":{"$ref":"#/components/schemas/mconn_admin_connector"},"device":{"$ref":"#/components/schemas/mconn_admin_device"},"license_key":{"type":"string"}},"required":["license_key","device","connector"],"type":"object"},"mconn_admin_macros_provision_physical_connector_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_macros_provision_physical_connector_result"}},"type":"object"}],"type":"object"},"mconn_admin_macros_provision_physical_connector_result":{"properties":{"connector":{"$ref":"#/components/schemas/mconn_admin_connector"}},"required":["connector"],"type":"object"},"mconn_admin_macros_report_exception_result":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"mconn_admin_macros_report_exception_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_macros_report_exception_result"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_admin_site":{"properties":{"id":{"$ref":"#/components/schemas/mconn_uuid"}},"required":["id"],"type":"object"},"mconn_admin_snapshot_get_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_snapshot"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_admin_snapshots_get_latest_result":{"properties":{"count":{"type":"number"},"items":{"items":{"$ref":"#/components/schemas/mconn_snapshot"},"type":"array"}},"required":["items","count"],"type":"object"},"mconn_admin_snapshots_get_latest_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_snapshots_get_latest_result"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_admin_snapshots_get_result":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/mconn_snapshot_metadata"},"type":"array"}},"required":["items","count"],"type":"object"},"mconn_admin_snapshots_get_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_snapshots_get_result"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_admin_upgrade_slot":{"properties":{"connector_id":{"$ref":"#/components/schemas/mconn_uuid"},"id":{"type":"number"},"started_at":{"type":"string"}},"required":["id"],"type":"object"},"mconn_admin_upgrade_slots_fetch_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mconn_admin_upgrade_slot"},"type":"array"}},"type":"object"}],"type":"object"},"mconn_admin_upgrade_slots_replace_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mconn_admin_upgrade_slot"},"type":"array"}},"type":"object"}],"type":"object"},"mconn_bad_response":{"allOf":[{"$ref":"#/components/schemas/mconn_response"},{"properties":{"errors":{"items":{"$ref":"#/components/schemas/mconn_coded_message"},"minLength":1,"type":"array"},"result":{"$ref":"#/components/schemas/mconn_none"}},"type":"object"}],"type":"object"},"mconn_coded_message":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"mconn_conduit_connector":{"properties":{"account_id":{"$ref":"#/components/schemas/mconn_account_id"}},"required":["account_id"],"type":"object"},"mconn_conduit_fetch_connector_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_conduit_fetch_connector_result"}},"type":"object"}],"type":"object"},"mconn_conduit_fetch_connector_result":{"$ref":"#/components/schemas/mconn_conduit_connector"},"mconn_connector_events_post_result":{"properties":{"count":{"type":"number"}},"required":["count"],"type":"object"},"mconn_connector_events_post_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_connector_events_post_result"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_connector_snapshots_post_result":{"properties":{"count":{"type":"number"}},"required":["count"],"type":"object"},"mconn_connector_snapshots_post_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_connector_snapshots_post_result"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_controller_attestation_session":{"properties":{"ak_public":{"type":"string"},"connector":{"$ref":"#/components/schemas/mconn_controller_connector_identity"},"device":{"$ref":"#/components/schemas/mconn_controller_device_identity"},"nonce":{"type":"string"}},"required":["ak_public","device","nonce"],"type":"object"},"mconn_controller_begin_attestation_session_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_controller_begin_attestation_session_result"}},"type":"object"}],"type":"object"},"mconn_controller_begin_attestation_session_result":{"$ref":"#/components/schemas/mconn_controller_attestation_session"},"mconn_controller_connector":{"properties":{"account_id":{"$ref":"#/components/schemas/mconn_account_id"},"activated":{"type":"boolean"},"cloudflared_tunnel_token":{"type":"string"},"cohort_desired_version":{"type":"string"},"desired_version":{"type":"string"},"id":{"$ref":"#/components/schemas/mconn_uuid"},"interrupt_window_duration_hours":{"type":"number"},"interrupt_window_hour_of_day":{"type":"number"},"last_heartbeat":{"type":"string"},"last_seen_version":{"type":"string"},"pinned_version":{"deprecated":true,"type":"string"},"timezone":{"type":"string"},"upgrade_asap":{"type":"boolean"}},"required":["id","account_id","activated","timezone","interrupt_window_hour_of_day","interrupt_window_duration_hours","upgrade_asap"],"type":"object"},"mconn_controller_connector_identity":{"properties":{"account_id":{"$ref":"#/components/schemas/mconn_account_id"},"activated":{"type":"boolean"},"id":{"$ref":"#/components/schemas/mconn_uuid"}},"required":["id","account_id","activated"],"type":"object"},"mconn_controller_device":{"properties":{"crypt_key":{"type":"string","x-sensitive":true},"crypt_key_rotation_finished_at":{"type":"string"},"id":{"$ref":"#/components/schemas/mconn_uuid"},"imaged_at":{"type":"string"},"last_crypt_key":{"type":"string","x-sensitive":true},"license_key_sha256":{"type":"string"},"serial_number":{"type":"string"}},"required":["id","crypt_key"],"type":"object"},"mconn_controller_device_identity":{"properties":{"id":{"$ref":"#/components/schemas/mconn_uuid"},"imaged_at":{"type":"string"},"serial_number":{"type":"string"}},"required":["id"],"type":"object"},"mconn_controller_end_attestation_session_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_controller_end_attestation_session_result"}},"type":"object"}],"type":"object"},"mconn_controller_end_attestation_session_result":{"$ref":"#/components/schemas/mconn_controller_attestation_session"},"mconn_controller_fetch_cloudflared_token_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_controller_fetch_cloudflared_token_result"}},"type":"object"}],"type":"object"},"mconn_controller_fetch_cloudflared_token_result":{"type":"string","x-sensitive":true},"mconn_controller_fetch_connector_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_controller_fetch_connector_result"}},"type":"object"}],"type":"object"},"mconn_controller_fetch_connector_result":{"$ref":"#/components/schemas/mconn_controller_connector"},"mconn_controller_fetch_device_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_controller_fetch_device_result"}},"type":"object"}],"type":"object"},"mconn_controller_fetch_device_result":{"$ref":"#/components/schemas/mconn_controller_device"},"mconn_controller_fetch_flare_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_controller_fetch_flare_result"}},"type":"object"}],"type":"object"},"mconn_controller_fetch_flare_result":{"$ref":"#/components/schemas/mconn_controller_flare"},"mconn_controller_fetch_upgrade_slots_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mconn_controller_upgrade_slot"},"type":"array"}},"type":"object"}],"type":"object"},"mconn_controller_flare":{"properties":{"triggered_at":{"type":"string"}},"required":["triggered_at"],"type":"object"},"mconn_controller_identify_ek_cert_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_controller_identify_ek_cert_result"}},"type":"object"}],"type":"object"},"mconn_controller_identify_ek_cert_result":{"properties":{"connector":{"$ref":"#/components/schemas/mconn_controller_connector_identity"},"device":{"$ref":"#/components/schemas/mconn_controller_device_identity"}},"type":"object"},"mconn_controller_identify_license_key_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_controller_identify_license_key_result"}},"type":"object"}],"type":"object"},"mconn_controller_identify_license_key_result":{"properties":{"connector":{"$ref":"#/components/schemas/mconn_controller_connector_identity"},"device":{"$ref":"#/components/schemas/mconn_controller_device_identity"}},"type":"object"},"mconn_controller_update_connector_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_controller_update_connector_result"}},"type":"object"}],"type":"object"},"mconn_controller_update_connector_result":{"type":"object"},"mconn_controller_update_device_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_controller_update_device_result"}},"type":"object"}],"type":"object"},"mconn_controller_update_device_result":{"type":"object"},"mconn_controller_upgrade_slot":{"properties":{"connector_id":{"$ref":"#/components/schemas/mconn_uuid"},"id":{"type":"number"},"started_at":{"type":"string"}},"required":["id"],"type":"object"},"mconn_create_attestation_session_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_controller_attestation_session"}},"type":"object"}],"type":"object"},"mconn_create_connector_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_admin_connector"}},"type":"object"}],"type":"object"},"mconn_customer_connector":{"properties":{"activated":{"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"device":{"$ref":"#/components/schemas/mconn_customer_device"},"id":{"$ref":"#/components/schemas/mconn_uuid"},"interrupt_window_duration_hours":{"type":"number","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"interrupt_window_hour_of_day":{"type":"number","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"last_heartbeat":{"type":"string","x-auditable":true},"last_seen_version":{"type":"string","x-auditable":true},"last_updated":{"type":"string","x-auditable":true},"license_key":{"type":"string","x-stainless-terraform-configurability":"computed_optional"},"notes":{"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"timezone":{"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"}},"required":["id","notes","activated","last_updated","timezone","interrupt_window_hour_of_day","interrupt_window_duration_hours"],"type":"object"},"mconn_customer_connector_create_request":{"allOf":[{"properties":{"device":{"$ref":"#/components/schemas/mconn_customer_device_options"}},"required":["device"],"type":"object"},{"$ref":"#/components/schemas/mconn_customer_connector_fields"}],"type":"object"},"mconn_customer_connector_create_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_customer_connector"}},"type":"object"}],"type":"object"},"mconn_customer_connector_delete_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_customer_connector"}},"type":"object"}],"type":"object"},"mconn_customer_connector_fetch_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_customer_connector"}},"type":"object"}],"type":"object"},"mconn_customer_connector_fields":{"properties":{"activated":{"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"interrupt_window_duration_hours":{"type":"number","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"interrupt_window_hour_of_day":{"type":"number","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"notes":{"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"timezone":{"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"}},"type":"object"},"mconn_customer_connector_list_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mconn_customer_connector"},"type":"array"}},"type":"object"}],"type":"object"},"mconn_customer_connector_update_request":{"allOf":[{"$ref":"#/components/schemas/mconn_customer_connector_fields"},{"properties":{"provision_license":{"description":"When true, regenerate license key for the connector.","type":"boolean","x-go-type":"maybe.Maybe[bool]","x-go-type-import":{"path":"go.cfdata.org/mconn/api/maybe"},"x-go-type-skip-optional-pointer":true}},"type":"object"}],"type":"object"},"mconn_customer_connector_update_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_customer_connector"}},"type":"object"}],"type":"object"},"mconn_customer_device":{"properties":{"id":{"$ref":"#/components/schemas/mconn_uuid"},"serial_number":{"type":"string","x-auditable":true}},"required":["id"],"type":"object"},"mconn_customer_device_options":{"description":"Exactly one of id, serial_number, or provision_license must be provided.","maxProperties":1,"minProperties":1,"properties":{"id":{"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"provision_license":{"description":"When true, create and provision a new licence key for the connector.","type":"boolean"},"serial_number":{"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"}},"type":"object"},"mconn_customer_event_get_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_recorded_event"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_customer_events_get_latest_result":{"properties":{"count":{"type":"number"},"items":{"items":{"$ref":"#/components/schemas/mconn_recorded_event"},"type":"array"}},"required":["items","count"],"type":"object"},"mconn_customer_events_get_latest_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_customer_events_get_latest_result"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_customer_events_get_result":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/mconn_event_metadata"},"type":"array"}},"required":["items","count"],"type":"object"},"mconn_customer_events_get_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_customer_events_get_result"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_customer_snapshot_get_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_snapshot"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_customer_snapshots_get_latest_result":{"properties":{"count":{"type":"number"},"items":{"items":{"$ref":"#/components/schemas/mconn_snapshot"},"type":"array"}},"required":["items","count"],"type":"object"},"mconn_customer_snapshots_get_latest_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_customer_snapshots_get_latest_result"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_customer_snapshots_get_result":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/mconn_snapshot_metadata"},"type":"array"}},"required":["items","count"],"type":"object"},"mconn_customer_snapshots_get_success":{"allOf":[{"$ref":"#/components/schemas/mconn_envelope"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_customer_snapshots_get_result"}},"required":["result"],"type":"object"}],"type":"object"},"mconn_delete_attestation_session_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_controller_attestation_session"}},"type":"object"}],"type":"object"},"mconn_delete_controller_flare_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_controller_flare"}},"type":"object"}],"type":"object"},"mconn_envelope":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/mconn_coded_message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/mconn_coded_message"},"type":"array"},"success":{"type":"boolean"}},"required":["success"],"type":"object"},"mconn_event":{"oneOf":[{"properties":{"k":{"description":"Initialized process","enum":["Init"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Stopped process","enum":["Leave"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Started attestation","enum":["StartAttestation"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Finished attestation","enum":["FinishAttestationSuccess"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Failed attestation","enum":["FinishAttestationFailure"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Started crypt key rotation","enum":["StartRotateCryptKey"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Finished crypt key rotation","enum":["FinishRotateCryptKeySuccess"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Failed crypt key rotation","enum":["FinishRotateCryptKeyFailure"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Started PKI rotation","enum":["StartRotatePki"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Finished PKI rotation","enum":["FinishRotatePkiSuccess"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Failed PKI rotation","enum":["FinishRotatePkiFailure"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Started upgrade","enum":["StartUpgrade"],"type":"string"},"url":{"description":"Location of upgrade bundle","type":"string"}},"required":["k","url"],"type":"object"},{"properties":{"k":{"description":"Finished upgrade","enum":["FinishUpgradeSuccess"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Failed upgrade","enum":["FinishUpgradeFailure"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Reconciled","enum":["Reconcile"],"type":"string"}},"required":["k"],"type":"object"},{"properties":{"k":{"description":"Configured Cloudflared tunnel","enum":["ConfigureCloudflaredTunnel"],"type":"string"}},"required":["k"],"type":"object"}],"type":"object"},"mconn_event_metadata":{"properties":{"a":{"description":"Time the Event was collected (seconds since the Unix epoch)","type":"number"},"k":{"description":"Kind","type":"string"},"n":{"description":"Sequence number, used to order events with the same timestamp","type":"number"},"t":{"description":"Time the Event was recorded (seconds since the Unix epoch)","type":"number"}},"required":["a","t","n","k"],"type":"object"},"mconn_good_response":{"allOf":[{"$ref":"#/components/schemas/mconn_response"},{"properties":{"errors":{"items":{"$ref":"#/components/schemas/mconn_coded_message"},"maxLength":0,"type":"array"}},"type":"object"}],"type":"object"},"mconn_none":{"nullable":true,"type":"object"},"mconn_partner_device":{"properties":{"id":{"$ref":"#/components/schemas/mconn_uuid"}},"required":["id"],"type":"object"},"mconn_partner_device_register_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"$ref":"#/components/schemas/mconn_partner_device"}},"type":"object"}],"type":"object"},"mconn_read_controller_connector_token_response":{"allOf":[{"$ref":"#/components/schemas/mconn_good_response"},{"properties":{"result":{"type":"string","x-sensitive":true}},"type":"object"}],"type":"object"},"mconn_recorded_event":{"description":"Recorded Event","properties":{"e":{"$ref":"#/components/schemas/mconn_event"},"n":{"description":"Sequence number, used to order events with the same timestamp","type":"number"},"t":{"description":"Time the Event was recorded (seconds since the Unix epoch)","type":"number"}},"required":["t","n","e"],"type":"object"},"mconn_response":{"properties":{"messages":{"items":{"$ref":"#/components/schemas/mconn_coded_message"},"type":"array"},"success":{"type":"boolean"}},"required":["result","success","errors","messages"],"type":"object"},"mconn_snapshot":{"description":"Snapshot","properties":{"bonds":{"items":{"$ref":"#/components/schemas/mconn_snapshot_bond"},"type":"array"},"count_reclaim_failures":{"description":"Count of failures to reclaim space","type":"number"},"count_reclaimed_paths":{"description":"Count of reclaimed paths","type":"number"},"count_record_failed":{"description":"Count of failed snapshot recordings","type":"number"},"count_transmit_failures":{"description":"Count of failed snapshot transmissions","type":"number"},"cpu_count":{"description":"Count of processors/cores","type":"number"},"cpu_pressure_10s":{"description":"Percentage of time over a 10 second window that tasks were stalled","type":"number"},"cpu_pressure_300s":{"description":"Percentage of time over a 5 minute window that tasks were stalled","type":"number"},"cpu_pressure_60s":{"description":"Percentage of time over a 1 minute window that tasks were stalled","type":"number"},"cpu_pressure_total_us":{"description":"Total stall time (microseconds)","type":"number"},"cpu_time_guest_ms":{"description":"Time spent running a virtual CPU or guest OS (milliseconds)","type":"number"},"cpu_time_guest_nice_ms":{"description":"Time spent running a niced guest (milliseconds)","type":"number"},"cpu_time_idle_ms":{"description":"Time spent in idle state (milliseconds)","type":"number"},"cpu_time_iowait_ms":{"description":"Time spent wait for I/O to complete (milliseconds)","type":"number"},"cpu_time_irq_ms":{"description":"Time spent servicing interrupts (milliseconds)","type":"number"},"cpu_time_nice_ms":{"description":"Time spent in low-priority user mode (milliseconds)","type":"number"},"cpu_time_softirq_ms":{"description":"Time spent servicing softirqs (milliseconds)","type":"number"},"cpu_time_steal_ms":{"description":"Time stolen (milliseconds)","type":"number"},"cpu_time_system_ms":{"description":"Time spent in system mode (milliseconds)","type":"number"},"cpu_time_user_ms":{"description":"Time spent in user mode (milliseconds)","type":"number"},"dhcp_leases":{"items":{"$ref":"#/components/schemas/mconn_snapshot_dhcp_lease"},"type":"array"},"disks":{"items":{"$ref":"#/components/schemas/mconn_snapshot_disk"},"type":"array"},"ha_state":{"description":"Name of high availability state","type":"string"},"ha_value":{"description":"Numeric value associated with high availability state (0 = disabled, 1 = active, 2 = standby, 3 = stopped, 4 = fault)","type":"number"},"interfaces":{"items":{"$ref":"#/components/schemas/mconn_snapshot_interface"},"type":"array"},"io_pressure_full_10s":{"description":"Percentage of time over a 10 second window that all tasks were stalled","type":"number"},"io_pressure_full_300s":{"description":"Percentage of time over a 5 minute window that all tasks were stalled","type":"number"},"io_pressure_full_60s":{"description":"Percentage of time over a 1 minute window that all tasks were stalled","type":"number"},"io_pressure_full_total_us":{"description":"Total stall time (microseconds)","type":"number"},"io_pressure_some_10s":{"description":"Percentage of time over a 10 second window that some tasks were stalled","type":"number"},"io_pressure_some_300s":{"description":"Percentage of time over a 3 minute window that some tasks were stalled","type":"number"},"io_pressure_some_60s":{"description":"Percentage of time over a 1 minute window that some tasks were stalled","type":"number"},"io_pressure_some_total_us":{"description":"Total stall time (microseconds)","type":"number"},"kernel_btime":{"description":"Boot time (seconds since Unix epoch)","type":"number"},"kernel_ctxt":{"description":"Number of context switches that the system underwent","type":"number"},"kernel_processes":{"description":"Number of forks since boot","type":"number"},"kernel_processes_blocked":{"description":"Number of processes blocked waiting for I/O","type":"number"},"kernel_processes_running":{"description":"Number of processes in runnable state","type":"number"},"load_average_15m":{"description":"The fifteen-minute load average","type":"number"},"load_average_1m":{"description":"The one-minute load average","type":"number"},"load_average_5m":{"description":"The five-minute load average","type":"number"},"load_average_cur":{"description":"Number of currently runnable kernel scheduling entities","type":"number"},"load_average_max":{"description":"Number of kernel scheduling entities that currently exist on the system","type":"number"},"memory_active_bytes":{"description":"Memory that has been used more recently","type":"number"},"memory_anon_hugepages_bytes":{"description":"Non-file backed huge pages mapped into user-space page tables","type":"number"},"memory_anon_pages_bytes":{"description":"Non-file backed pages mapped into user-space page tables","type":"number"},"memory_available_bytes":{"description":"Estimate of how much memory is available for starting new applications","type":"number"},"memory_bounce_bytes":{"description":"Memory used for block device bounce buffers","type":"number"},"memory_buffers_bytes":{"description":"Relatively temporary storage for raw disk blocks","type":"number"},"memory_cached_bytes":{"description":"In-memory cache for files read from the disk","type":"number"},"memory_cma_free_bytes":{"description":"Free CMA (Contiguous Memory Allocator) pages","type":"number"},"memory_cma_total_bytes":{"description":"Total CMA (Contiguous Memory Allocator) pages","type":"number"},"memory_commit_limit_bytes":{"description":"Total amount of memory currently available to be allocated on the system","type":"number"},"memory_committed_as_bytes":{"description":"Amount of memory presently allocated on the system","type":"number"},"memory_dirty_bytes":{"description":"Memory which is waiting to get written back to the disk","type":"number"},"memory_free_bytes":{"description":"The sum of LowFree and HighFree","type":"number"},"memory_high_free_bytes":{"description":"Amount of free highmem","type":"number"},"memory_high_total_bytes":{"description":"Total amount of highmem","type":"number"},"memory_hugepages_free":{"description":"The number of huge pages in the pool that are not yet allocated","type":"number"},"memory_hugepages_rsvd":{"description":"Number of huge pages for which a commitment has been made, but no allocation has yet been made","type":"number"},"memory_hugepages_surp":{"description":"Number of huge pages in the pool above the threshold","type":"number"},"memory_hugepages_total":{"description":"The size of the pool of huge pages","type":"number"},"memory_hugepagesize_bytes":{"description":"The size of huge pages","type":"number"},"memory_inactive_bytes":{"description":"Memory which has been less recently used","type":"number"},"memory_k_reclaimable_bytes":{"description":"Kernel allocations that the kernel will attempt to reclaim under memory pressure","type":"number"},"memory_kernel_stack_bytes":{"description":"Amount of memory allocated to kernel stacks","type":"number"},"memory_low_free_bytes":{"description":"Amount of free lowmem","type":"number"},"memory_low_total_bytes":{"description":"Total amount of lowmem","type":"number"},"memory_mapped_bytes":{"description":"Files which have been mapped into memory","type":"number"},"memory_page_tables_bytes":{"description":"Amount of memory dedicated to the lowest level of page tables","type":"number"},"memory_per_cpu_bytes":{"description":"Memory allocated to the per-cpu alloctor used to back per-cpu allocations","type":"number"},"memory_pressure_full_10s":{"description":"Percentage of time over a 10 second window that all tasks were stalled","type":"number"},"memory_pressure_full_300s":{"description":"Percentage of time over a 5 minute window that all tasks were stalled","type":"number"},"memory_pressure_full_60s":{"description":"Percentage of time over a 1 minute window that all tasks were stalled","type":"number"},"memory_pressure_full_total_us":{"description":"Total stall time (microseconds)","type":"number"},"memory_pressure_some_10s":{"description":"Percentage of time over a 10 second window that some tasks were stalled","type":"number"},"memory_pressure_some_300s":{"description":"Percentage of time over a 5 minute window that some tasks were stalled","type":"number"},"memory_pressure_some_60s":{"description":"Percentage of time over a 1 minute window that some tasks were stalled","type":"number"},"memory_pressure_some_total_us":{"description":"Total stall time (microseconds)","type":"number"},"memory_s_reclaimable_bytes":{"description":"Part of slab that can be reclaimed on memory pressure","type":"number"},"memory_s_unreclaim_bytes":{"description":"Part of slab that cannot be reclaimed on memory pressure","type":"number"},"memory_secondary_page_tables_bytes":{"description":"Amount of memory dedicated to the lowest level of page tables","type":"number"},"memory_shmem_bytes":{"description":"Amount of memory consumed by tmpfs","type":"number"},"memory_shmem_hugepages_bytes":{"description":"Memory used by shmem and tmpfs, allocated with huge pages","type":"number"},"memory_shmem_pmd_mapped_bytes":{"description":"Shared memory mapped into user space with huge pages","type":"number"},"memory_slab_bytes":{"description":"In-kernel data structures cache","type":"number"},"memory_swap_cached_bytes":{"description":"Memory swapped out and back in while still in swap file","type":"number"},"memory_swap_free_bytes":{"description":"Amount of swap space that is currently unused","type":"number"},"memory_swap_total_bytes":{"description":"Total amount of swap space available","type":"number"},"memory_total_bytes":{"description":"Total usable RAM","type":"number"},"memory_vmalloc_chunk_bytes":{"description":"Largest contiguous block of vmalloc area which is free","type":"number"},"memory_vmalloc_total_bytes":{"description":"Total size of vmalloc memory area","type":"number"},"memory_vmalloc_used_bytes":{"description":"Amount of vmalloc area which is used","type":"number"},"memory_writeback_bytes":{"description":"Memory which is actively being written back to the disk","type":"number"},"memory_writeback_tmp_bytes":{"description":"Memory used by FUSE for temporary writeback buffers","type":"number"},"memory_z_swap_bytes":{"description":"Memory consumed by the zswap backend, compressed","type":"number"},"memory_z_swapped_bytes":{"description":"Amount of anonymous memory stored in zswap, uncompressed","type":"number"},"mounts":{"items":{"$ref":"#/components/schemas/mconn_snapshot_mount"},"type":"array"},"netdevs":{"items":{"$ref":"#/components/schemas/mconn_snapshot_netdev"},"type":"array"},"snmp_icmp_in_addr_mask_reps":{"description":"Number of ICMP Address Mask Reply messages received","type":"number"},"snmp_icmp_in_addr_masks":{"description":"Number of ICMP Address Mask Request messages received","type":"number"},"snmp_icmp_in_csum_errors":{"description":"Number of ICMP messages received with bad checksums","type":"number"},"snmp_icmp_in_dest_unreachs":{"description":"Number of ICMP Destination Unreachable messages received","type":"number"},"snmp_icmp_in_echo_reps":{"description":"Number of ICMP Echo Reply messages received","type":"number"},"snmp_icmp_in_echos":{"description":"Number of ICMP Echo (request) messages received","type":"number"},"snmp_icmp_in_errors":{"description":"Number of ICMP messages received with ICMP-specific errors","type":"number"},"snmp_icmp_in_msgs":{"description":"Number of ICMP messages received","type":"number"},"snmp_icmp_in_parm_probs":{"description":"Number of ICMP Parameter Problem messages received","type":"number"},"snmp_icmp_in_redirects":{"description":"Number of ICMP Redirect messages received","type":"number"},"snmp_icmp_in_src_quenchs":{"description":"Number of ICMP Source Quench messages received","type":"number"},"snmp_icmp_in_time_excds":{"description":"Number of ICMP Time Exceeded messages received","type":"number"},"snmp_icmp_in_timestamp_reps":{"description":"Number of ICMP Address Mask Request messages received","type":"number"},"snmp_icmp_in_timestamps":{"description":"Number of ICMP Timestamp (request) messages received","type":"number"},"snmp_icmp_out_addr_mask_reps":{"description":"Number of ICMP Address Mask Reply messages sent","type":"number"},"snmp_icmp_out_addr_masks":{"description":"Number of ICMP Address Mask Request messages sent","type":"number"},"snmp_icmp_out_dest_unreachs":{"description":"Number of ICMP Destination Unreachable messages sent","type":"number"},"snmp_icmp_out_echo_reps":{"description":"Number of ICMP Echo Reply messages sent","type":"number"},"snmp_icmp_out_echos":{"description":"Number of ICMP Echo (request) messages sent","type":"number"},"snmp_icmp_out_errors":{"description":"Number of ICMP messages which this entity did not send due to ICMP-specific errors","type":"number"},"snmp_icmp_out_msgs":{"description":"Number of ICMP messages attempted to send","type":"number"},"snmp_icmp_out_parm_probs":{"description":"Number of ICMP Parameter Problem messages sent","type":"number"},"snmp_icmp_out_redirects":{"description":"Number of ICMP Redirect messages sent","type":"number"},"snmp_icmp_out_src_quenchs":{"description":"Number of ICMP Source Quench messages sent","type":"number"},"snmp_icmp_out_time_excds":{"description":"Number of ICMP Time Exceeded messages sent","type":"number"},"snmp_icmp_out_timestamp_reps":{"description":"Number of ICMP Timestamp Reply messages sent","type":"number"},"snmp_icmp_out_timestamps":{"description":"Number of ICMP Timestamp (request) messages sent","type":"number"},"snmp_ip_default_ttl":{"description":"Default value of the Time-To-Live field of the IP header","type":"number"},"snmp_ip_forw_datagrams":{"description":"Number of datagrams forwarded to their final destination","type":"number"},"snmp_ip_forwarding_enabled":{"description":"Set when acting as an IP gateway","type":"boolean"},"snmp_ip_frag_creates":{"description":"Number of datagrams generated by fragmentation","type":"number"},"snmp_ip_frag_fails":{"description":"Number of datagrams discarded because fragmentation failed","type":"number"},"snmp_ip_frag_oks":{"description":"Number of datagrams successfully fragmented","type":"number"},"snmp_ip_in_addr_errors":{"description":"Number of input datagrams discarded due to errors in the IP address","type":"number"},"snmp_ip_in_delivers":{"description":"Number of input datagrams successfully delivered to IP user-protocols","type":"number"},"snmp_ip_in_discards":{"description":"Number of input datagrams otherwise discarded","type":"number"},"snmp_ip_in_hdr_errors":{"description":"Number of input datagrams discarded due to errors in the IP header","type":"number"},"snmp_ip_in_receives":{"description":"Number of input datagrams received from interfaces","type":"number"},"snmp_ip_in_unknown_protos":{"description":"Number of input datagrams discarded due unknown or unsupported protocol","type":"number"},"snmp_ip_out_discards":{"description":"Number of output datagrams otherwise discarded","type":"number"},"snmp_ip_out_no_routes":{"description":"Number of output datagrams discarded because no route matched","type":"number"},"snmp_ip_out_requests":{"description":"Number of datagrams supplied for transmission","type":"number"},"snmp_ip_reasm_fails":{"description":"Number of failures detected by the reassembly algorithm","type":"number"},"snmp_ip_reasm_oks":{"description":"Number of datagrams successfully reassembled","type":"number"},"snmp_ip_reasm_reqds":{"description":"Number of fragments received which needed to be reassembled","type":"number"},"snmp_ip_reasm_timeout":{"description":"Number of seconds fragments are held while awaiting reassembly","type":"number"},"snmp_tcp_active_opens":{"description":"Number of times TCP transitions to SYN-SENT from CLOSED","type":"number"},"snmp_tcp_attempt_fails":{"description":"Number of times TCP transitions to CLOSED from SYN-SENT or SYN-RCVD, plus transitions to LISTEN from SYN-RCVD","type":"number"},"snmp_tcp_curr_estab":{"description":"Number of TCP connections in ESTABLISHED or CLOSE-WAIT","type":"number"},"snmp_tcp_estab_resets":{"description":"Number of times TCP transitions to CLOSED from ESTABLISHED or CLOSE-WAIT","type":"number"},"snmp_tcp_in_csum_errors":{"description":"Number of TCP segments received with checksum errors","type":"number"},"snmp_tcp_in_errs":{"description":"Number of TCP segments received in error","type":"number"},"snmp_tcp_in_segs":{"description":"Number of TCP segments received","type":"number"},"snmp_tcp_max_conn":{"description":"Limit on the total number of TCP connections","type":"number"},"snmp_tcp_out_rsts":{"description":"Number of TCP segments sent with RST flag","type":"number"},"snmp_tcp_out_segs":{"description":"Number of TCP segments sent","type":"number"},"snmp_tcp_passive_opens":{"description":"Number of times TCP transitions to SYN-RCVD from LISTEN","type":"number"},"snmp_tcp_retrans_segs":{"description":"Number of TCP segments retransmitted","type":"number"},"snmp_tcp_rto_max":{"description":"Maximum value permitted by a TCP implementation for the retransmission timeout (milliseconds)","type":"number"},"snmp_tcp_rto_min":{"description":"Minimum value permitted by a TCP implementation for the retransmission timeout (milliseconds)","type":"number"},"snmp_udp_in_datagrams":{"description":"Number of UDP datagrams delivered to UDP applications","type":"number"},"snmp_udp_in_errors":{"description":"Number of UDP datagrams failed to be delivered for reasons other than lack of application at the destination port","type":"number"},"snmp_udp_no_ports":{"description":"Number of UDP datagrams received for which there was not application at the destination port","type":"number"},"snmp_udp_out_datagrams":{"description":"Number of UDP datagrams sent","type":"number"},"system_boot_time_s":{"description":"Boottime of the system (seconds since the Unix epoch)","type":"number"},"t":{"description":"Time the Snapshot was recorded (seconds since the Unix epoch)","type":"number"},"thermals":{"items":{"$ref":"#/components/schemas/mconn_snapshot_thermal"},"type":"array"},"tunnels":{"items":{"$ref":"#/components/schemas/mconn_snapshot_tunnel"},"type":"array"},"uptime_idle_ms":{"description":"Sum of how much time each core has spent idle","type":"number"},"uptime_total_ms":{"description":"Uptime of the system, including time spent in suspend","type":"number"},"v":{"description":"Version","type":"string"}},"required":["t","v","count_reclaim_failures","count_reclaimed_paths","count_record_failed","count_transmit_failures"],"type":"object"},"mconn_snapshot_bond":{"description":"Snapshot Bond","properties":{"name":{"description":"Name of the network interface","type":"string"},"status":{"description":"Current status of the network interface","type":"string"}},"required":["name","status"],"type":"object"},"mconn_snapshot_dhcp_lease":{"description":"Snapshot DHCP lease","properties":{"client_id":{"description":"Client ID of the device the IP Address was leased to","type":"string"},"connector_id":{"description":"Connector identifier","type":"string"},"expiry_time":{"description":"Expiry time of the DHCP lease (seconds since the Unix epoch)","type":"number"},"hostname":{"description":"Hostname of the device the IP Address was leased to","type":"string"},"interface_name":{"description":"Name of the network interface","type":"string"},"ip_address":{"description":"IP Address that was leased","type":"string"},"mac_address":{"description":"MAC Address of the device the IP Address was leased to","type":"string"}},"required":["interface_name","expiry_time","mac_address","ip_address","hostname","client_id"],"type":"object"},"mconn_snapshot_disk":{"description":"Snapshot Disk","properties":{"connector_id":{"description":"Connector identifier","type":"string"},"discards":{"description":"Discards completed successfully","type":"number"},"discards_merged":{"description":"Discards merged","type":"number"},"flushes":{"description":"Flushes completed successfully","type":"number"},"in_progress":{"description":"I/Os currently in progress","type":"number"},"major":{"description":"Device major number","type":"number"},"merged":{"description":"Reads merged","type":"number"},"minor":{"description":"Device minor number","type":"number"},"name":{"description":"Device name","type":"string"},"reads":{"description":"Reads completed successfully","type":"number"},"sectors_discarded":{"description":"Sectors discarded","type":"number"},"sectors_read":{"description":"Sectors read successfully","type":"number"},"sectors_written":{"description":"Sectors written successfully","type":"number"},"time_discarding_ms":{"description":"Time spent discarding (milliseconds)","type":"number"},"time_flushing_ms":{"description":"Time spent flushing (milliseconds)","type":"number"},"time_in_progress_ms":{"description":"Time spent doing I/Os (milliseconds)","type":"number"},"time_reading_ms":{"description":"Time spent reading (milliseconds)","type":"number"},"time_writing_ms":{"description":"Time spent writing (milliseconds)","type":"number"},"weighted_time_in_progress_ms":{"description":"Weighted time spent doing I/Os (milliseconds)","type":"number"},"writes":{"description":"Writes completed","type":"number"},"writes_merged":{"description":"Writes merged","type":"number"}},"required":["in_progress","major","merged","minor","name","reads","sectors_read","sectors_written","time_in_progress_ms","time_reading_ms","time_writing_ms","weighted_time_in_progress_ms","writes","writes_merged"],"type":"object"},"mconn_snapshot_interface":{"description":"Snapshot Interface","properties":{"connector_id":{"description":"Connector identifier","type":"string"},"ip_addresses":{"items":{"$ref":"#/components/schemas/mconn_snapshot_interface_address"},"type":"array"},"name":{"description":"Name of the network interface","type":"string"},"operstate":{"description":"UP/DOWN state of the network interface","type":"string"},"speed":{"description":"Speed of the network interface (bits per second)","type":"number"}},"required":["name","operstate"],"type":"object"},"mconn_snapshot_interface_address":{"description":"Snapshot Interface Address","properties":{"connector_id":{"description":"Connector identifier","type":"string"},"interface_name":{"description":"Name of the network interface","type":"string"},"ip_address":{"description":"IP address of the network interface","type":"string"}},"required":["interface_name","ip_address"],"type":"object"},"mconn_snapshot_metadata":{"properties":{"a":{"description":"Time the Snapshot was collected (seconds since the Unix epoch)","type":"number"},"t":{"description":"Time the Snapshot was recorded (seconds since the Unix epoch)","type":"number"}},"required":["a","t"],"type":"object"},"mconn_snapshot_mount":{"description":"Snapshot Mount","properties":{"available_bytes":{"description":"Available disk size (bytes)","type":"number"},"connector_id":{"description":"Connector identifier","type":"string"},"file_system":{"description":"File system on disk (EXT4, NTFS, etc.)","type":"string"},"is_read_only":{"description":"Determines whether the disk is read-only","type":"boolean"},"is_removable":{"description":"Determines whether the disk is removable","type":"boolean"},"kind":{"description":"Kind of disk (HDD, SSD, etc.)","type":"string"},"mount_point":{"description":"Path where disk is mounted","type":"string"},"name":{"description":"Name of the disk mount","type":"string"},"total_bytes":{"description":"Total disk size (bytes)","type":"number"}},"required":["name","kind","file_system","mount_point"],"type":"object"},"mconn_snapshot_netdev":{"description":"Snapshot Netdev","properties":{"connector_id":{"description":"Connector identifier","type":"string"},"name":{"description":"Name of the network device","type":"string"},"recv_bytes":{"description":"Total bytes received","type":"number"},"recv_compressed":{"description":"Compressed packets received","type":"number"},"recv_drop":{"description":"Packets dropped","type":"number"},"recv_errs":{"description":"Bad packets received","type":"number"},"recv_fifo":{"description":"FIFO overruns","type":"number"},"recv_frame":{"description":"Frame alignment errors","type":"number"},"recv_multicast":{"description":"Multicast packets received","type":"number"},"recv_packets":{"description":"Total packets received","type":"number"},"sent_bytes":{"description":"Total bytes transmitted","type":"number"},"sent_carrier":{"description":"Number of packets not sent due to carrier errors","type":"number"},"sent_colls":{"description":"Number of collisions","type":"number"},"sent_compressed":{"description":"Number of compressed packets transmitted","type":"number"},"sent_drop":{"description":"Number of packets dropped during transmission","type":"number"},"sent_errs":{"description":"Number of transmission errors","type":"number"},"sent_fifo":{"description":"FIFO overruns","type":"number"},"sent_packets":{"description":"Total packets transmitted","type":"number"}},"required":["name","recv_bytes","recv_packets","recv_errs","recv_drop","recv_fifo","recv_frame","recv_compressed","recv_multicast","sent_bytes","sent_packets","sent_errs","sent_drop","sent_fifo","sent_colls","sent_carrier","sent_compressed"],"type":"object"},"mconn_snapshot_thermal":{"description":"Snapshot Thermal","properties":{"connector_id":{"description":"Connector identifier","type":"string"},"critical_celcius":{"description":"Critical failure temperature of the component (degrees Celsius)","type":"number"},"current_celcius":{"description":"Current temperature of the component (degrees Celsius)","type":"number"},"label":{"description":"Sensor identifier for the component","type":"string"},"max_celcius":{"description":"Maximum temperature of the component (degrees Celsius)","type":"number"}},"required":["label"],"type":"object"},"mconn_snapshot_tunnel":{"description":"Snapshot Tunnels","properties":{"connector_id":{"description":"Connector identifier","type":"string"},"health_state":{"description":"Name of tunnel health state (unknown, healthy, degraded, down)","type":"string"},"health_value":{"description":"Numeric value associated with tunnel state (0 = unknown, 1 = healthy, 2 = degraded, 3 = down)","type":"number"},"interface_name":{"description":"The tunnel interface name (i.e. xfrm1, xfrm3.99, etc.)","type":"string"},"probed_mtu":{"description":"MTU as measured between the two ends of the tunnel","type":"number"},"tunnel_id":{"description":"Tunnel identifier","type":"string"}},"required":["tunnel_id","interface_name","health_state","health_value"],"type":"object"},"mconn_uuid":{"type":"string","x-auditable":true},"mq_api-v4-error":{"example":[{"code":7003,"message":"No route for the URI"}],"items":{"properties":{"code":{"minimum":1000,"type":"integer","x-auditable":true},"message":{"type":"string","x-auditable":true}},"required":["code","message"],"type":"object","uniqueItems":true},"minLength":1,"type":"array"},"mq_api-v4-failure":{"properties":{"errors":{"$ref":"#/components/schemas/mq_api-v4-error"},"messages":{"$ref":"#/components/schemas/mq_api-v4-message"},"success":{"description":"Indicates if the API call was successful or not.","enum":[false],"example":false,"type":"boolean","x-auditable":true}},"type":"object"},"mq_api-v4-message":{"example":[],"items":{"type":"string","x-auditable":true},"type":"array"},"mq_api-v4-success":{"properties":{"errors":{"$ref":"#/components/schemas/mq_api-v4-error"},"messages":{"$ref":"#/components/schemas/mq_api-v4-message"},"success":{"description":"Indicates if the API call was successful or not.","enum":[true],"type":"boolean","x-auditable":true}},"type":"object"},"mq_batch-size":{"description":"The maximum number of messages to include in a batch.","example":50,"type":"number","x-auditable":true},"mq_consumer":{"oneOf":[{"$ref":"#/components/schemas/mq_worker-consumer"},{"$ref":"#/components/schemas/mq_http-consumer"}],"type":"object"},"mq_event-destination":{"description":"Destination configuration for the subscription","oneOf":[{"$ref":"#/components/schemas/mq_event-destination-queue"}],"type":"object"},"mq_event-destination-queue":{"properties":{"queue_id":{"description":"ID of the target queue","type":"string","x-auditable":true},"type":{"description":"Type of destination","enum":["queues.queue"],"type":"string","x-auditable":true}},"required":["type","queue_id"],"type":"object"},"mq_event-source":{"description":"Source configuration for the subscription","oneOf":[{"$ref":"#/components/schemas/mq_event-source-images"},{"$ref":"#/components/schemas/mq_event-source-kv"},{"$ref":"#/components/schemas/mq_event-source-r2"},{"$ref":"#/components/schemas/mq_event-source-super-slurper"},{"$ref":"#/components/schemas/mq_event-source-vectorize"},{"$ref":"#/components/schemas/mq_event-source-workers-ai-model"},{"$ref":"#/components/schemas/mq_event-source-workers-builds-worker"},{"$ref":"#/components/schemas/mq_event-source-workflows-workflow"}],"type":"object"},"mq_event-source-images":{"properties":{"type":{"description":"Type of source","enum":["images"],"type":"string","x-auditable":true}},"type":"object"},"mq_event-source-kv":{"properties":{"type":{"description":"Type of source","enum":["kv"],"type":"string","x-auditable":true}},"type":"object"},"mq_event-source-r2":{"properties":{"type":{"description":"Type of source","enum":["r2"],"type":"string","x-auditable":true}},"type":"object"},"mq_event-source-super-slurper":{"properties":{"type":{"description":"Type of source","enum":["superSlurper"],"type":"string","x-auditable":true}},"type":"object"},"mq_event-source-vectorize":{"properties":{"type":{"description":"Type of source","enum":["vectorize"],"type":"string","x-auditable":true}},"type":"object"},"mq_event-source-workers-ai-model":{"properties":{"model_name":{"description":"Name of the Workers AI model","type":"string","x-auditable":true},"type":{"description":"Type of source","enum":["workersAi.model"],"type":"string","x-auditable":true}},"type":"object"},"mq_event-source-workers-builds-worker":{"properties":{"type":{"description":"Type of source","enum":["workersBuilds.worker"],"type":"string","x-auditable":true},"worker_name":{"description":"Name of the worker","type":"string","x-auditable":true}},"type":"object"},"mq_event-source-workflows-workflow":{"properties":{"type":{"description":"Type of source","enum":["workflows.workflow"],"type":"string","x-auditable":true},"workflow_name":{"description":"Name of the workflow","type":"string","x-auditable":true}},"type":"object"},"mq_event-subscription":{"properties":{"created_at":{"description":"When the subscription was created","format":"date-time","type":"string","x-auditable":true},"destination":{"$ref":"#/components/schemas/mq_event-destination"},"enabled":{"description":"Whether the subscription is active","type":"boolean","x-auditable":true},"events":{"description":"List of event types this subscription handles","items":{"type":"string"},"minItems":1,"type":"array","x-auditable":true},"id":{"description":"Unique identifier for the subscription","type":"string","x-auditable":true},"modified_at":{"description":"When the subscription was last modified","format":"date-time","type":"string","x-auditable":true},"name":{"description":"Name of the subscription","type":"string","x-auditable":true},"source":{"$ref":"#/components/schemas/mq_event-source"}},"required":["id","created_at","modified_at","name","enabled","source","destination","events"],"type":"object"},"mq_http-consumer":{"properties":{"consumer_id":{"$ref":"#/components/schemas/mq_identifier"},"created_on":{"readOnly":true,"type":"string","x-auditable":true},"queue_id":{"$ref":"#/components/schemas/mq_identifier"},"settings":{"properties":{"batch_size":{"$ref":"#/components/schemas/mq_batch-size"},"max_retries":{"$ref":"#/components/schemas/mq_max-retries"},"retry_delay":{"$ref":"#/components/schemas/mq_retry-delay"},"visibility_timeout_ms":{"$ref":"#/components/schemas/mq_visibility-timeout"}},"type":"object"},"type":{"enum":["http_pull"],"type":"string","x-auditable":true}},"type":"object"},"mq_identifier":{"description":"A Resource identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"mq_lease-id":{"description":"An ID that represents an \"in-flight\" message that has been pulled from a Queue. You must hold on to this ID and use it to acknowledge this message.","example":"eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0..Q8p21d7dceR6vUfwftONdQ.JVqZgAS-Zk7MqmqccYtTHeeMElNHaOMigeWdb8LyMOg.T2_HV99CYzGaQuhTyW8RsgbnpTRZHRM6N7UoSaAKeK0","type":"string","x-auditable":true},"mq_max-concurrency":{"description":"Maximum number of concurrent consumers that may consume from this Queue. Set to `null` to automatically opt in to the platform's maximum (recommended).","example":10,"type":"number","x-auditable":true},"mq_max-retries":{"description":"The maximum number of retries","example":3,"type":"number","x-auditable":true},"mq_max-wait-time":{"description":"The number of milliseconds to wait for a batch to fill up before attempting to deliver it","example":5000,"type":"number","x-auditable":true},"mq_producer":{"oneOf":[{"$ref":"#/components/schemas/mq_worker-producer"},{"$ref":"#/components/schemas/mq_r2-producer"}],"type":"object"},"mq_queue":{"properties":{"consumers":{"items":{"$ref":"#/components/schemas/mq_consumer"},"readOnly":true,"type":"array"},"consumers_total_count":{"readOnly":true,"type":"number"},"created_on":{"readOnly":true,"type":"string","x-auditable":true},"modified_on":{"readOnly":true,"type":"string","x-auditable":true},"producers":{"items":{"$ref":"#/components/schemas/mq_producer"},"readOnly":true,"type":"array"},"producers_total_count":{"readOnly":true,"type":"number","x-auditable":true},"queue_id":{"readOnly":true,"type":"string","x-auditable":true},"queue_name":{"$ref":"#/components/schemas/mq_queue-name"},"settings":{"$ref":"#/components/schemas/mq_queue-settings"}},"type":"object"},"mq_queue-batch":{"properties":{"delay_seconds":{"description":"The number of seconds to wait for attempting to deliver this batch to consumers","example":"text","type":"number","x-auditable":true},"messages":{"items":{"$ref":"#/components/schemas/mq_queue-message"},"type":"array"}},"type":"object"},"mq_queue-message":{"allOf":[{"properties":{"delay_seconds":{"description":"The number of seconds to wait for attempting to deliver this message to consumers","example":"text","type":"number","x-auditable":true}},"type":"object"},{"oneOf":[{"$ref":"#/components/schemas/mq_queue-message-text"},{"$ref":"#/components/schemas/mq_queue-message-json"}]}]},"mq_queue-message-json":{"properties":{"body":{"type":"object"},"content_type":{"enum":["json"],"type":"string","x-auditable":true}},"type":"object"},"mq_queue-message-text":{"properties":{"body":{"type":"string"},"content_type":{"enum":["text"],"type":"string","x-auditable":true}},"type":"object"},"mq_queue-name":{"example":"example-queue","type":"string","x-auditable":true},"mq_queue-pull-batch":{"items":{"properties":{"attempts":{"example":1,"readOnly":true,"type":"number","x-auditable":true},"body":{"example":"hello world","readOnly":true,"type":"string"},"id":{"example":"b01b5594f784d0165c2985833f5660dd","readOnly":true,"type":"string","x-auditable":true},"lease_id":{"$ref":"#/components/schemas/mq_lease-id"},"metadata":{"example":{"CF-Content-Type":"text","CF-sourceMessageSource":"dash"},"readOnly":true,"type":"object"},"timestamp_ms":{"example":1710950954154,"readOnly":true,"type":"number","x-auditable":true}},"type":"object"},"type":"array"},"mq_queue-settings":{"properties":{"delivery_delay":{"description":"Number of seconds to delay delivery of all messages to consumers.","example":5,"type":"number","x-auditable":true},"delivery_paused":{"description":"Indicates if message delivery to consumers is currently paused.","example":true,"type":"boolean","x-auditable":true},"message_retention_period":{"description":"Number of seconds after which an unconsumed message will be delayed.","example":345600,"type":"number","x-auditable":true}},"type":"object"},"mq_r2-producer":{"properties":{"bucket_name":{"type":"string","x-auditable":true},"type":{"enum":["r2_bucket"],"type":"string","x-auditable":true}},"type":"object"},"mq_retry-delay":{"description":"The number of seconds to delay before making the message available for another attempt.","example":10,"type":"number","x-auditable":true},"mq_script-name":{"description":"Name of a Worker","example":"my-consumer-worker","type":"string","x-auditable":true},"mq_visibility-timeout":{"description":"The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.","example":6000,"type":"number","x-auditable":true},"mq_worker-consumer":{"properties":{"consumer_id":{"$ref":"#/components/schemas/mq_identifier"},"created_on":{"readOnly":true,"type":"string","x-auditable":true},"queue_id":{"$ref":"#/components/schemas/mq_identifier"},"script":{"allOf":[{"$ref":"#/components/schemas/mq_script-name"},{"readOnly":true,"type":"string"}],"type":"object"},"script_name":{"allOf":[{"$ref":"#/components/schemas/mq_script-name"},{"type":"string","writeOnly":true}],"type":"object","x-auditable":true},"settings":{"properties":{"batch_size":{"$ref":"#/components/schemas/mq_batch-size"},"max_concurrency":{"$ref":"#/components/schemas/mq_max-concurrency"},"max_retries":{"$ref":"#/components/schemas/mq_max-retries"},"max_wait_time_ms":{"$ref":"#/components/schemas/mq_max-wait-time"},"retry_delay":{"$ref":"#/components/schemas/mq_retry-delay"}},"type":"object"},"type":{"enum":["worker"],"type":"string","x-auditable":true}},"type":"object"},"mq_worker-producer":{"properties":{"script":{"type":"string","x-auditable":true},"type":{"enum":["worker"],"type":"string","x-auditable":true}},"type":"object"},"nsc_AccountTag":{"description":"Customer account tag","type":"string"},"nsc_ApiBandwidth":{"description":"Bandwidth structure as visible through the customer-facing API.","enum":["50M","100M","200M","300M","400M","500M","1G","2G","5G","10G","20G","50G"],"type":"string"},"nsc_BgpControl":{"properties":{"customer_asn":{"description":"ASN used on the customer end of the BGP session","format":"int32","minimum":0,"type":"integer"},"extra_prefixes":{"description":"Extra set of static prefixes to advertise to the customer's end of the session","example":"192.168.3.4/31","items":{"format":"A.B.C.D/N","type":"string"},"type":"array"},"md5_key":{"description":"MD5 key to use for session authentication.\n\nNote that *this is not a security measure*. MD5 is not a valid security mechanism, and the\nkey is not treated as a secret value. This is *only* supported for preventing\nmisconfiguration, not for defending against malicious attacks.\n\nThe MD5 key, if set, must be of non-zero length and consist only of the following types of\ncharacter:\n\n* ASCII alphanumerics: `[a-zA-Z0-9]`\n* Special characters in the set `'!@#$%^\u0026*()+[]{}\u003c\u003e/.,;:_-~`= \\|`\n\nIn other words, MD5 keys may contain any printable ASCII character aside from newline (0x0A),\nquotation mark (`\"`), vertical tab (0x0B), carriage return (0x0D), tab (0x09), form feed\n(0x0C), and the question mark (`?`). Requests specifying an MD5 key with one or more of\nthese disallowed characters will be rejected.","nullable":true,"type":"string"}},"required":["customer_asn","extra_prefixes"],"type":"object"},"nsc_CloudflareSite":{"description":"A Cloudflare site name.","type":"string"},"nsc_Cni":{"properties":{"account":{"$ref":"#/components/schemas/nsc_AccountTag"},"bgp":{"$ref":"#/components/schemas/nsc_BgpControl"},"cust_ip":{"description":"Customer end of the point-to-point link\n\nThis should always be inside the same prefix as `p2p_ip`.","example":"192.168.3.4/31","format":"A.B.C.D/N","type":"string"},"id":{"format":"uuid","type":"string"},"interconnect":{"description":"Interconnect identifier hosting this CNI","type":"string"},"magic":{"$ref":"#/components/schemas/nsc_MagicSettings"},"p2p_ip":{"description":"Cloudflare end of the point-to-point link","example":"192.168.3.4/31","format":"A.B.C.D/N","type":"string"}},"required":["id","interconnect","account","p2p_ip","cust_ip","magic"],"type":"object"},"nsc_CniCreate":{"properties":{"account":{"$ref":"#/components/schemas/nsc_AccountTag"},"bgp":{"$ref":"#/components/schemas/nsc_BgpControl"},"interconnect":{"type":"string"},"magic":{"$ref":"#/components/schemas/nsc_MagicSettings"}},"required":["interconnect","account","magic"],"type":"object"},"nsc_CniList":{"properties":{"items":{"items":{"$ref":"#/components/schemas/nsc_Cni"},"type":"array"},"next":{"format":"int32","nullable":true,"type":"integer"}},"required":["items"],"type":"object"},"nsc_FacilityInfo":{"properties":{"address":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"}},"required":["name","address"],"type":"object"},"nsc_Interconnect":{"discriminator":{"mapping":{"direct":"#/components/schemas/nsc_Interconnect_Physical_Body","gcp_partner":"#/components/schemas/nsc_Interconnect_GcpPartner_Body"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/nsc_Interconnect_Physical_Body"},{"$ref":"#/components/schemas/nsc_Interconnect_GcpPartner_Body"}],"type":"object"},"nsc_InterconnectCreate":{"discriminator":{"mapping":{"direct":"#/components/schemas/nsc_InterconnectCreate_Physical_Body","gcp_partner":"#/components/schemas/nsc_InterconnectCreate_GcpPartner_Body"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/nsc_InterconnectCreate_Physical_Body"},{"$ref":"#/components/schemas/nsc_InterconnectCreate_GcpPartner_Body"}],"type":"object"},"nsc_InterconnectCreate_GcpPartner_Body":{"allOf":[{"properties":{"account":{"type":"string"},"type":{"type":"string"}},"required":["type","account"],"type":"object"},{"properties":{"bandwidth":{"$ref":"#/components/schemas/nsc_ApiBandwidth"},"pairing_key":{"description":"Pairing key provided by GCP","type":"string"}},"required":["pairing_key","bandwidth"],"type":"object"}],"title":"GcpPartner","type":"object"},"nsc_InterconnectCreate_Physical_Body":{"allOf":[{"properties":{"account":{"type":"string"},"type":{"type":"string"}},"required":["type","account"],"type":"object"},{"properties":{"slot_id":{"format":"uuid","type":"string"},"speed":{"nullable":true,"type":"string"}},"required":["slot_id"],"type":"object"}],"title":"Physical","type":"object"},"nsc_InterconnectList":{"properties":{"items":{"items":{"$ref":"#/components/schemas/nsc_Interconnect"},"type":"array"},"next":{"format":"int32","nullable":true,"type":"integer"}},"required":["items"],"type":"object"},"nsc_Interconnect_GcpPartner_Body":{"allOf":[{"properties":{"account":{"type":"string"},"name":{"type":"string"},"owner":{"type":"string"},"type":{"type":"string"}},"required":["type","name","account"],"type":"object"},{"properties":{"region":{"type":"string"},"speed":{"$ref":"#/components/schemas/nsc_ApiBandwidth"}},"required":["region"],"type":"object"}],"title":"GcpPartner","type":"object"},"nsc_Interconnect_Physical_Body":{"allOf":[{"properties":{"account":{"type":"string"},"name":{"type":"string"},"owner":{"type":"string"},"type":{"type":"string"}},"required":["type","name","account"],"type":"object"},{"properties":{"facility":{"$ref":"#/components/schemas/nsc_FacilityInfo"},"site":{"$ref":"#/components/schemas/nsc_CloudflareSite"},"slot_id":{"format":"uuid","type":"string"},"speed":{"type":"string"}},"required":["slot_id","site","speed","facility"],"type":"object"}],"title":"Physical","type":"object"},"nsc_MagicSettings":{"properties":{"conduit_name":{"type":"string"},"description":{"type":"string"},"mtu":{"format":"int32","minimum":0,"type":"integer"}},"required":["conduit_name","description","mtu"],"type":"object"},"nsc_Settings":{"properties":{"default_asn":{"format":"int32","minimum":0,"type":"integer"}},"required":["default_asn"],"type":"object"},"nsc_SettingsRequest":{"properties":{"default_asn":{"format":"int32","minimum":0,"nullable":true,"type":"integer"}},"type":"object"},"nsc_SlotInfo":{"properties":{"account":{"$ref":"#/components/schemas/nsc_AccountTag"},"facility":{"$ref":"#/components/schemas/nsc_FacilityInfo"},"id":{"description":"Slot ID","format":"uuid","type":"string"},"occupied":{"description":"Whether the slot is occupied or not","type":"boolean"},"site":{"type":"string"},"speed":{"type":"string"}},"required":["id","occupied","site","speed","facility"],"type":"object"},"nsc_SlotList":{"properties":{"items":{"items":{"$ref":"#/components/schemas/nsc_SlotInfo"},"type":"array"},"next":{"format":"int32","nullable":true,"type":"integer"}},"required":["items"],"type":"object"},"nsc_StatusInfo":{"discriminator":{"propertyName":"state"},"oneOf":[{"properties":{"state":{"enum":["Pending"],"type":"string"}},"required":["state"],"type":"object"},{"properties":{"reason":{"description":"Diagnostic information, if available","nullable":true,"type":"string"},"state":{"enum":["Down"],"type":"string"}},"required":["state"],"type":"object"},{"properties":{"reason":{"description":"Diagnostic information, if available","nullable":true,"type":"string"},"state":{"enum":["Unhealthy"],"type":"string"}},"required":["state"],"type":"object"},{"properties":{"state":{"enum":["Healthy"],"type":"string"}},"required":["state"],"type":"object"}],"type":"object"},"observatory_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/observatory_api-response-common"}],"type":"object"},"observatory_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/observatory_messages"},"messages":{"$ref":"#/components/schemas/observatory_messages"},"success":{"description":"Whether the API call was successful.","example":true,"type":"boolean","x-auditable":true}},"required":["success","errors","messages"],"type":"object"},"observatory_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/observatory_schemas-messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/observatory_schemas-messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"observatory_api-response-single":{"allOf":[{"$ref":"#/components/schemas/observatory_api-response-common"}],"type":"object"},"observatory_availabilities":{"properties":{"quota":{"properties":{"plan":{"description":"Cloudflare plan.","example":"free","type":"string","x-auditable":true},"quotasPerPlan":{"description":"The number of tests available per plan.","properties":{"value":{"$ref":"#/components/schemas/observatory_plan-properties-info"}},"type":"object"},"remainingSchedules":{"description":"The number of remaining schedules available.","example":1,"type":"number","x-auditable":true},"remainingTests":{"description":"The number of remaining tests available.","example":30,"type":"number","x-auditable":true},"scheduleQuotasPerPlan":{"description":"The number of schedules available per plan.","properties":{"value":{"$ref":"#/components/schemas/observatory_plan-properties-info"}},"type":"object"}},"type":"object"},"regions":{"items":{"$ref":"#/components/schemas/observatory_labeled_region"},"type":"array"},"regionsPerPlan":{"description":"Available regions.","properties":{"business":{"items":{"$ref":"#/components/schemas/observatory_labeled_region"},"type":"array"},"enterprise":{"items":{"$ref":"#/components/schemas/observatory_labeled_region"},"type":"array"},"free":{"items":{"$ref":"#/components/schemas/observatory_labeled_region"},"type":"array"},"pro":{"items":{"$ref":"#/components/schemas/observatory_labeled_region"},"type":"array"}},"type":"object"}},"type":"object"},"observatory_availabilities-response":{"allOf":[{"$ref":"#/components/schemas/observatory_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/observatory_availabilities"}},"type":"object"}]},"observatory_count-response":{"allOf":[{"$ref":"#/components/schemas/observatory_api-response-single"},{"properties":{"result":{"properties":{"count":{"description":"Number of items affected.","example":1,"type":"number","x-auditable":true}},"type":"object"}},"type":"object"}]},"observatory_create-schedule-response":{"allOf":[{"$ref":"#/components/schemas/observatory_api-response-single"},{"properties":{"result":{"properties":{"schedule":{"$ref":"#/components/schemas/observatory_schedule"},"test":{"$ref":"#/components/schemas/observatory_page_test"}},"type":"object"}},"type":"object"}]},"observatory_device_type":{"description":"The type of device.","enum":["DESKTOP","MOBILE"],"example":"DESKTOP","type":"string","x-auditable":true},"observatory_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"observatory_labeled_region":{"description":"A test region with a label.","properties":{"label":{"example":"Iowa, USA","type":"string","x-auditable":true},"value":{"$ref":"#/components/schemas/observatory_region"}},"type":"object"},"observatory_lighthouse_error_code":{"description":"The error code of the Lighthouse result.","enum":["NOT_REACHABLE","DNS_FAILURE","NOT_HTML","LIGHTHOUSE_TIMEOUT","UNKNOWN"],"example":"NOT_REACHABLE","type":"string","x-auditable":true},"observatory_lighthouse_report":{"description":"The Lighthouse report.","properties":{"cls":{"description":"Cumulative Layout Shift.","example":100,"type":"number","x-auditable":true},"deviceType":{"$ref":"#/components/schemas/observatory_device_type"},"error":{"properties":{"code":{"$ref":"#/components/schemas/observatory_lighthouse_error_code"},"detail":{"description":"Detailed error message.","example":"Details: net::ERR_CONNECTION_CLOSED","type":"string","x-auditable":true},"finalDisplayedUrl":{"description":"The final URL displayed to the user.","example":"example.com","type":"string","x-auditable":true}},"type":"object"},"fcp":{"description":"First Contentful Paint.","example":100,"type":"number","x-auditable":true},"jsonReportUrl":{"description":"The URL to the full Lighthouse JSON report.","type":"string","x-auditable":true},"lcp":{"description":"Largest Contentful Paint.","example":100,"type":"number","x-auditable":true},"performanceScore":{"description":"The Lighthouse performance score.","example":90,"type":"number","x-auditable":true},"si":{"description":"Speed Index.","example":100,"type":"number","x-auditable":true},"state":{"$ref":"#/components/schemas/observatory_lighthouse_state"},"tbt":{"description":"Total Blocking Time.","example":100,"type":"number","x-auditable":true},"ttfb":{"description":"Time To First Byte.","example":100,"type":"number","x-auditable":true},"tti":{"description":"Time To Interactive.","example":100,"type":"number","x-auditable":true}},"type":"object"},"observatory_lighthouse_state":{"description":"The state of the Lighthouse report.","enum":["RUNNING","COMPLETE","FAILED"],"example":"COMPLETE","type":"string","x-auditable":true},"observatory_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer","x-auditable":true},"message":{"type":"string","x-auditable":true}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"observatory_page-test-response-collection":{"allOf":[{"$ref":"#/components/schemas/observatory_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/observatory_page_test"},"type":"array"}},"type":"object"},{"properties":{"result_info":{"$ref":"#/components/schemas/observatory_result_info"}},"type":"object"}]},"observatory_page-test-response-single":{"allOf":[{"$ref":"#/components/schemas/observatory_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/observatory_page_test"}},"type":"object"}]},"observatory_page_test":{"properties":{"date":{"$ref":"#/components/schemas/observatory_timestamp"},"desktopReport":{"$ref":"#/components/schemas/observatory_lighthouse_report"},"id":{"$ref":"#/components/schemas/observatory_uuid"},"mobileReport":{"$ref":"#/components/schemas/observatory_lighthouse_report"},"region":{"$ref":"#/components/schemas/observatory_labeled_region"},"scheduleFrequency":{"$ref":"#/components/schemas/observatory_schedule_frequency"},"url":{"$ref":"#/components/schemas/observatory_url"}},"type":"object"},"observatory_pages-response-collection":{"allOf":[{"$ref":"#/components/schemas/observatory_api-response-collection"},{"properties":{"result":{"items":{"properties":{"region":{"$ref":"#/components/schemas/observatory_labeled_region"},"scheduleFrequency":{"$ref":"#/components/schemas/observatory_schedule_frequency"},"tests":{"items":{"$ref":"#/components/schemas/observatory_page_test"},"type":"array"},"url":{"$ref":"#/components/schemas/observatory_url"}},"type":"object"},"type":"array"}},"type":"object"}]},"observatory_plan-properties-info":{"description":"Counts per account plan.","properties":{"business":{"example":1,"type":"integer","x-auditable":true},"enterprise":{"example":1,"type":"integer","x-auditable":true},"free":{"example":1,"type":"integer","x-auditable":true},"pro":{"example":1,"type":"integer","x-auditable":true}},"type":"object"},"observatory_region":{"description":"A test region.","enum":["asia-east1","asia-northeast1","asia-northeast2","asia-south1","asia-southeast1","australia-southeast1","europe-north1","europe-southwest1","europe-west1","europe-west2","europe-west3","europe-west4","europe-west8","europe-west9","me-west1","southamerica-east1","us-central1","us-east1","us-east4","us-south1","us-west1"],"example":"us-central1","type":"string","x-auditable":true},"observatory_result_info":{"properties":{"count":{"example":5,"type":"integer","x-auditable":true},"page":{"example":1,"type":"integer","x-auditable":true},"per_page":{"example":5,"type":"integer","x-auditable":true},"total_count":{"example":3,"type":"integer","x-auditable":true}},"type":"object"},"observatory_schedule":{"description":"The test schedule.","properties":{"frequency":{"$ref":"#/components/schemas/observatory_schedule_frequency"},"region":{"$ref":"#/components/schemas/observatory_region"},"url":{"$ref":"#/components/schemas/observatory_url"}},"type":"object"},"observatory_schedule-response-single":{"allOf":[{"$ref":"#/components/schemas/observatory_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/observatory_schedule"}},"type":"object"}]},"observatory_schedule_frequency":{"description":"The frequency of the test.","enum":["DAILY","WEEKLY"],"example":"DAILY","type":"string","x-auditable":true},"observatory_schemas-messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"observatory_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true},"observatory_trend":{"properties":{"cls":{"description":"Cumulative Layout Shift trend.","items":{"nullable":true,"type":"number","x-auditable":true},"type":"array"},"fcp":{"description":"First Contentful Paint trend.","items":{"nullable":true,"type":"number","x-auditable":true},"type":"array"},"lcp":{"description":"Largest Contentful Paint trend.","items":{"nullable":true,"type":"number","x-auditable":true},"type":"array"},"performanceScore":{"description":"The Lighthouse score trend.","items":{"nullable":true,"type":"number","x-auditable":true},"type":"array"},"si":{"description":"Speed Index trend.","items":{"nullable":true,"type":"number","x-auditable":true},"type":"array"},"tbt":{"description":"Total Blocking Time trend.","items":{"nullable":true,"type":"number","x-auditable":true},"type":"array"},"ttfb":{"description":"Time To First Byte trend.","items":{"nullable":true,"type":"number","x-auditable":true},"type":"array"},"tti":{"description":"Time To Interactive trend.","items":{"nullable":true,"type":"number","x-auditable":true},"type":"array"}},"type":"object"},"observatory_trend-response":{"allOf":[{"$ref":"#/components/schemas/observatory_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/observatory_trend"}},"type":"object"}]},"observatory_url":{"description":"A URL.","example":"example.com","type":"string","x-auditable":true},"observatory_uuid":{"description":"UUID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string","x-auditable":true},"organizations-api_Account":{"properties":{"created_on":{"format":"date-time","type":"string"},"id":{"type":"string"},"name":{"nullable":true,"type":"string"},"settings":{"properties":{"abuse_contact_email":{"nullable":true,"type":"string"},"access_approval_expiry":{"format":"date-time","nullable":true,"type":"string"},"api_access_enabled":{"nullable":true,"type":"boolean"},"default_nameservers":{"deprecated":true,"description":"Use [DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings) instead. Deprecated.","nullable":true,"type":"string"},"enforce_twofactor":{"nullable":true,"type":"boolean"},"use_account_custom_ns_by_default":{"deprecated":true,"description":"Use [DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings) instead. Deprecated.","nullable":true,"type":"boolean"}},"required":["enforce_twofactor","api_access_enabled","access_approval_expiry","abuse_contact_email","use_account_custom_ns_by_default","default_nameservers"],"type":"object"},"type":{"enum":["standard","enterprise"],"type":"string"}},"required":["id","name","type","settings","created_on"],"type":"object"},"organizations-api_BatchAccountMoveResponse":{"properties":{"statuses":{"properties":{"message":{"type":"string"},"moved":{"type":"boolean"},"tag":{"type":"string"}},"required":["tag","moved"],"type":"object"}},"required":["statuses"],"type":"object"},"organizations-api_BatchCreateMembersRequest":{"properties":{"members":{"items":{"$ref":"#/components/schemas/organizations-api_CreateSingleMember"},"type":"array"}},"required":["members"],"type":"object"},"organizations-api_BoolAllocation":{"properties":{"type":{"enum":["bool"],"type":"string"},"value":{"type":"boolean"}},"required":["type","value"],"type":"object"},"organizations-api_CreateMemberRequest":{"properties":{"member":{"$ref":"#/components/schemas/organizations-api_CreateSingleMember"}},"required":["member"],"type":"object"},"organizations-api_CreateSingleMember":{"properties":{"status":{"enum":["active","canceled"],"type":"string"},"user":{"properties":{"email":{"type":"string"}},"required":["email"],"type":"object"}},"required":["user"],"type":"object"},"organizations-api_DeleteOrganizationResponse":{"properties":{"id":{"type":"string"}},"required":["id"],"type":"object"},"organizations-api_Entitlement":{"properties":{"allocation":{"anyOf":[{"$ref":"#/components/schemas/organizations-api_MaxCountAllocation"},{"$ref":"#/components/schemas/organizations-api_BoolAllocation"},{"$ref":"#/components/schemas/organizations-api_NullAllocation"}]},"feature":{"$ref":"#/components/schemas/organizations-api_Feature"}},"required":["feature","allocation"],"type":"object"},"organizations-api_Feature":{"properties":{"key":{"type":"string"}},"required":["key"],"type":"object"},"organizations-api_InnateEntitlements":{"properties":{"allow_add_subdomain":{"$ref":"#/components/schemas/organizations-api_BoolAllocation"},"allow_auto_accept_invites":{"$ref":"#/components/schemas/organizations-api_BoolAllocation"},"cname_setup_allowed":{"$ref":"#/components/schemas/organizations-api_BoolAllocation"},"custom_entitlements":{"items":{"$ref":"#/components/schemas/organizations-api_Entitlement"},"nullable":true,"type":"array"},"mhs_certificate_count":{"$ref":"#/components/schemas/organizations-api_MaxCountAllocation"},"partial_setup_allowed":{"$ref":"#/components/schemas/organizations-api_BoolAllocation"}},"required":["allow_add_subdomain","cname_setup_allowed","partial_setup_allowed","allow_auto_accept_invites","mhs_certificate_count","custom_entitlements"],"type":"object"},"organizations-api_MaxCountAllocation":{"properties":{"type":{"enum":["max_count"],"type":"string"},"value":{"type":"integer"}},"required":["type","value"],"type":"object"},"organizations-api_Member":{"properties":{"create_time":{"format":"date-time","type":"string"},"id":{"$ref":"#/components/schemas/organizations-api_MemberID"},"meta":{"additionalProperties":{"type":"object"},"type":"object"},"status":{"enum":["active","canceled"],"type":"string"},"update_time":{"format":"date-time","type":"string"},"user":{"$ref":"#/components/schemas/organizations-api_MemberSubjectUser"}},"required":["id","status","user","meta","create_time","update_time"],"type":"object"},"organizations-api_MemberID":{"description":"Organization Member ID","example":"a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8","pattern":"^[a-f0-9]{32}$","type":"string"},"organizations-api_MemberSubjectUser":{"properties":{"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"two_factor_authentication_enabled":{"type":"boolean"}},"required":["id","email","name","two_factor_authentication_enabled"],"type":"object"},"organizations-api_MoveAccountResponse":{"properties":{"account_id":{"type":"string"},"destination_organization_id":{"type":"string"},"source_organization_id":{"type":"string"}},"required":["account_id","source_organization_id","destination_organization_id"],"type":"object"},"organizations-api_NullAllocation":{"properties":{"type":{"enum":[""],"type":"string"},"value":{"type":"object"}},"required":["type"],"type":"object"},"organizations-api_Organization":{"description":"References an Organization in the Cloudflare data model.","properties":{"create_time":{"format":"date-time","readOnly":true,"type":"string"},"id":{"allOf":[{"$ref":"#/components/schemas/organizations-api_OrganizationID"}],"readOnly":true},"meta":{"additionalProperties":{"type":"object"},"properties":{"flags":{"allOf":[{"$ref":"#/components/schemas/organizations-api_OrganizationFlags"}]},"managed_by":{"type":"string"}},"readOnly":true,"type":"object"},"name":{"type":"string"},"parent":{"properties":{"id":{"$ref":"#/components/schemas/organizations-api_OrganizationID"},"name":{"readOnly":true,"type":"string"}},"required":["id","name"],"type":"object"},"profile":{"$ref":"#/components/schemas/organizations-api_Profile"}},"required":["id","name","create_time","meta"],"type":"object"},"organizations-api_OrganizationFlags":{"description":"Enable features for Organizations.","properties":{"account_creation":{"type":"string"},"account_deletion":{"type":"string"},"account_migration":{"type":"string"},"account_mobility":{"type":"string"},"sub_org_creation":{"type":"string"}},"required":["account_creation","account_deletion","account_migration","account_mobility","sub_org_creation"],"type":"object"},"organizations-api_OrganizationID":{"example":"a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8","pattern":"^[a-f0-9]{32}$","title":"Organization ID","type":"string"},"organizations-api_PageTokenResultInfo":{"properties":{"next_page_token":{"description":"Use this opaque token in the next request to retrieve the\nnext page.\n\nParameters used to filter the retrieved list must remain in subsequent\nrequests with a page token.","type":"string"},"total_size":{"description":"Counts the total amount of items in a list with the applied filters. The API omits next_page_token to indicate no more items in a particular list.","type":"integer"}},"type":"object"},"organizations-api_Profile":{"properties":{"business_address":{"type":"string"},"business_email":{"type":"string"},"business_name":{"type":"string"},"business_phone":{"type":"string"},"external_metadata":{"type":"string"}},"required":["business_name","business_email","business_phone","business_address","external_metadata"],"type":"object"},"organizations-api_Tenant":{"properties":{"cdate":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"edate":{"format":"date-time","type":"string"},"tenant_contacts":{"properties":{"email":{"type":"string"},"website":{"type":"string"}},"type":"object"},"tenant_labels":{"items":{"type":"string"},"type":"array"},"tenant_metadata":{"properties":{"dns":{"properties":{"ns_pool":{"properties":{"primary":{"type":"string"},"secondary":{"type":"string"}},"type":"object"}},"required":["ns_pool"],"type":"object"}},"type":"object"},"tenant_name":{"type":"string"},"tenant_network":{"type":"object"},"tenant_status":{"type":"string"},"tenant_tag":{"type":"string"},"tenant_type":{"type":"string"},"tenant_units":{"items":{"$ref":"#/components/schemas/organizations-api_TenantUnit"},"type":"array"}},"required":["tenant_tag","tenant_name","tenant_labels","tenant_type","tenant_status","tenant_metadata","tenant_contacts","cdate","edate","tenant_network","tenant_units"],"type":"object"},"organizations-api_TenantMembership":{"properties":{"user_email":{"type":"string"},"user_name":{"type":"string"},"user_tag":{"type":"string"}},"required":["user_tag","user_email","user_name"],"type":"object"},"organizations-api_TenantUnit":{"properties":{"unit_memberships":{"items":{"type":"object"},"type":"array"},"unit_metadata":{"type":"object"},"unit_name":{"type":"string"},"unit_status":{"type":"string"},"unit_tag":{"type":"string"}},"required":["unit_tag","unit_name","unit_status","unit_metadata","unit_memberships"],"type":"object"},"organizations-api_V4ErrorResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"organizations-api_V4Message":{"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"page-shield_api-get-response-collection":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-response-common"},{"properties":{"result":{"nullable":true,"type":"object"}}}],"type":"object"},"page-shield_api-list-response-collection":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-response-common"},{"properties":{"result_info":{"$ref":"#/components/schemas/page-shield_result_info"}},"required":["result_info"]}],"type":"object"},"page-shield_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/page-shield_messages"},"messages":{"$ref":"#/components/schemas/page-shield_messages"},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success"],"type":"object"},"page-shield_api-response-common-failure":{"properties":{"errors":{"$ref":"#/components/schemas/page-shield_messages"},"messages":{"$ref":"#/components/schemas/page-shield_messages"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors"],"type":"object"},"page-shield_api-response-single":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-response-common"},{"properties":{"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]}}}],"type":"object"},"page-shield_connection":{"properties":{"added_at":{"example":"2021-08-18T10:51:10.09615Z","format":"date-time","type":"string"},"domain_reported_malicious":{"example":false,"type":"boolean"},"first_page_url":{"example":"blog.cloudflare.com/page","type":"string"},"first_seen_at":{"example":"2021-08-18T10:51:08Z","format":"date-time","type":"string"},"host":{"example":"blog.cloudflare.com","type":"string"},"id":{"$ref":"#/components/schemas/page-shield_id"},"last_seen_at":{"example":"2021-09-02T09:57:54Z","format":"date-time","type":"string"},"malicious_domain_categories":{"example":["Malware"],"items":{"type":"string"},"type":"array"},"malicious_url_categories":{"example":["Malware"],"items":{"type":"string"},"type":"array"},"page_urls":{"example":["blog.cloudflare.com/page1","blog.cloudflare.com/page2"],"items":{"type":"string"},"type":"array"},"url":{"example":"https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js","type":"string"},"url_contains_cdn_cgi_path":{"example":false,"type":"boolean"},"url_reported_malicious":{"example":false,"type":"boolean"}},"required":["id","url","added_at","first_seen_at","last_seen_at","host","url_contains_cdn_cgi_path"]},"page-shield_cookie":{"properties":{"domain_attribute":{"example":"cloudflare.com","type":"string"},"expires_attribute":{"example":"2021-10-02T09:57:54Z","format":"date-time","type":"string"},"first_seen_at":{"example":"2021-08-18T10:51:08Z","format":"date-time","type":"string"},"host":{"example":"blog.cloudflare.com","type":"string"},"http_only_attribute":{"example":true,"type":"boolean"},"id":{"$ref":"#/components/schemas/page-shield_id"},"last_seen_at":{"example":"2021-09-02T09:57:54Z","format":"date-time","type":"string"},"max_age_attribute":{"example":3600,"type":"integer"},"name":{"example":"session_id","type":"string"},"page_urls":{"example":["blog.cloudflare.com/page1","blog.cloudflare.com/page2"],"items":{"type":"string"},"type":"array"},"path_attribute":{"example":"/","type":"string"},"same_site_attribute":{"enum":["lax","strict","none"],"example":"strict","type":"string"},"secure_attribute":{"example":true,"type":"boolean"},"type":{"enum":["first_party","unknown"],"example":"first_party","type":"string"}},"required":["id","type","name","host","first_seen_at","last_seen_at"]},"page-shield_cryptomining_score":{"description":"The cryptomining score of the JavaScript content.","maximum":99,"minimum":1,"nullable":true,"type":"integer"},"page-shield_dataflow_score":{"description":"The dataflow score of the JavaScript content.","maximum":99,"minimum":1,"nullable":true,"type":"integer"},"page-shield_enabled":{"description":"When true, indicates that Page Shield is enabled.","example":true,"type":"boolean","x-auditable":true},"page-shield_fetched_at":{"description":"The timestamp of when the script was last fetched.","nullable":true,"type":"string"},"page-shield_get-zone-connection-response":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-get-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/page-shield_connection"}},"required":["result"]}]},"page-shield_get-zone-cookie-response":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-get-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/page-shield_cookie"}},"required":["result"]}]},"page-shield_get-zone-policy-response":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-get-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/page-shield_policy-with-id"}},"required":["result"]}]},"page-shield_get-zone-script-response":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-get-response-collection"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/page-shield_script"},{"properties":{"versions":{"example":[{"cryptomining_score":20,"dataflow_score":2,"fetched_at":"2021-08-18T10:51:08Z","hash":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b423","js_integrity_score":2,"magecart_score":10,"malware_score":5,"obfuscation_score":10}],"items":{"$ref":"#/components/schemas/page-shield_version"},"nullable":true,"type":"array"}}}]}},"required":["result"]}]},"page-shield_get-zone-settings-response":{"properties":{"enabled":{"$ref":"#/components/schemas/page-shield_enabled"},"updated_at":{"$ref":"#/components/schemas/page-shield_updated_at"},"use_cloudflare_reporting_endpoint":{"$ref":"#/components/schemas/page-shield_use_cloudflare_reporting_endpoint"},"use_connection_url_path":{"$ref":"#/components/schemas/page-shield_use_connection_url_path"}},"required":["enabled","updated_at","use_cloudflare_reporting_endpoint","use_connection_url_path"]},"page-shield_hash":{"description":"The computed hash of the analyzed script.","maxLength":64,"minLength":64,"nullable":true,"type":"string"},"page-shield_id":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"page-shield_js_integrity_score":{"description":"The integrity score of the JavaScript content.","maximum":99,"minimum":1,"nullable":true,"type":"integer"},"page-shield_list-zone-connections-response":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-list-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/page-shield_connection"},"type":"array"}},"type":"object"}]},"page-shield_list-zone-cookies-response":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-list-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/page-shield_cookie"},"type":"array"}},"required":["result"],"type":"object"}]},"page-shield_list-zone-policies-response":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-list-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/page-shield_policy-with-id"},"type":"array"}},"required":["result"],"type":"object"}]},"page-shield_list-zone-scripts-response":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-list-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/page-shield_script"},"type":"array"}},"required":["result"],"type":"object"}]},"page-shield_magecart_score":{"description":"The magecart score of the JavaScript content.","maximum":99,"minimum":1,"nullable":true,"type":"integer"},"page-shield_malware_score":{"description":"The malware score of the JavaScript content.","maximum":99,"minimum":1,"nullable":true,"type":"integer"},"page-shield_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"page-shield_obfuscation_score":{"description":"The obfuscation score of the JavaScript content.","maximum":99,"minimum":1,"nullable":true,"type":"integer"},"page-shield_policy":{"properties":{"action":{"$ref":"#/components/schemas/page-shield_policy-action"},"description":{"$ref":"#/components/schemas/page-shield_policy-description"},"enabled":{"$ref":"#/components/schemas/page-shield_policy-enabled"},"expression":{"$ref":"#/components/schemas/page-shield_policy-expression"},"value":{"$ref":"#/components/schemas/page-shield_policy-value"}},"required":["description","action","expression","enabled","value"]},"page-shield_policy-action":{"description":"The action to take if the expression matches","enum":["allow","log"],"example":"allow","type":"string","x-auditable":true},"page-shield_policy-description":{"description":"A description for the policy","example":"Checkout page CSP policy","type":"string","x-auditable":true},"page-shield_policy-enabled":{"description":"Whether the policy is enabled","example":true,"type":"boolean","x-auditable":true},"page-shield_policy-expression":{"description":"The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax","example":"ends_with(http.request.uri.path, \"/checkout\")","type":"string","x-auditable":true},"page-shield_policy-value":{"description":"The policy which will be applied","example":"script-src 'none';","type":"string","x-auditable":true},"page-shield_policy-with-id":{"allOf":[{"$ref":"#/components/schemas/page-shield_policy"},{"properties":{"id":{"$ref":"#/components/schemas/page-shield_id"}},"required":["id"]}],"required":["id","description","action","expression","enabled","value"]},"page-shield_result_info":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters","example":2000,"type":"number"},"total_pages":{"description":"Total number of pages","example":100,"type":"number"}},"required":["page","per_page","count","total_count","total_pages"],"type":"object"},"page-shield_script":{"properties":{"added_at":{"example":"2021-08-18T10:51:10.09615Z","format":"date-time","type":"string"},"cryptomining_score":{"$ref":"#/components/schemas/page-shield_cryptomining_score"},"dataflow_score":{"$ref":"#/components/schemas/page-shield_dataflow_score"},"domain_reported_malicious":{"example":false,"type":"boolean"},"fetched_at":{"$ref":"#/components/schemas/page-shield_fetched_at"},"first_page_url":{"example":"blog.cloudflare.com/page","type":"string"},"first_seen_at":{"example":"2021-08-18T10:51:08Z","format":"date-time","type":"string"},"hash":{"$ref":"#/components/schemas/page-shield_hash"},"host":{"example":"blog.cloudflare.com","type":"string"},"id":{"$ref":"#/components/schemas/page-shield_id"},"js_integrity_score":{"$ref":"#/components/schemas/page-shield_js_integrity_score"},"last_seen_at":{"example":"2021-09-02T09:57:54Z","format":"date-time","type":"string"},"magecart_score":{"$ref":"#/components/schemas/page-shield_magecart_score"},"malicious_domain_categories":{"example":["Malware"],"items":{"type":"string"},"type":"array"},"malicious_url_categories":{"example":["Malware"],"items":{"type":"string"},"type":"array"},"malware_score":{"$ref":"#/components/schemas/page-shield_malware_score"},"obfuscation_score":{"$ref":"#/components/schemas/page-shield_obfuscation_score"},"page_urls":{"example":["blog.cloudflare.com/page1","blog.cloudflare.com/page2"],"items":{"type":"string"},"type":"array"},"url":{"example":"https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js","type":"string"},"url_contains_cdn_cgi_path":{"example":false,"type":"boolean"},"url_reported_malicious":{"example":false,"type":"boolean"}},"required":["id","url","added_at","first_seen_at","last_seen_at","host","url_contains_cdn_cgi_path"]},"page-shield_update-zone-settings-response":{"properties":{"enabled":{"$ref":"#/components/schemas/page-shield_enabled"},"updated_at":{"$ref":"#/components/schemas/page-shield_updated_at"},"use_cloudflare_reporting_endpoint":{"$ref":"#/components/schemas/page-shield_use_cloudflare_reporting_endpoint"},"use_connection_url_path":{"$ref":"#/components/schemas/page-shield_use_connection_url_path"}},"required":["enabled","updated_at","use_cloudflare_reporting_endpoint","use_connection_url_path"]},"page-shield_updated_at":{"description":"The timestamp of when Page Shield was last updated.","example":"2022-10-12T17:56:52.083582+01:00","type":"string","x-auditable":true},"page-shield_use_cloudflare_reporting_endpoint":{"description":"When true, CSP reports will be sent to https://csp-reporting.cloudflare.com/cdn-cgi/script_monitor/report","example":true,"type":"boolean","x-auditable":true},"page-shield_use_connection_url_path":{"description":"When true, the paths associated with connections URLs will also be analyzed.","example":true,"type":"boolean","x-auditable":true},"page-shield_version":{"description":"The version of the analyzed script.","properties":{"cryptomining_score":{"$ref":"#/components/schemas/page-shield_cryptomining_score"},"dataflow_score":{"$ref":"#/components/schemas/page-shield_dataflow_score"},"fetched_at":{"$ref":"#/components/schemas/page-shield_fetched_at"},"hash":{"$ref":"#/components/schemas/page-shield_hash"},"js_integrity_score":{"$ref":"#/components/schemas/page-shield_js_integrity_score"},"magecart_score":{"$ref":"#/components/schemas/page-shield_magecart_score"},"malware_score":{"$ref":"#/components/schemas/page-shield_malware_score"},"obfuscation_score":{"$ref":"#/components/schemas/page-shield_obfuscation_score"}},"type":"object"},"page-shield_zone_settings_response_single":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-response-single"},{"properties":{"result":{"type":"object"}}}]},"pages_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"pages_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/pages_messages"},"messages":{"$ref":"#/components/schemas/pages_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"pages_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/pages_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/pages_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"pages_build_config":{"description":"Configs for the project build process.","properties":{"build_caching":{"description":"Enable build caching for the project.","example":true,"nullable":true,"type":"boolean","x-auditable":true},"build_command":{"description":"Command used to build project.","example":"npm run build","nullable":true,"type":"string","x-auditable":true},"destination_dir":{"description":"Assets output directory of the build.","example":"build","nullable":true,"type":"string","x-auditable":true},"root_dir":{"description":"Directory to run the command.","example":"/","nullable":true,"type":"string","x-auditable":true},"web_analytics_tag":{"description":"The classifying tag for analytics.","example":"cee1c73f6e4743d0b5e6bb1a0bcaabcc","nullable":true,"type":"string","x-auditable":true},"web_analytics_token":{"description":"The auth token for analytics.","example":"021e1057c18547eca7b79f2516f06o7x","nullable":true,"type":"string","x-sensitive":true}},"required":["web_analytics_tag","web_analytics_token"],"type":"object"},"pages_deployment":{"properties":{"aliases":{"description":"A list of alias URLs pointing to this deployment.","example":["https://branchname.projectname.pages.dev"],"items":{"type":"string","x-auditable":true},"nullable":true,"readOnly":true,"type":"array"},"build_config":{"$ref":"#/components/schemas/pages_build_config"},"created_on":{"description":"When the deployment was created.","example":"2021-03-09T00:55:03.923456Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"deployment_trigger":{"description":"Info about what caused the deployment.","properties":{"metadata":{"description":"Additional info about the trigger.","properties":{"branch":{"description":"Where the trigger happened.","example":"main","type":"string","x-auditable":true},"commit_dirty":{"description":"Whether the deployment trigger commit was dirty.","example":false,"type":"boolean","x-auditable":true},"commit_hash":{"description":"Hash of the deployment trigger commit.","example":"ad9ccd918a81025731e10e40267e11273a263421","type":"string","x-auditable":true},"commit_message":{"description":"Message of the deployment trigger commit.","example":"Update index.html","type":"string","x-auditable":true}},"required":["branch","commit_hash","commit_message","commit_dirty"],"type":"object"},"type":{"description":"What caused the deployment.","enum":["github:push","ad_hoc","deploy_hook"],"example":"ad_hoc","type":"string","x-auditable":true}},"readOnly":true,"required":["type","metadata"],"type":"object"},"env_vars":{"$ref":"#/components/schemas/pages_env_vars"},"environment":{"description":"Type of deploy.","enum":["preview","production"],"example":"preview","readOnly":true,"type":"string","x-auditable":true},"id":{"description":"Id of the deployment.","example":"f64788e9-fccd-4d4a-a28a-cb84f88f6","readOnly":true,"type":"string","x-auditable":true},"is_skipped":{"description":"If the deployment has been skipped.","example":true,"readOnly":true,"type":"boolean","x-auditable":true},"latest_stage":{"$ref":"#/components/schemas/pages_stage"},"modified_on":{"description":"When the deployment was last modified.","example":"2021-03-09T00:58:59.045655","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"project_id":{"description":"Id of the project.","example":"7b162ea7-7367-4d67-bcde-1160995d5","readOnly":true,"type":"string","x-auditable":true},"project_name":{"$ref":"#/components/schemas/pages_project_name"},"short_id":{"description":"Short Id (8 character) of the deployment.","example":"f64788e9","readOnly":true,"type":"string","x-auditable":true},"source":{"$ref":"#/components/schemas/pages_source"},"stages":{"description":"List of past stages.","example":[{"ended_on":"2021-06-03T15:39:03.134378Z","name":"queued","started_on":"2021-06-03T15:38:15.608194Z","status":"active"},{"ended_on":null,"name":"initialize","started_on":null,"status":"idle"},{"ended_on":null,"name":"clone_repo","started_on":null,"status":"idle"},{"ended_on":null,"name":"build","started_on":null,"status":"idle"},{"ended_on":null,"name":"deploy","started_on":null,"status":"idle"}],"items":{"$ref":"#/components/schemas/pages_stage"},"readOnly":true,"type":"array"},"url":{"description":"The live URL to view this deployment.","example":"https://f64788e9.ninjakittens.pages.dev","readOnly":true,"type":"string","x-auditable":true},"uses_functions":{"description":"Whether the deployment uses functions.","nullable":true,"readOnly":true,"type":"boolean","x-auditable":true}},"required":["aliases","build_config","created_on","deployment_trigger","environment","env_vars","id","is_skipped","latest_stage","modified_on","project_id","project_name","short_id","source","stages","url"],"type":"object"},"pages_deployment_config_values":{"properties":{"ai_bindings":{"additionalProperties":{"description":"AI binding.","properties":{"project_id":{"type":"string","x-auditable":true}},"required":["project_id"],"type":"object"},"description":"Constellation bindings used for Pages Functions.","example":{"AI_BINDING":{"project_id":"some-project-id"}},"type":"object"},"always_use_latest_compatibility_date":{"description":"Whether to always use the latest compatibility date for Pages Functions.","example":false,"type":"boolean","x-auditable":true},"analytics_engine_datasets":{"additionalProperties":{"description":"Analytics Engine binding.","properties":{"dataset":{"description":"Name of the dataset.","example":"api_analytics","type":"string","x-auditable":true}},"required":["dataset"],"type":"object"},"description":"Analytics Engine bindings used for Pages Functions.","example":{"ANALYTICS_ENGINE_BINDING":{"dataset":"api_analytics"}},"type":"object"},"browsers":{"additionalProperties":{"description":"Browser binding.","nullable":true,"type":"object","x-stainless-empty-object":true},"description":"Browser bindings used for Pages Functions.","example":{"BROWSER":{}},"type":"object"},"build_image_major_version":{"description":"The major version of the build image to use for Pages Functions.","example":3,"type":"integer","x-auditable":true},"compatibility_date":{"description":"Compatibility date used for Pages Functions.","example":"2025-01-01","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"compatibility_flags":{"description":"Compatibility flags used for Pages Functions.","example":["url_standard"],"items":{"type":"string","x-auditable":true},"type":"array"},"d1_databases":{"additionalProperties":{"description":"D1 binding.","properties":{"id":{"description":"UUID of the D1 database.","example":"445e2955-951a-43f8-a35b-a4d0c8138f63","type":"string","x-auditable":true}},"required":["id"],"type":"object"},"description":"D1 databases used for Pages Functions.","example":{"D1_BINDING":{"id":"445e2955-951a-43f8-a35b-a4d0c8138f63"}},"type":"object"},"durable_object_namespaces":{"additionalProperties":{"description":"Durable Object binding.","properties":{"namespace_id":{"description":"ID of the Durable Object namespace.","example":"5eb63bbbe01eeed093cb22bb8f5acdc3","type":"string","x-auditable":true}},"required":["namespace_id"],"type":"object"},"description":"Durable Object namespaces used for Pages Functions.","example":{"DO_BINDING":{"namespace_id":"5eb63bbbe01eeed093cb22bb8f5acdc3"}},"type":"object"},"env_vars":{"$ref":"#/components/schemas/pages_env_vars"},"fail_open":{"description":"Whether to fail open when the deployment config cannot be applied.","example":true,"type":"boolean","x-auditable":true},"hyperdrive_bindings":{"additionalProperties":{"description":"Hyperdrive binding.","properties":{"id":{"example":"a76a99bc342644deb02c38d66082262a","type":"string","x-auditable":true}},"required":["id"],"type":"object"},"description":"Hyperdrive bindings used for Pages Functions.","example":{"HYPERDRIVE":{"id":"a76a99bc342644deb02c38d66082262a"}},"type":"object"},"kv_namespaces":{"additionalProperties":{"description":"KV namespace binding.","properties":{"namespace_id":{"description":"ID of the KV namespace.","example":"5eb63bbbe01eeed093cb22bb8f5acdc3","type":"string","x-auditable":true}},"required":["namespace_id"],"type":"object"},"description":"KV namespaces used for Pages Functions.","example":{"KV_BINDING":{"namespace_id":"5eb63bbbe01eeed093cb22bb8f5acdc3"}},"type":"object"},"limits":{"description":"Limits for Pages Functions.","example":{"cpu_ms":100},"properties":{"cpu_ms":{"description":"CPU time limit in milliseconds.","example":100,"type":"integer","x-auditable":true}},"required":["cpu_ms"],"type":"object"},"mtls_certificates":{"additionalProperties":{"description":"mTLS binding.","properties":{"certificate_id":{"example":"d7cdd17c-916f-4cb7-aabe-585eb382ec4e","type":"string","x-auditable":true}},"required":["certificate_id"],"type":"object"},"description":"mTLS bindings used for Pages Functions.","example":{"MTLS":{"certificate_id":"d7cdd17c-916f-4cb7-aabe-585eb382ec4e"}},"type":"object"},"placement":{"description":"Placement setting used for Pages Functions.","example":{"mode":"smart"},"properties":{"mode":{"description":"Placement mode.","example":"smart","type":"string","x-auditable":true}},"required":["mode"],"type":"object"},"queue_producers":{"additionalProperties":{"description":"Queue Producer binding.","properties":{"name":{"description":"Name of the Queue.","example":"some-queue","type":"string","x-auditable":true}},"required":["name"],"type":"object"},"description":"Queue Producer bindings used for Pages Functions.","example":{"QUEUE_PRODUCER_BINDING":{"name":"some-queue"}},"type":"object"},"r2_buckets":{"additionalProperties":{"description":"R2 binding.","properties":{"jurisdiction":{"description":"Jurisdiction of the R2 bucket.","example":"eu","nullable":true,"type":"string","x-auditable":true},"name":{"description":"Name of the R2 bucket.","example":"some-bucket","type":"string","x-auditable":true}},"required":["name"],"type":"object"},"description":"R2 buckets used for Pages Functions.","example":{"R2_BINDING":{"name":"some-bucket"}},"type":"object"},"services":{"additionalProperties":{"description":"Service binding.","properties":{"entrypoint":{"description":"The entrypoint to bind to.","nullable":true,"type":"string","x-auditable":true},"environment":{"description":"The Service environment.","type":"string","x-auditable":true},"service":{"description":"The Service name.","type":"string","x-auditable":true}},"required":["service","environment"],"type":"object"},"description":"Services used for Pages Functions.","example":{"SERVICE_BINDING":{"entrypoint":"MyHandler","environment":"production","service":"example-worker"}},"type":"object"},"usage_model":{"deprecated":true,"description":"The usage model for Pages Functions.","enum":["standard","bundled","unbound"],"example":"standard","type":"string","x-auditable":true,"x-stainless-deprecation-message":"All new projects now use the Standard usage model."},"vectorize_bindings":{"additionalProperties":{"description":"Vectorize binding.","properties":{"index_name":{"example":"my_index","type":"string","x-auditable":true}},"required":["index_name"],"type":"object"},"description":"Vectorize bindings used for Pages Functions.","example":{"VECTORIZE":{"index_name":"my_index"}},"type":"object"},"wrangler_config_hash":{"description":"Hash of the Wrangler configuration used for the deployment.","example":"abc123def456","type":"string","x-auditable":true}},"required":["env_vars","fail_open","always_use_latest_compatibility_date","compatibility_date","compatibility_flags","build_image_major_version","usage_model"],"type":"object"},"pages_deployment_config_values_request":{"properties":{"ai_bindings":{"additionalProperties":{"description":"AI binding.","nullable":true,"properties":{"project_id":{"type":"string","x-auditable":true}},"required":["project_id"],"type":"object"},"description":"Constellation bindings used for Pages Functions.","example":{"AI_BINDING":{"project_id":"some-project-id"}},"type":"object"},"always_use_latest_compatibility_date":{"default":false,"description":"Whether to always use the latest compatibility date for Pages Functions.","example":false,"type":"boolean","x-auditable":true},"analytics_engine_datasets":{"additionalProperties":{"description":"Analytics Engine binding.","nullable":true,"properties":{"dataset":{"description":"Name of the dataset.","example":"api_analytics","type":"string","x-auditable":true}},"required":["dataset"],"type":"object"},"description":"Analytics Engine bindings used for Pages Functions.","example":{"ANALYTICS_ENGINE_BINDING":{"dataset":"api_analytics"}},"type":"object"},"browsers":{"additionalProperties":{"description":"Browser binding.","nullable":true,"type":"object","x-stainless-empty-object":true},"description":"Browser bindings used for Pages Functions.","example":{"BROWSER":{}},"type":"object"},"build_image_major_version":{"default":3,"description":"The major version of the build image to use for Pages Functions.","example":3,"type":"integer","x-auditable":true},"compatibility_date":{"description":"Compatibility date used for Pages Functions.","example":"2025-01-01","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"compatibility_flags":{"description":"Compatibility flags used for Pages Functions.","example":["url_standard"],"items":{"type":"string","x-auditable":true},"type":"array"},"d1_databases":{"additionalProperties":{"description":"D1 binding.","nullable":true,"properties":{"id":{"description":"UUID of the D1 database.","example":"445e2955-951a-43f8-a35b-a4d0c8138f63","type":"string","x-auditable":true}},"required":["id"],"type":"object"},"description":"D1 databases used for Pages Functions.","example":{"D1_BINDING":{"id":"445e2955-951a-43f8-a35b-a4d0c8138f63"}},"type":"object"},"durable_object_namespaces":{"additionalProperties":{"description":"Durable Object binding.","nullable":true,"properties":{"namespace_id":{"description":"ID of the Durable Object namespace.","example":"5eb63bbbe01eeed093cb22bb8f5acdc3","type":"string","x-auditable":true}},"required":["namespace_id"],"type":"object"},"description":"Durable Object namespaces used for Pages Functions.","example":{"DO_BINDING":{"namespace_id":"5eb63bbbe01eeed093cb22bb8f5acdc3"}},"type":"object"},"env_vars":{"additionalProperties":{"discriminator":{"mapping":{"plain_text":"#/components/schemas/pages_plain_text_env_var","secret_text":"#/components/schemas/pages_secret_text_env_var"},"propertyName":"type"},"nullable":true,"oneOf":[{"$ref":"#/components/schemas/pages_plain_text_env_var"},{"$ref":"#/components/schemas/pages_secret_text_env_var"}],"type":"object"},"description":"Environment variables used for builds and Pages Functions.","type":"object"},"fail_open":{"default":true,"description":"Whether to fail open when the deployment config cannot be applied.","example":true,"type":"boolean","x-auditable":true},"hyperdrive_bindings":{"additionalProperties":{"description":"Hyperdrive binding.","nullable":true,"properties":{"id":{"example":"a76a99bc342644deb02c38d66082262a","type":"string","x-auditable":true}},"required":["id"],"type":"object"},"description":"Hyperdrive bindings used for Pages Functions.","example":{"HYPERDRIVE":{"id":"a76a99bc342644deb02c38d66082262a"}},"type":"object"},"kv_namespaces":{"additionalProperties":{"description":"KV namespace binding.","nullable":true,"properties":{"namespace_id":{"description":"ID of the KV namespace.","example":"5eb63bbbe01eeed093cb22bb8f5acdc3","type":"string","x-auditable":true}},"required":["namespace_id"],"type":"object"},"description":"KV namespaces used for Pages Functions.","example":{"KV_BINDING":{"namespace_id":"5eb63bbbe01eeed093cb22bb8f5acdc3"}},"type":"object"},"limits":{"description":"Limits for Pages Functions.","example":{"cpu_ms":100},"properties":{"cpu_ms":{"description":"CPU time limit in milliseconds.","example":100,"type":"integer","x-auditable":true}},"required":["cpu_ms"],"type":"object"},"mtls_certificates":{"additionalProperties":{"description":"mTLS binding.","nullable":true,"properties":{"certificate_id":{"example":"d7cdd17c-916f-4cb7-aabe-585eb382ec4e","type":"string","x-auditable":true}},"required":["certificate_id"],"type":"object"},"description":"mTLS bindings used for Pages Functions.","example":{"MTLS":{"certificate_id":"d7cdd17c-916f-4cb7-aabe-585eb382ec4e"}},"type":"object"},"placement":{"description":"Placement setting used for Pages Functions.","example":{"mode":"smart"},"properties":{"mode":{"description":"Placement mode.","example":"smart","type":"string","x-auditable":true}},"required":["mode"],"type":"object"},"queue_producers":{"additionalProperties":{"description":"Queue Producer binding.","nullable":true,"properties":{"name":{"description":"Name of the Queue.","example":"some-queue","type":"string","x-auditable":true}},"required":["name"],"type":"object"},"description":"Queue Producer bindings used for Pages Functions.","example":{"QUEUE_PRODUCER_BINDING":{"name":"some-queue"}},"type":"object"},"r2_buckets":{"additionalProperties":{"description":"R2 binding.","nullable":true,"properties":{"jurisdiction":{"description":"Jurisdiction of the R2 bucket.","example":"eu","nullable":true,"type":"string","x-auditable":true},"name":{"description":"Name of the R2 bucket.","example":"some-bucket","type":"string","x-auditable":true}},"required":["name"],"type":"object"},"description":"R2 buckets used for Pages Functions.","example":{"R2_BINDING":{"name":"some-bucket"}},"type":"object"},"services":{"additionalProperties":{"description":"Service binding.","nullable":true,"properties":{"entrypoint":{"description":"The entrypoint to bind to.","nullable":true,"type":"string","x-auditable":true},"environment":{"description":"The Service environment.","type":"string","x-auditable":true},"service":{"description":"The Service name.","type":"string","x-auditable":true}},"required":["service"],"type":"object"},"description":"Services used for Pages Functions.","example":{"SERVICE_BINDING":{"entrypoint":"MyHandler","environment":"production","service":"example-worker"}},"type":"object"},"usage_model":{"default":"standard","deprecated":true,"description":"The usage model for Pages Functions.","enum":["standard","bundled","unbound"],"example":"standard","type":"string","x-auditable":true,"x-stainless-deprecation-message":"All new projects now use the Standard usage model."},"vectorize_bindings":{"additionalProperties":{"description":"Vectorize binding.","nullable":true,"properties":{"index_name":{"example":"my_index","type":"string","x-auditable":true}},"required":["index_name"],"type":"object"},"description":"Vectorize bindings used for Pages Functions.","example":{"VECTORIZE":{"index_name":"my_index"}},"type":"object"},"wrangler_config_hash":{"description":"Hash of the Wrangler configuration used for the deployment.","example":"abc123def456","type":"string","x-auditable":true}},"type":"object"},"pages_deployment_log":{"example":{"data":[{"line":"Cloning repository...","ts":"2021-04-20T19:35:29.0749819Z"},{"line":"From https://github.com/cloudflare/example","ts":"2021-04-20T19:35:30.0749819Z"},{"line":" * branch            209c5bb11d89533f426b2f8469bcae12fdccf71b -\u003e FETCH_HEAD","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"HEAD is now at 209c5bb Update index.html","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"Success: Finished cloning repository files","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"Installing dependencies","ts":"2021-04-20T19:35:59.0749819Z"},{"line":"Python version set to 2.7","ts":"2021-04-20T19:35:59.0931208Z"},{"line":"v12.18.0 is already installed.","ts":"2021-04-20T19:36:02.2369501Z"},{"line":"Now using node v12.18.0 (npm v6.14.4)","ts":"2021-04-20T19:36:02.6028886Z"},{"line":"Started restoring cached build plugins","ts":"2021-04-20T19:36:02.624555Z"},{"line":"Finished restoring cached build plugins","ts":"2021-04-20T19:36:02.6340688Z"},{"line":"Attempting ruby version 2.7.1, read from environment","ts":"2021-04-20T19:36:02.963095Z"},{"line":"Using ruby version 2.7.1","ts":"2021-04-20T19:36:04.2236084Z"},{"line":"Using PHP version 5.6","ts":"2021-04-20T19:36:04.5450152Z"},{"line":"5.2 is already installed.","ts":"2021-04-20T19:36:04.5740509Z"},{"line":"Using Swift version 5.2","ts":"2021-04-20T19:36:04.577035Z"},{"line":"Installing Hugo 0.54.0","ts":"2021-04-20T19:36:04.5771615Z"},{"line":"Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z","ts":"2021-04-20T19:36:05.4786868Z"},{"line":"Started restoring cached go cache","ts":"2021-04-20T19:36:05.4794366Z"},{"line":"Finished restoring cached go cache","ts":"2021-04-20T19:36:05.481977Z"},{"line":"go version go1.14.4 linux/amd64","ts":"2021-04-20T19:36:05.9049776Z"},{"line":"go version go1.14.4 linux/amd64","ts":"2021-04-20T19:36:05.9086053Z"},{"line":"Installing missing commands","ts":"2021-04-20T19:36:05.9163568Z"},{"line":"Verify run directory","ts":"2021-04-20T19:36:05.9163934Z"},{"line":"Executing user command: echo \"skipping build step: no build command specified\"","ts":"2021-04-20T19:36:05.9164636Z"},{"line":"skipping build step: no build command specified","ts":"2021-04-20T19:36:05.9165087Z"},{"line":"Finished","ts":"2021-04-20T19:36:05.917412Z"}],"includes_container_logs":true,"total":30},"properties":{"data":{"items":{"properties":{"line":{"readOnly":true,"type":"string"},"ts":{"readOnly":true,"type":"string"}},"required":["ts","line"],"type":"object"},"type":"array"},"includes_container_logs":{"readOnly":true,"type":"boolean"},"total":{"readOnly":true,"type":"integer"}},"required":["total","includes_container_logs","data"],"type":"object"},"pages_deployments":{"$ref":"#/components/schemas/pages_deployment"},"pages_domain":{"properties":{"certificate_authority":{"enum":["google","lets_encrypt"],"example":"lets_encrypt","readOnly":true,"type":"string","x-auditable":true},"created_on":{"readOnly":true,"type":"string","x-auditable":true},"domain_id":{"readOnly":true,"type":"string","x-auditable":true},"id":{"readOnly":true,"type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/pages_domain_name"},"status":{"enum":["initializing","pending","active","deactivated","blocked","error"],"readOnly":true,"type":"string","x-auditable":true},"validation_data":{"properties":{"error_message":{"type":"string","x-auditable":true},"method":{"enum":["http","txt"],"type":"string","x-auditable":true},"status":{"enum":["initializing","pending","active","deactivated","error"],"type":"string","x-auditable":true},"txt_name":{"type":"string","x-auditable":true},"txt_value":{"type":"string","x-auditable":true}},"readOnly":true,"required":["status","method"],"type":"object"},"verification_data":{"properties":{"error_message":{"type":"string","x-auditable":true},"status":{"enum":["pending","active","deactivated","blocked","error"],"type":"string"}},"readOnly":true,"required":["status"],"type":"object"},"zone_tag":{"readOnly":true,"type":"string","x-auditable":true}},"required":["id","domain_id","name","status","created_on","certificate_authority","zone_tag","validation_data","verification_data"],"type":"object"},"pages_domain_name":{"description":"The domain name.","example":"this-is-my-domain-01.com","pattern":"^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$","type":"string","x-auditable":true},"pages_env_vars":{"additionalProperties":{"discriminator":{"mapping":{"plain_text":"#/components/schemas/pages_plain_text_env_var","secret_text":"#/components/schemas/pages_secret_text_env_var"},"propertyName":"type"},"nullable":true,"oneOf":[{"$ref":"#/components/schemas/pages_plain_text_env_var"},{"$ref":"#/components/schemas/pages_secret_text_env_var"}],"type":"object"},"description":"Environment variables used for builds and Pages Functions.","nullable":true,"type":"object"},"pages_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"pages_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"pages_plain_text_env_var":{"description":"A plaintext environment variable.","example":{"type":"plain_text","value":"hello world"},"nullable":true,"properties":{"type":{"enum":["plain_text"],"type":"string","x-auditable":true},"value":{"description":"Environment variable value.","type":"string"}},"required":["type","value"],"type":"object"},"pages_project":{"properties":{"build_config":{"$ref":"#/components/schemas/pages_build_config"},"canonical_deployment":{"allOf":[{"$ref":"#/components/schemas/pages_deployment"},{"description":"Most recent production deployment of the project.","nullable":true,"readOnly":true,"type":"object"}]},"created_on":{"description":"When the project was created.","example":"2017-01-01T00:00:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"deployment_configs":{"description":"Configs for deployments in a project.","properties":{"preview":{"allOf":[{"$ref":"#/components/schemas/pages_deployment_config_values"}],"description":"Configs for preview deploys."},"production":{"allOf":[{"$ref":"#/components/schemas/pages_deployment_config_values"}],"description":"Configs for production deploys."}},"required":["production","preview"],"type":"object"},"domains":{"description":"A list of associated custom domains for the project.","example":["customdomain.com","customdomain.org"],"items":{"type":"string","x-auditable":true},"readOnly":true,"type":"array"},"framework":{"description":"Framework the project is using.","readOnly":true,"type":"string","x-auditable":true},"framework_version":{"description":"Version of the framework the project is using.","readOnly":true,"type":"string","x-auditable":true},"id":{"description":"ID of the project.","example":"7b162ea7-7367-4d67-bcde-1160995d5","readOnly":true,"type":"string","x-auditable":true},"latest_deployment":{"allOf":[{"$ref":"#/components/schemas/pages_deployment"},{"description":"Most recent deployment of the project.","nullable":true,"readOnly":true,"type":"object"}]},"name":{"$ref":"#/components/schemas/pages_project_name"},"preview_script_name":{"description":"Name of the preview script.","example":"pages-worker--1234567-preview","readOnly":true,"type":"string","x-auditable":true},"production_branch":{"description":"Production branch of the project. Used to identify production deployments.","example":"main","type":"string","x-auditable":true},"production_script_name":{"description":"Name of the production script.","example":"pages-worker--1234567-production","readOnly":true,"type":"string","x-auditable":true},"source":{"$ref":"#/components/schemas/pages_source"},"subdomain":{"description":"The Cloudflare subdomain associated with the project.","example":"helloworld.pages.dev","readOnly":true,"type":"string","x-auditable":true},"uses_functions":{"description":"Whether the project uses functions.","nullable":true,"readOnly":true,"type":"boolean","x-auditable":true}},"required":["id","name","deployment_configs","latest_deployment","canonical_deployment","created_on","production_branch","production_script_name","preview_script_name","uses_functions","framework","framework_version"],"type":"object"},"pages_project-object":{"$ref":"#/components/schemas/pages_project"},"pages_project_name":{"description":"Name of the project.","example":"this-is-my-project-01","pattern":"^[a-z0-9][a-z0-9-]*$","type":"string","x-auditable":true},"pages_secret_text_env_var":{"description":"An encrypted environment variable.","example":{"type":"secret_text","value":""},"nullable":true,"properties":{"type":{"enum":["secret_text"],"type":"string","x-auditable":true},"value":{"description":"Secret value.","type":"string","x-sensitive":true}},"required":["type","value"],"type":"object"},"pages_source":{"description":"Configs for the project source control.","properties":{"config":{"properties":{"deployments_enabled":{"deprecated":true,"description":"Whether to enable automatic deployments when pushing to the source repository.\nWhen disabled, no deployments (production or preview) will be triggered automatically.\n","type":"boolean","x-auditable":true,"x-stainless-deprecation-message":"Use `production_deployments_enabled` and `preview_deployment_setting` for more granular control."},"owner":{"description":"The owner of the repository.","example":"my-org","type":"string","x-auditable":true},"owner_id":{"description":"The owner ID of the repository.","example":"12345678","type":"string","x-auditable":true},"path_excludes":{"description":"A list of paths that should be excluded from triggering a preview deployment. Wildcard syntax (`*`) is supported.","items":{"type":"string","x-auditable":true},"type":"array"},"path_includes":{"description":"A list of paths that should be watched to trigger a preview deployment. Wildcard syntax (`*`) is supported.","items":{"type":"string","x-auditable":true},"type":"array"},"pr_comments_enabled":{"description":"Whether to enable PR comments.","type":"boolean","x-auditable":true},"preview_branch_excludes":{"description":"A list of branches that should not trigger a preview deployment. Wildcard syntax (`*`) is supported. Must be used with `preview_deployment_setting` set to `custom`.","items":{"type":"string","x-auditable":true},"type":"array"},"preview_branch_includes":{"description":"A list of branches that should trigger a preview deployment. Wildcard syntax (`*`) is supported. Must be used with `preview_deployment_setting` set to `custom`.","items":{"type":"string","x-auditable":true},"type":"array"},"preview_deployment_setting":{"description":"Controls whether commits to preview branches trigger a preview deployment.","enum":["all","none","custom"],"type":"string","x-auditable":true},"production_branch":{"description":"The production branch of the repository.","example":"main","type":"string","x-auditable":true},"production_deployments_enabled":{"description":"Whether to trigger a production deployment on commits to the production branch.","type":"boolean","x-auditable":true},"repo_id":{"description":"The ID of the repository.","example":"12345678","type":"string","x-auditable":true},"repo_name":{"description":"The name of the repository.","example":"my-repo","type":"string","x-auditable":true}},"required":["owner","pr_comments_enabled","production_branch","repo_name"],"type":"object"},"type":{"description":"The source control management provider.","enum":["github","gitlab"],"example":"github","type":"string","x-auditable":true}},"required":["type","config"],"type":"object"},"pages_stage":{"description":"The status of the deployment.","properties":{"ended_on":{"description":"When the stage ended.","example":"2021-03-09T00:58:59.045655","format":"date-time","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"name":{"description":"The current build stage.","enum":["queued","initialize","clone_repo","build","deploy"],"example":"deploy","type":"string","x-auditable":true},"started_on":{"description":"When the stage started.","example":"2021-03-09T00:55:03.923456Z","format":"date-time","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"status":{"description":"State of the current stage.","enum":["success","idle","active","failure","canceled"],"example":"success","readOnly":true,"type":"string","x-auditable":true}},"readOnly":true,"required":["name","started_on","ended_on","status"],"type":"object"},"pay-per-crawl_BotAccessMode":{"enum":["charge","bypass"],"type":"string"},"pay-per-crawl_DaricConfig":{"properties":{"bot_overrides":{"additionalProperties":{"$ref":"#/components/schemas/pay-per-crawl_BotAccessMode"},"type":"object"},"enabled":{"type":"boolean"},"price_usd_microcents":{"type":"integer"}},"type":"object"},"pay-per-crawl_DaricZoneCanBeEnabled":{"properties":{"can_be_enabled":{"type":"boolean"},"id":{"type":"string"}},"type":"object"},"pay-per-crawl_ErrorSource":{"properties":{"pointer":{"type":"string"}},"type":"object"},"pay-per-crawl_Msg":{"properties":{"code":{"type":"integer"},"documentation_url":{"type":"string"},"error_chain":{"items":{"$ref":"#/components/schemas/pay-per-crawl_Msg"},"type":"array"},"message":{"type":"string"},"meta":{"description":"Meta object containing non-standard meta-information about the error.\nThis field must be an object or null!"},"source":{"$ref":"#/components/schemas/pay-per-crawl_Source"}},"type":"object"},"pay-per-crawl_RESTError":{"properties":{"code":{"type":"integer"},"documentation_url":{"type":"string"},"error":{"type":"string"},"source":{"$ref":"#/components/schemas/pay-per-crawl_ErrorSource"}},"type":"object"},"pay-per-crawl_ResultInfo":{"properties":{"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_count":{"type":"integer"},"total_pages":{"description":"TotalPages is a pointer so that if TotalPages == 0 we return that there\nare indeed 0 pages. omitempty would have removed the field otherwise.\nThis is important as a customer may be relying on always reading this\nproperty and it should not be absent just because it is 0, only absent\nif a value is never provided.","type":"integer"}},"type":"object"},"pay-per-crawl_Source":{"properties":{"parameter":{"description":"Parameter is a string indicating which URI query parameter caused the error.","type":"string"},"parameter_value_index":{"description":"ParameterPosition indicates position of parameter value which caused the error,\nfor cases when there are multiple values for the same parameter.","type":"integer"},"pointer":{"description":"Pointer is a JSON Pointer [RFC6901] to the associated entity in the request document\ne.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute.","items":{"type":"string"},"type":"array"}},"type":"object"},"pay-per-crawl_StripeConnectResp":{"properties":{"url":{"type":"string"}},"type":"object"},"pay-per-crawl_StripeConnection":{"properties":{"connect_status":{"type":"string"},"stripe_account_id":{"type":"string"}},"type":"object"},"pay-per-crawl_ZonesCanBeEnabledPayload":{"properties":{"zones":{"items":{"$ref":"#/components/schemas/pay-per-crawl_DaricZoneCanBeEnabled"},"type":"array"}},"type":"object"},"pay-per-crawl_apiErrorResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/pay-per-crawl_RESTError"},"type":"array"},"result":{},"success":{"type":"boolean"}},"type":"object"},"pay-per-crawl_apiNoResultResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/pay-per-crawl_Msg"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/pay-per-crawl_Msg"},"type":"array"},"result_info":{"$ref":"#/components/schemas/pay-per-crawl_ResultInfo"},"success":{"type":"boolean"}},"type":"object"},"pay-per-crawl_createStripeConfigResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/pay-per-crawl_Msg"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/pay-per-crawl_Msg"},"type":"array"},"result":{"$ref":"#/components/schemas/pay-per-crawl_StripeConnectResp"},"result_info":{"$ref":"#/components/schemas/pay-per-crawl_ResultInfo"},"success":{"type":"boolean"}},"type":"object"},"pay-per-crawl_getConfigResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/pay-per-crawl_Msg"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/pay-per-crawl_Msg"},"type":"array"},"result":{"$ref":"#/components/schemas/pay-per-crawl_DaricConfig"},"result_info":{"$ref":"#/components/schemas/pay-per-crawl_ResultInfo"},"success":{"type":"boolean"}},"type":"object"},"pay-per-crawl_getStripeConfigResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/pay-per-crawl_Msg"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/pay-per-crawl_Msg"},"type":"array"},"result":{"$ref":"#/components/schemas/pay-per-crawl_StripeConnection"},"result_info":{"$ref":"#/components/schemas/pay-per-crawl_ResultInfo"},"success":{"type":"boolean"}},"type":"object"},"pay-per-crawl_queryZonesCanBeEnabledResponse":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/pay-per-crawl_Msg"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/pay-per-crawl_Msg"},"type":"array"},"result":{"$ref":"#/components/schemas/pay-per-crawl_ZonesCanBeEnabledPayload"},"result_info":{"$ref":"#/components/schemas/pay-per-crawl_ResultInfo"},"success":{"type":"boolean"}},"type":"object"},"public-ip_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/public-ip_messages"},"messages":{"$ref":"#/components/schemas/public-ip_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"public-ip_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/public-ip_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/public-ip_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"public-ip_api-response-single":{"allOf":[{"$ref":"#/components/schemas/public-ip_api-response-common"}],"type":"object"},"public-ip_etag":{"description":"A digest of the IP data. Useful for determining if the data has changed.","example":"a8e453d9d129a3769407127936edfdb0","type":"string"},"public-ip_ips":{"properties":{"etag":{"$ref":"#/components/schemas/public-ip_etag"},"ipv4_cidrs":{"$ref":"#/components/schemas/public-ip_ipv4_cidrs"},"ipv6_cidrs":{"$ref":"#/components/schemas/public-ip_ipv6_cidrs"}},"type":"object"},"public-ip_ips_jdcloud":{"properties":{"etag":{"$ref":"#/components/schemas/public-ip_etag"},"ipv4_cidrs":{"$ref":"#/components/schemas/public-ip_ipv4_cidrs"},"ipv6_cidrs":{"$ref":"#/components/schemas/public-ip_ipv6_cidrs"},"jdcloud_cidrs":{"$ref":"#/components/schemas/public-ip_jdcloud_cidrs"}},"type":"object"},"public-ip_ipv4_cidrs":{"description":"List of Cloudflare IPv4 CIDR addresses.","items":{"description":"IPv4 CIDR.","example":"199.27.128.0/21","type":"string"},"type":"array"},"public-ip_ipv6_cidrs":{"description":"List of Cloudflare IPv6 CIDR addresses.","items":{"description":"IPv6 CIDR.","example":"2400:cb00::/32","type":"string"},"type":"array"},"public-ip_jdcloud_cidrs":{"description":"List IPv4 and IPv6 CIDRs, only populated if `?networks=jdcloud` is used.","items":{"description":"IPv4 or IPv6 CIDR.","example":"199.27.128.0/21","type":"string"},"type":"array"},"public-ip_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"r2-data-catalog_account-id":{"description":"Use this to identify the account.","example":"0123456789abcdef0123456789abcdef","pattern":"^[a-fA-F0-9]{32}$","type":"string"},"r2-data-catalog_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_api-response-single"},{"properties":{"result_info":{"properties":{"count":{"description":"Indicates the number of results in this page.","type":"integer"},"page":{"description":"Specifies the current page number.","type":"integer"},"per_page":{"description":"Specifies the number of results per page.","type":"integer"},"total_count":{"description":"Specifies the total number of results.","type":"integer"}},"type":"object"}},"type":"object"}]},"r2-data-catalog_api-response-common-failure":{"properties":{"errors":{"items":{"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"},"minItems":1,"type":"array"},"messages":{"items":{"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"type":"object"},"r2-data-catalog_api-response-errors":{"description":"Contains errors if the API call was unsuccessful.","items":{"properties":{"code":{"description":"Specifies the error code.","type":"integer"},"message":{"description":"Describes the error.","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"r2-data-catalog_api-response-messages":{"description":"Contains informational messages.","items":{"properties":{"code":{"description":"Specifies the message code.","type":"integer"},"message":{"description":"Contains the message text.","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"r2-data-catalog_api-response-single":{"properties":{"errors":{"$ref":"#/components/schemas/r2-data-catalog_api-response-errors"},"messages":{"$ref":"#/components/schemas/r2-data-catalog_api-response-messages"},"success":{"$ref":"#/components/schemas/r2-data-catalog_api-response-success"}},"required":["success","errors","messages"],"type":"object"},"r2-data-catalog_api-response-success":{"description":"Indicates whether the API call was successful.","example":true,"type":"boolean"},"r2-data-catalog_bucket-name":{"description":"Specifies the R2 bucket name.","example":"my-data-bucket","maxLength":63,"minLength":3,"pattern":"^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$","type":"string"},"r2-data-catalog_catalog":{"description":"Contains R2 Data Catalog information.","properties":{"bucket":{"description":"Specifies the associated R2 bucket name.","example":"my-data-bucket","type":"string"},"credential_status":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_credential-status"}],"description":"Shows the credential configuration status.","nullable":true,"type":"string"},"id":{"description":"Use this to uniquely identify the catalog.","example":"550e8400-e29b-41d4-a716-446655440000","format":"uuid","type":"string"},"maintenance_config":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_catalog-maintenance-config"}],"description":"Configures maintenance for the catalog.","nullable":true,"type":"object"},"name":{"description":"Specifies the catalog name (generated from account and bucket name).","example":"account123_my-bucket","type":"string"},"status":{"$ref":"#/components/schemas/r2-data-catalog_catalog-status"}},"required":["id","name","bucket","status"],"type":"object"},"r2-data-catalog_catalog-activation-response":{"description":"Contains response from activating an R2 bucket as a catalog.","properties":{"id":{"description":"Use this to uniquely identify the activated catalog.","example":"550e8400-e29b-41d4-a716-446655440000","format":"uuid","type":"string"},"name":{"description":"Specifies the name of the activated catalog.","example":"account123_my-bucket","type":"string"}},"required":["id","name"],"type":"object"},"r2-data-catalog_catalog-compaction-config":{"description":"Configures compaction for catalog maintenance.","properties":{"state":{"$ref":"#/components/schemas/r2-data-catalog_catalog-maintenance-state"},"target_size_mb":{"$ref":"#/components/schemas/r2-data-catalog_catalog-target-file-size"}},"required":["state","target_size_mb"],"type":"object"},"r2-data-catalog_catalog-credential-request":{"description":"Contains request to store catalog credentials.","properties":{"token":{"description":"Provides the Cloudflare API token for accessing R2.","example":"your-cloudflare-api-token-here","type":"string"}},"required":["token"],"type":"object"},"r2-data-catalog_catalog-list":{"description":"Contains the list of catalogs.","properties":{"warehouses":{"description":"Lists catalogs in the account.","items":{"$ref":"#/components/schemas/r2-data-catalog_catalog"},"type":"array"}},"required":["warehouses"],"type":"object"},"r2-data-catalog_catalog-maintenance-config":{"description":"Configures maintenance for the catalog.","properties":{"compaction":{"$ref":"#/components/schemas/r2-data-catalog_catalog-compaction-config"}},"type":"object"},"r2-data-catalog_catalog-maintenance-config-response":{"description":"Contains maintenance configuration and credential status.","properties":{"credential_status":{"$ref":"#/components/schemas/r2-data-catalog_credential-status"},"maintenance_config":{"$ref":"#/components/schemas/r2-data-catalog_catalog-maintenance-config"}},"required":["maintenance_config","credential_status"],"type":"object"},"r2-data-catalog_catalog-maintenance-state":{"description":"Specifies the state of maintenance operations.","enum":["enabled","disabled"],"example":"enabled","type":"string"},"r2-data-catalog_catalog-maintenance-update-request":{"description":"Contains request to update catalog maintenance configuration.","properties":{"compaction":{"description":"Updates compaction configuration (all fields optional).","properties":{"state":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_catalog-maintenance-state"}],"description":"Updates the state optionally."},"target_size_mb":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_catalog-target-file-size"}],"description":"Updates the target file size optionally."}},"type":"object"}},"type":"object"},"r2-data-catalog_catalog-status":{"description":"Indicates the status of the catalog.","enum":["active","inactive"],"example":"active","type":"string"},"r2-data-catalog_catalog-target-file-size":{"default":"128","description":"Sets the target file size for compaction in megabytes.","enum":["64","128","256","512"],"example":"128","type":"string"},"r2-data-catalog_credential-status":{"description":"Shows the credential configuration status.","enum":["present","absent"],"example":"present","type":"string"},"r2-data-catalog_namespace-details":{"description":"Contains namespace with metadata details.","properties":{"created_at":{"description":"Indicates the creation timestamp in ISO 8601 format.","format":"date-time","nullable":true,"type":"string"},"namespace":{"$ref":"#/components/schemas/r2-data-catalog_namespace-identifier"},"namespace_uuid":{"description":"Contains the UUID that persists across renames.","format":"uuid","type":"string"},"updated_at":{"description":"Shows the last update timestamp in ISO 8601 format. Null if never updated.","format":"date-time","nullable":true,"type":"string"}},"required":["namespace","namespace_uuid"],"type":"object"},"r2-data-catalog_namespace-identifier":{"description":"Specifies the hierarchical namespace parts as an array of strings.\nFor example, [\"bronze\", \"analytics\"] represents the namespace \"bronze.analytics\".\n","example":["bronze","analytics"],"items":{"type":"string"},"maxItems":16,"minItems":1,"type":"array"},"r2-data-catalog_namespace-list-response":{"description":"Contains the list of namespaces with optional pagination.","properties":{"details":{"description":"Contains detailed metadata for each namespace when return_details is true.\nEach object includes the namespace, UUID, and timestamps.\n","items":{"$ref":"#/components/schemas/r2-data-catalog_namespace-details"},"nullable":true,"type":"array"},"namespace_uuids":{"description":"Contains UUIDs for each namespace when return_uuids is true.\nThe order corresponds to the namespaces array.\n","example":["0199b999-6869-7383-bb1f-d30e059d5326","0199b99b-2c88-73b3-8dbb-421e0e8f2757"],"items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"},"namespaces":{"description":"Lists namespaces in the catalog.","items":{"$ref":"#/components/schemas/r2-data-catalog_namespace-identifier"},"type":"array"},"next_page_token":{"description":"Use this opaque token to fetch the next page of results.\nA null or absent value indicates the last page.\n","example":"MSYxNzU5NzU1NTc4NTA0MTk0JjAxOTliOTliLTJjODgtNzNiMy04ZGJiLTQyMWUwZThmMjc1Nw","nullable":true,"type":"string"}},"required":["namespaces"],"type":"object"},"r2-data-catalog_table-compaction-config":{"description":"Configures compaction settings for table optimization.","properties":{"state":{"$ref":"#/components/schemas/r2-data-catalog_catalog-maintenance-state"},"target_size_mb":{"$ref":"#/components/schemas/r2-data-catalog_catalog-target-file-size"}},"required":["state","target_size_mb"],"type":"object"},"r2-data-catalog_table-details":{"description":"Contains table with metadata.","properties":{"created_at":{"description":"Indicates the creation timestamp in ISO 8601 format.","format":"date-time","nullable":true,"type":"string"},"identifier":{"$ref":"#/components/schemas/r2-data-catalog_table-identifier"},"location":{"description":"Specifies the base S3 URI for table storage location.","nullable":true,"type":"string"},"metadata_location":{"description":"Contains the S3 URI to table metadata file. Null for staged tables.","nullable":true,"type":"string"},"table_uuid":{"description":"Contains the UUID that persists across renames.","format":"uuid","type":"string"},"updated_at":{"description":"Shows the last update timestamp in ISO 8601 format. Null if never updated.","format":"date-time","nullable":true,"type":"string"}},"required":["identifier","table_uuid"],"type":"object"},"r2-data-catalog_table-identifier":{"description":"Specifies a unique table identifier within a catalog.","properties":{"name":{"description":"Specifies the table name.","example":"events","type":"string"},"namespace":{"$ref":"#/components/schemas/r2-data-catalog_namespace-identifier"}},"required":["namespace","name"],"type":"object"},"r2-data-catalog_table-list-response":{"description":"Contains the list of tables with optional pagination.","properties":{"details":{"description":"Contains detailed metadata for each table when return_details is true.\nEach object includes identifier, UUID, timestamps, and locations.\n","items":{"$ref":"#/components/schemas/r2-data-catalog_table-details"},"nullable":true,"type":"array"},"identifiers":{"description":"Lists tables in the namespace.","items":{"$ref":"#/components/schemas/r2-data-catalog_table-identifier"},"type":"array"},"next_page_token":{"description":"Use this opaque token to fetch the next page of results.\nA null or absent value indicates the last page.\n","example":"MSYxNzU5NzU2MTI4NTU2Njk2JjAxOTliOWEzLTkxMmUtN2ZhMS05YzllLTg5MTAxMGQzYTg0MQ","nullable":true,"type":"string"},"table_uuids":{"description":"Contains UUIDs for each table when return_uuids is true.\nThe order corresponds to the identifiers array.\n","example":["0199b9a1-28a0-71e0-a73e-b0fc32c8468e","0199b9a1-3c74-7731-bf53-d8c67ead079d"],"items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"}},"required":["identifiers"],"type":"object"},"r2-data-catalog_table-maintenance-config":{"description":"Configures maintenance for the table.","properties":{"compaction":{"$ref":"#/components/schemas/r2-data-catalog_table-compaction-config"}},"type":"object"},"r2-data-catalog_table-maintenance-config-response":{"description":"Contains table maintenance configuration.","properties":{"maintenance_config":{"$ref":"#/components/schemas/r2-data-catalog_table-maintenance-config"}},"required":["maintenance_config"],"type":"object"},"r2-data-catalog_table-maintenance-update-request":{"description":"Contains request to update table maintenance configuration.","properties":{"compaction":{"description":"Updates compaction configuration (all fields optional).","properties":{"state":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_catalog-maintenance-state"}],"description":"Updates the state optionally."},"target_size_mb":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_catalog-target-file-size"}],"description":"Updates the target file size optionally."}},"type":"object"}},"type":"object"},"r2-slurper_ConnectivityResponse":{"properties":{"connectivityStatus":{"enum":["success","error"],"type":"string"}},"type":"object"},"r2-slurper_CreateJobRequest":{"properties":{"overwrite":{"default":true,"type":"boolean"},"source":{"$ref":"#/components/schemas/r2-slurper_SourceJobSchema"},"target":{"$ref":"#/components/schemas/r2-slurper_R2TargetSchema"}},"type":"object"},"r2-slurper_GCSLikeCredsSchema":{"properties":{"clientEmail":{"type":"string"},"privateKey":{"type":"string","x-sensitive":true}},"required":["clientEmail","privateKey"],"type":"object"},"r2-slurper_GCSSourceSchema":{"properties":{"bucket":{"type":"string"},"pathPrefix":{"nullable":true,"type":"string"},"secret":{"$ref":"#/components/schemas/r2-slurper_GCSLikeCredsSchema"},"vendor":{"enum":["gcs"],"type":"string"}},"required":["vendor","bucket","secret"],"type":"object"},"r2-slurper_JobLogResponse":{"properties":{"createdAt":{"type":"string"},"job":{"type":"string"},"logType":{"enum":["migrationStart","migrationComplete","migrationAbort","migrationError","migrationPause","migrationResume","migrationErrorFailedContinuation","importErrorRetryExhaustion","importSkippedStorageClass","importSkippedOversized","importSkippedEmptyObject","importSkippedUnsupportedContentType","importSkippedExcludedContentType","importSkippedInvalidMedia","importSkippedRequiresRetrieval"],"type":"string"},"message":{"nullable":true,"type":"string"},"objectKey":{"nullable":true,"type":"string"}},"type":"object"},"r2-slurper_JobProgressResponse":{"properties":{"createdAt":{"type":"string"},"failedObjects":{"type":"integer"},"id":{"type":"string"},"objects":{"type":"integer"},"skippedObjects":{"type":"integer"},"status":{"$ref":"#/components/schemas/r2-slurper_JobStatus"},"transferredObjects":{"type":"integer"}},"type":"object"},"r2-slurper_JobResponse":{"properties":{"createdAt":{"type":"string"},"finishedAt":{"nullable":true,"type":"string"},"id":{"type":"string"},"overwrite":{"type":"boolean"},"source":{"oneOf":[{"properties":{"bucket":{"type":"string"},"endpoint":{"nullable":true,"type":"string"},"pathPrefix":{"nullable":true,"type":"string"},"vendor":{"enum":["s3"],"type":"string"}},"title":"S3SourceResponseSchema","type":"object"},{"properties":{"bucket":{"type":"string"},"pathPrefix":{"nullable":true,"type":"string"},"vendor":{"enum":["gcs"],"type":"string"}},"title":"GCSSourceResponseSchema","type":"object"},{"properties":{"bucket":{"type":"string"},"jurisdiction":{"$ref":"#/components/schemas/r2-slurper_Jurisdiction"},"pathPrefix":{"nullable":true,"type":"string"},"vendor":{"enum":["r2"],"type":"string"}},"title":"R2SourceResponseSchema","type":"object"}]},"status":{"$ref":"#/components/schemas/r2-slurper_JobStatus"},"target":{"properties":{"bucket":{"type":"string"},"jurisdiction":{"$ref":"#/components/schemas/r2-slurper_Jurisdiction"},"vendor":{"enum":["r2"],"type":"string"}},"title":"R2TargetResponseSchema","type":"object"}},"type":"object"},"r2-slurper_JobStatus":{"enum":["running","paused","aborted","completed"],"type":"string"},"r2-slurper_Jurisdiction":{"enum":["default","eu","fedramp"],"type":"string"},"r2-slurper_R2SourceSchema":{"properties":{"bucket":{"type":"string"},"jurisdiction":{"$ref":"#/components/schemas/r2-slurper_Jurisdiction"},"pathPrefix":{"nullable":true,"type":"string"},"secret":{"$ref":"#/components/schemas/r2-slurper_S3LikeCredsSchema"},"vendor":{"enum":["r2"],"type":"string"}},"required":["vendor","bucket","secret"],"type":"object"},"r2-slurper_R2TargetSchema":{"properties":{"bucket":{"type":"string"},"jurisdiction":{"$ref":"#/components/schemas/r2-slurper_Jurisdiction"},"secret":{"$ref":"#/components/schemas/r2-slurper_S3LikeCredsSchema"},"vendor":{"enum":["r2"],"type":"string"}},"required":["vendor","bucket","secret"],"type":"object"},"r2-slurper_S3LikeCredsSchema":{"properties":{"accessKeyId":{"type":"string"},"secretAccessKey":{"type":"string","x-sensitive":true}},"required":["accessKeyId","secretAccessKey"],"type":"object"},"r2-slurper_S3SourceSchema":{"properties":{"bucket":{"type":"string"},"endpoint":{"nullable":true,"type":"string"},"pathPrefix":{"nullable":true,"type":"string"},"region":{"nullable":true,"type":"string"},"secret":{"$ref":"#/components/schemas/r2-slurper_S3LikeCredsSchema"},"vendor":{"enum":["s3"],"type":"string"}},"required":["vendor","bucket","secret"],"type":"object"},"r2-slurper_SourceJobSchema":{"oneOf":[{"$ref":"#/components/schemas/r2-slurper_S3SourceSchema"},{"$ref":"#/components/schemas/r2-slurper_GCSSourceSchema"},{"$ref":"#/components/schemas/r2-slurper_R2SourceSchema"}],"type":"object"},"r2-slurper_api-v4-error":{"example":[{"code":7003,"message":"No route for the URI"}],"items":{"properties":{"code":{"minimum":1000,"type":"integer","x-auditable":true},"message":{"type":"string","x-auditable":true}},"required":["code","message"],"type":"object","uniqueItems":true},"minLength":1,"type":"array"},"r2-slurper_api-v4-failure":{"properties":{"errors":{"$ref":"#/components/schemas/r2-slurper_api-v4-error"},"messages":{"$ref":"#/components/schemas/r2-slurper_api-v4-message"},"success":{"description":"Indicates if the API call was successful or not.","enum":[false],"example":false,"type":"boolean","x-auditable":true}},"type":"object"},"r2-slurper_api-v4-message":{"example":[],"items":{"type":"string","x-auditable":true},"type":"array"},"r2-slurper_api-v4-success":{"properties":{"errors":{"$ref":"#/components/schemas/r2-slurper_api-v4-error"},"messages":{"$ref":"#/components/schemas/r2-slurper_api-v4-message"},"success":{"description":"Indicates if the API call was successful or not.","enum":[true],"type":"boolean","x-auditable":true}},"type":"object"},"r2_account_identifier":{"description":"Account ID.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string"},"r2_account_level_metrics":{"description":"Metrics based on the class they belong to.","properties":{"infrequentAccess":{"$ref":"#/components/schemas/r2_class_based_metrics"},"standard":{"$ref":"#/components/schemas/r2_class_based_metrics"}},"type":"object"},"r2_add_custom_domain_request":{"example":{"domain":"prefix.example-domain.com","enabled":true,"zoneId":"36ca64a6d92827b8a6b90be344bb1bfd"},"properties":{"ciphers":{"description":"An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.","items":{"type":"string"},"type":"array","x-auditable":true},"domain":{"description":"Name of the custom domain to be added.","type":"string","x-auditable":true},"enabled":{"description":"Whether to enable public bucket access at the custom domain. If undefined, the domain will be enabled.","type":"boolean","x-auditable":true},"minTLS":{"description":"Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0.","enum":["1.0","1.1","1.2","1.3"],"type":"string","x-auditable":true},"zoneId":{"description":"Zone ID of the custom domain.","type":"string","x-auditable":true}},"required":["domain","zoneId","enabled"],"type":"object"},"r2_add_custom_domain_response":{"example":{"domain":"example-domain.com","enabled":true},"properties":{"ciphers":{"description":"An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.","items":{"type":"string"},"type":"array","x-auditable":true},"domain":{"description":"Domain name of the affected custom domain.","type":"string","x-auditable":true},"enabled":{"description":"Whether this bucket is publicly accessible at the specified custom domain.","type":"boolean"},"minTLS":{"description":"Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0.","enum":["1.0","1.1","1.2","1.3"],"type":"string","x-auditable":true}},"required":["domain","enabled"],"type":"object"},"r2_bucket":{"description":"A single R2 bucket.","properties":{"creation_date":{"description":"Creation timestamp.","type":"string"},"jurisdiction":{"$ref":"#/components/schemas/r2_jurisdiction"},"location":{"$ref":"#/components/schemas/r2_bucket_location"},"name":{"$ref":"#/components/schemas/r2_bucket_name"},"storage_class":{"$ref":"#/components/schemas/r2_storage_class"}},"type":"object"},"r2_bucket-config":{"properties":{"bucketName":{"description":"Name of the bucket.","type":"string","x-auditable":true},"queues":{"description":"List of queues associated with the bucket.","items":{"$ref":"#/components/schemas/r2_queues-config"},"type":"array"}},"type":"object"},"r2_bucket-lock-rule":{"properties":{"condition":{"oneOf":[{"$ref":"#/components/schemas/r2_lock-rule-age-condition"},{"$ref":"#/components/schemas/r2_lock-rule-date-condition"},{"$ref":"#/components/schemas/r2_lock-rule-indefinite-condition"}]},"enabled":{"description":"Whether or not this rule is in effect.","type":"boolean","x-auditable":true},"id":{"description":"Unique identifier for this rule.","example":"Lock all objects for 24 hours","type":"string","x-auditable":true},"prefix":{"description":"Rule will only apply to objects/uploads in the bucket that start with the given prefix, an empty prefix can be provided to scope rule to all objects/uploads.","type":"string","x-auditable":true}},"required":["id","condition","enabled"],"type":"object"},"r2_bucket-lock-rule-config":{"properties":{"rules":{"items":{"allOf":[{"$ref":"#/components/schemas/r2_bucket-lock-rule"}]},"type":"array"}},"type":"object"},"r2_bucket_location":{"description":"Location of the bucket.","enum":["apac","eeur","enam","weur","wnam","oc"],"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"r2_bucket_name":{"description":"Name of the bucket.","example":"example-bucket","maxLength":64,"minLength":3,"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]","type":"string","x-auditable":true},"r2_class_based_metrics":{"description":"Metrics based on what state they are in(uploaded or published).","properties":{"published":{"$ref":"#/components/schemas/r2_object_size_metrics"},"uploaded":{"$ref":"#/components/schemas/r2_object_size_metrics"}},"type":"object"},"r2_cors-rule":{"properties":{"allowed":{"description":"Object specifying allowed origins, methods and headers for this CORS rule.","properties":{"headers":{"description":"Specifies the value for the Access-Control-Allow-Headers header R2 sets when requesting objects in this bucket from a browser. Cross-origin requests that include custom headers (e.g. x-user-id) should specify these headers as AllowedHeaders.","items":{"example":"x-requested-by","type":"string","x-auditable":true},"type":"array"},"methods":{"description":"Specifies the value for the Access-Control-Allow-Methods header R2 sets when requesting objects in a bucket from a browser.","items":{"enum":["GET","PUT","POST","DELETE","HEAD"],"type":"string","x-auditable":true},"type":"array"},"origins":{"description":"Specifies the value for the Access-Control-Allow-Origin header R2 sets when requesting objects in a bucket from a browser.","items":{"example":"http://localhost:3000","type":"string","x-auditable":true},"type":"array"}},"required":["methods","origins"],"type":"object"},"exposeHeaders":{"description":"Specifies the headers that can be exposed back, and accessed by, the JavaScript making the cross-origin request. If you need to access headers beyond the safelisted response headers, such as Content-Encoding or cf-cache-status, you must specify it here.","items":{"example":"Content-Encoding","type":"string","x-auditable":true},"type":"array"},"id":{"description":"Identifier for this rule.","example":"Allow Local Development","type":"string","x-auditable":true},"maxAgeSeconds":{"description":"Specifies the amount of time (in seconds) browsers are allowed to cache CORS preflight responses. Browsers may limit this to 2 hours or less, even if the maximum value (86400) is specified.","example":3600,"type":"number","x-auditable":true}},"required":["allowed"],"type":"object"},"r2_domain_name":{"description":"Name of the custom domain.","example":"example-domain/custom-domain.com","type":"string","x-auditable":true},"r2_edit_custom_domain_request":{"example":{"enabled":true,"minTLS":"1.2"},"properties":{"ciphers":{"description":"An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.","items":{"type":"string"},"type":"array","x-auditable":true},"enabled":{"description":"Whether to enable public bucket access at the specified custom domain.","type":"boolean","x-auditable":true},"minTLS":{"description":"Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to previous value.","enum":["1.0","1.1","1.2","1.3"],"type":"string","x-auditable":true}},"type":"object"},"r2_edit_custom_domain_response":{"example":{"domain":"example-domain.com","enabled":true},"properties":{"ciphers":{"description":"An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.","items":{"type":"string"},"type":"array","x-auditable":true},"domain":{"description":"Domain name of the affected custom domain.","type":"string","x-auditable":true},"enabled":{"description":"Whether this bucket is publicly accessible at the specified custom domain.","type":"boolean","x-auditable":true},"minTLS":{"description":"Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0.","enum":["1.0","1.1","1.2","1.3"],"type":"string","x-auditable":true}},"required":["domain"],"type":"object"},"r2_edit_managed_domain_request":{"example":{"enabled":true},"properties":{"enabled":{"description":"Whether to enable public bucket access at the r2.dev domain.","type":"boolean","x-auditable":true}},"required":["enabled"],"type":"object"},"r2_enable_sippy_aws":{"properties":{"destination":{"description":"R2 bucket to copy objects to.","properties":{"accessKeyId":{"description":"ID of a Cloudflare API token.\nThis is the value labelled \"Access Key ID\" when creating an API.\ntoken from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).\n\nSippy will use this token when writing objects to R2, so it is\nbest to scope this token to the bucket you're enabling Sippy for.\n","type":"string"},"provider":{"enum":["r2"],"type":"string","x-auditable":true},"secretAccessKey":{"description":"Value of a Cloudflare API token.\nThis is the value labelled \"Secret Access Key\" when creating an API.\ntoken from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).\n\nSippy will use this token when writing objects to R2, so it is\nbest to scope this token to the bucket you're enabling Sippy for.\n","type":"string","x-sensitive":true}},"type":"object"},"source":{"description":"AWS S3 bucket to copy objects from.","properties":{"accessKeyId":{"description":"Access Key ID of an IAM credential (ideally scoped to a single S3 bucket).","type":"string"},"bucket":{"description":"Name of the AWS S3 bucket.","type":"string","x-auditable":true},"provider":{"enum":["aws"],"type":"string","x-auditable":true},"region":{"description":"Name of the AWS availability zone.","type":"string","x-auditable":true},"secretAccessKey":{"description":"Secret Access Key of an IAM credential (ideally scoped to a single S3 bucket).","type":"string","x-sensitive":true}},"type":"object"}}},"r2_enable_sippy_gcs":{"properties":{"destination":{"description":"R2 bucket to copy objects to.","properties":{"accessKeyId":{"description":"ID of a Cloudflare API token.\nThis is the value labelled \"Access Key ID\" when creating an API.\ntoken from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).\n\nSippy will use this token when writing objects to R2, so it is\nbest to scope this token to the bucket you're enabling Sippy for.\n","type":"string"},"provider":{"enum":["r2"],"type":"string"},"secretAccessKey":{"description":"Value of a Cloudflare API token.\nThis is the value labelled \"Secret Access Key\" when creating an API.\ntoken from the [R2 dashboard](https://dash.cloudflare.com/?to=/:account/r2/api-tokens).\n\nSippy will use this token when writing objects to R2, so it is\nbest to scope this token to the bucket you're enabling Sippy for.\n","type":"string","x-sensitive":true}},"type":"object"},"source":{"description":"GCS bucket to copy objects from.","properties":{"bucket":{"description":"Name of the GCS bucket.","type":"string","x-auditable":true},"clientEmail":{"description":"Client email of an IAM credential (ideally scoped to a single GCS bucket).","type":"string"},"privateKey":{"description":"Private Key of an IAM credential (ideally scoped to a single GCS bucket).","type":"string","x-sensitive":true},"provider":{"enum":["gcs"],"type":"string"}},"type":"object"}}},"r2_errors":{"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"r2_get_custom_domain_response":{"example":{"domain":"prefix.example-domain.one.com","enabled":false,"status":{"ownership":"deactivated","ssl":"pending"},"zoneId":"36ca64a6d92827b8a6b90be344bb1bfd","zoneName":"example-domain.one.com"},"properties":{"ciphers":{"description":"An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.","items":{"type":"string"},"type":"array","x-auditable":true},"domain":{"description":"Domain name of the custom domain to be added.","type":"string","x-auditable":true},"enabled":{"description":"Whether this bucket is publicly accessible at the specified custom domain.","type":"boolean","x-auditable":true},"minTLS":{"description":"Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0.","enum":["1.0","1.1","1.2","1.3"],"type":"string","x-auditable":true},"status":{"properties":{"ownership":{"description":"Ownership status of the domain.","enum":["pending","active","deactivated","blocked","error","unknown"],"type":"string","x-auditable":true},"ssl":{"description":"SSL certificate status.","enum":["initializing","pending","active","deactivated","error","unknown"],"type":"string","x-auditable":true}},"required":["ssl","ownership"],"type":"object"},"zoneId":{"description":"Zone ID of the custom domain resides in.","type":"string","x-auditable":true},"zoneName":{"description":"Zone that the custom domain resides in.","type":"string","x-auditable":true}},"required":["domain","status","enabled"],"type":"object"},"r2_jurisdiction":{"default":"default","description":"Jurisdiction where objects in this bucket are guaranteed to be stored.","enum":["default","eu","fedramp"],"type":"string","x-auditable":true,"x-stainless-param":"jurisdiction"},"r2_lifecycle-age-condition":{"description":"Condition for lifecycle transitions to apply after an object reaches an age in seconds.","properties":{"maxAge":{"type":"integer","x-auditable":true},"type":{"enum":["Age"],"type":"string","x-auditable":true}},"required":["type","maxAge"],"type":"object"},"r2_lifecycle-config":{"properties":{"rules":{"items":{"allOf":[{"$ref":"#/components/schemas/r2_lifecycle-rule"}]},"type":"array"}},"type":"object"},"r2_lifecycle-date-condition":{"description":"Condition for lifecycle transitions to apply on a specific date.","properties":{"date":{"format":"date-time","type":"string","x-auditable":true},"type":{"enum":["Date"],"type":"string","x-auditable":true}},"required":["type","date"],"type":"object"},"r2_lifecycle-rule":{"properties":{"abortMultipartUploadsTransition":{"description":"Transition to abort ongoing multipart uploads.","properties":{"condition":{"allOf":[{"$ref":"#/components/schemas/r2_lifecycle-age-condition"}]}},"type":"object"},"conditions":{"description":"Conditions that apply to all transitions of this rule.","properties":{"prefix":{"description":"Transitions will only apply to objects/uploads in the bucket that start with the given prefix, an empty prefix can be provided to scope rule to all objects/uploads.","type":"string","x-auditable":true}},"required":["prefix"],"type":"object"},"deleteObjectsTransition":{"description":"Transition to delete objects.","properties":{"condition":{"oneOf":[{"$ref":"#/components/schemas/r2_lifecycle-age-condition"},{"$ref":"#/components/schemas/r2_lifecycle-date-condition"}]}},"type":"object"},"enabled":{"description":"Whether or not this rule is in effect.","type":"boolean","x-auditable":true},"id":{"description":"Unique identifier for this rule.","example":"Expire all objects older than 24 hours","type":"string","x-auditable":true},"storageClassTransitions":{"description":"Transitions to change the storage class of objects.","items":{"allOf":[{"$ref":"#/components/schemas/r2_lifecycle-storage-transition"}]},"type":"array"}},"required":["id","conditions","enabled"],"type":"object"},"r2_lifecycle-storage-transition":{"properties":{"condition":{"oneOf":[{"$ref":"#/components/schemas/r2_lifecycle-age-condition"},{"$ref":"#/components/schemas/r2_lifecycle-date-condition"}]},"storageClass":{"enum":["InfrequentAccess"],"type":"string","x-auditable":true}},"required":["condition","storageClass"],"type":"object"},"r2_list_custom_domains_response":{"example":{"domains":[{"domain":"prefix.example-domain.one.com","enabled":false,"status":{"ownership":"deactivated","ssl":"pending"},"zoneId":"36ca64a6d92827b8a6b90be344bb1bfd","zoneName":"example-domain.one.com"},{"domain":"prefix.example-domain.two.com","enabled":true,"status":{"ownership":"active","ssl":"active"},"zoneId":"d9d28585d5f8f5b0f857b055bf574f19"}]},"properties":{"domains":{"items":{"properties":{"ciphers":{"description":"An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.","items":{"type":"string"},"type":"array","x-auditable":true},"domain":{"description":"Domain name of the custom domain to be added.","type":"string","x-auditable":true},"enabled":{"description":"Whether this bucket is publicly accessible at the specified custom domain.","type":"boolean","x-auditable":true},"minTLS":{"description":"Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0.","enum":["1.0","1.1","1.2","1.3"],"type":"string","x-auditable":true},"status":{"properties":{"ownership":{"description":"Ownership status of the domain.","enum":["pending","active","deactivated","blocked","error","unknown"],"type":"string","x-auditable":true},"ssl":{"description":"SSL certificate status.","enum":["initializing","pending","active","deactivated","error","unknown"],"type":"string","x-auditable":true}},"required":["ssl","ownership"],"type":"object"},"zoneId":{"description":"Zone ID of the custom domain resides in.","type":"string","x-auditable":true},"zoneName":{"description":"Zone that the custom domain resides in.","type":"string","x-auditable":true}},"required":["domain","status","enabled"],"type":"object"},"type":"array"}},"required":["domains"],"type":"object"},"r2_lock-rule-age-condition":{"description":"Condition to apply a lock rule to an object for how long in seconds.","properties":{"maxAgeSeconds":{"example":100,"type":"integer","x-auditable":true},"type":{"enum":["Age"],"type":"string","x-auditable":true}},"required":["type","maxAgeSeconds"],"type":"object"},"r2_lock-rule-date-condition":{"description":"Condition to apply a lock rule to an object until a specific date.","properties":{"date":{"format":"date-time","type":"string","x-auditable":true},"type":{"enum":["Date"],"type":"string","x-auditable":true}},"required":["type","date"],"type":"object"},"r2_lock-rule-indefinite-condition":{"description":"Condition to apply a lock rule indefinitely.","properties":{"type":{"enum":["Indefinite"],"type":"string","x-auditable":true}},"required":["type"],"type":"object"},"r2_managed_domain_response":{"example":{"bucketId":"0113a9e4549cf9b1ff1bf56e04da0cef","domain":"pub-0113a9e4549cf9b1ff1bf56e04da0cef.r2.dev","enabled":true},"properties":{"bucketId":{"description":"Bucket ID.","maxLength":32,"type":"string","x-auditable":true},"domain":{"description":"Domain name of the bucket's r2.dev domain.","type":"string","x-auditable":true},"enabled":{"description":"Whether this bucket is publicly accessible at the r2.dev domain.","type":"boolean","x-auditable":true}},"required":["bucketId","domain","enabled"],"type":"object"},"r2_messages":{"items":{"type":"string"},"type":"array"},"r2_object_size_metrics":{"description":"Metrics on number of objects/amount of storage used.","properties":{"metadataSize":{"description":"Amount of.","type":"number"},"objects":{"description":"Number of objects stored.","type":"number"},"payloadSize":{"description":"Amount of storage used by object data.","type":"number"}},"type":"object"},"r2_queue_identifier":{"description":"Queue ID.","example":"11111aa1-11aa-111a-a1a1-a1a111a11a11","maxLength":32,"type":"string","x-auditable":true},"r2_queues-config":{"properties":{"queueId":{"description":"Queue ID.","example":"11111aa1-11aa-111a-a1a1-a1a111a11a11","type":"string","x-auditable":true},"queueName":{"description":"Name of the queue.","example":"first-queue","type":"string","x-auditable":true},"rules":{"items":{"allOf":[{"$ref":"#/components/schemas/r2_rule"},{"properties":{"createdAt":{"description":"Timestamp when the rule was created.","example":"2024-09-19T21:54:48.405Z","type":"string","x-auditable":true},"description":{"description":"A description that can be used to identify the event notification rule after creation.","example":"Notifications from source bucket to queue","type":"string","x-auditable":true},"ruleId":{"description":"Rule ID.","example":"11111aa1-11aa-111a-a1a1-a1a111a11a11","type":"string","x-auditable":true}},"type":"object"}]},"type":"array"}},"type":"object"},"r2_r2-action":{"enum":["PutObject","CopyObject","DeleteObject","CompleteMultipartUpload","LifecycleDeletion"],"type":"string","x-auditable":true},"r2_remove_custom_domain_response":{"example":{"domain":"example-domain/custom-domain.com"},"properties":{"domain":{"description":"Name of the removed custom domain.","type":"string","x-auditable":true}},"required":["domain"],"type":"object"},"r2_result_info":{"properties":{"cursor":{"description":"A continuation token that should be used to fetch the next page of results.","example":"1-JTdCJTIydiUyMiUzQTElMkMlMjJzdGFydEFmdGVyJTIyJTNBJTIyZGF2aWRwdWJsaWMlMjIlN0Q=","type":"string"},"per_page":{"description":"Maximum number of results on this page.","example":20,"type":"number"}},"type":"object"},"r2_rule":{"properties":{"actions":{"description":"Array of R2 object actions that will trigger notifications.","example":["PutObject","CopyObject"],"items":{"$ref":"#/components/schemas/r2_r2-action"},"type":"array","uniqueItems":true},"description":{"description":"A description that can be used to identify the event notification rule after creation.","example":"Notifications from source bucket to queue","type":"string","x-auditable":true},"prefix":{"description":"Notifications will be sent only for objects with this prefix.","example":"img/","type":"string","x-auditable":true},"suffix":{"description":"Notifications will be sent only for objects with this suffix.","example":".jpeg","type":"string","x-auditable":true}},"required":["actions"],"type":"object"},"r2_sippy":{"properties":{"destination":{"description":"Details about the configured destination bucket.","properties":{"accessKeyId":{"description":"ID of the Cloudflare API token used when writing objects to this\nbucket.\n","type":"string"},"account":{"type":"string","x-auditable":true},"bucket":{"description":"Name of the bucket on the provider.","type":"string","x-auditable":true},"provider":{"enum":["r2"],"type":"string","x-auditable":true}},"type":"object"},"enabled":{"description":"State of Sippy for this bucket.","type":"boolean","x-auditable":true},"source":{"description":"Details about the configured source bucket.","properties":{"bucket":{"description":"Name of the bucket on the provider.","type":"string","x-auditable":true},"provider":{"enum":["aws","gcs"],"type":"string","x-auditable":true},"region":{"description":"Region where the bucket resides (AWS only).","nullable":true,"type":"string","x-auditable":true}},"type":"object"}},"type":"object"},"r2_storage_class":{"default":"Standard","description":"Storage class for newly uploaded objects, unless specified otherwise.","enum":["Standard","InfrequentAccess"],"type":"string","x-auditable":true},"r2_temp_access_creds_request":{"example":{"bucket":"example-bucket","objects":["example-object"],"parentAccessKeyId":"example-access-key-id","permission":"object-read-write","prefixes":["example-prefix/"],"ttlSeconds":3600},"properties":{"bucket":{"description":"Name of the R2 bucket.","type":"string","x-auditable":true},"objects":{"description":"Optional object paths to scope the credentials to.","items":{"type":"string","x-auditable":true},"type":"array"},"parentAccessKeyId":{"description":"The parent access key id to use for signing.","type":"string"},"permission":{"description":"Permissions allowed on the credentials.","enum":["admin-read-write","admin-read-only","object-read-write","object-read-only"],"type":"string","x-auditable":true},"prefixes":{"description":"Optional prefix paths to scope the credentials to.","items":{"type":"string","x-auditable":true},"type":"array"},"ttlSeconds":{"default":900,"description":"How long the credentials will live for in seconds.","maximum":604800,"type":"number","x-auditable":true}},"required":["bucket","permission","ttlSeconds","parentAccessKeyId"],"type":"object"},"r2_temp_access_creds_response":{"example":{"accessKeyId":"example-access-key-id","secretAccessKey":"example-secret-key","sessionToken":"example-session-token"},"properties":{"accessKeyId":{"description":"ID for new access key.","type":"string"},"secretAccessKey":{"description":"Secret access key.","type":"string","x-sensitive":true},"sessionToken":{"description":"Security token.","type":"string","x-sensitive":true}},"type":"object"},"r2_v4_response":{"properties":{"errors":{"$ref":"#/components/schemas/r2_errors"},"messages":{"$ref":"#/components/schemas/r2_messages"},"result":{"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"r2_v4_response_failure":{"properties":{"errors":{"$ref":"#/components/schemas/r2_errors"},"messages":{"$ref":"#/components/schemas/r2_messages"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"r2_v4_response_list":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result_info":{"$ref":"#/components/schemas/r2_result_info"}},"type":"object"}]},"realtimekit_AIConfig":{"description":"The AI Config allows you to customize the behavior of meeting transcriptions and summaries","properties":{"summarization":{"$ref":"#/components/schemas/realtimekit_SummarizationConfig"},"transcription":{"$ref":"#/components/schemas/realtimekit_TranscriptionConfig"}},"title":"AIConfig","type":"object"},"realtimekit_ActiveSession":{"properties":{"associated_id":{"description":"ID of the meeting this session is associated with. In the case of V2 meetings, it is always a UUID. In V1 meetings, it is a room name of the form `abcdef-ghijkl`","type":"string"},"breakout_rooms":{"items":{"$ref":"#/components/schemas/realtimekit_ActiveSession"},"readOnly":true,"type":"array"},"created_at":{"description":"timestamp when session created","type":"string"},"ended_at":{"description":"timestamp when session ended","type":"string"},"id":{"description":"ID of the session","readOnly":true,"type":"string"},"live_participants":{"description":"number of participants currently in the session","type":"number"},"max_concurrent_participants":{"description":"number of maximum participants that were in the session","type":"number"},"meeting_display_name":{"description":"Title of the meeting this session belongs to","type":"string"},"meta":{"description":"Any meta data about session.","type":"object"},"minutes_consumed":{"description":"number of minutes consumed since the session started","type":"number"},"organization_id":{"description":"App id that hosted this session","type":"string"},"started_at":{"description":"timestamp when session started","type":"string"},"status":{"description":"current status of session","enum":["LIVE","ENDED"],"type":"string"},"type":{"description":"type of session","enum":["meeting","livestream","participant"],"type":"string"},"updated_at":{"description":"timestamp when session was last updated","type":"string"}},"required":["id","associated_id","meeting_display_name","type","status","live_participants","max_concurrent_participants","minutes_consumed","organization_id","started_at","created_at","updated_at"],"type":"object"},"realtimekit_AudioConfig":{"description":"Object containing configuration regarding the audio that is being recorded.","properties":{"channel":{"default":"stereo","description":"Audio signal pathway within an audio file that carries a specific sound source.","enum":["mono","stereo"],"type":"string"},"codec":{"default":"AAC","description":"Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.","enum":["MP3","AAC"],"type":"string"},"export_file":{"default":true,"description":"Controls whether to export audio file seperately","type":"boolean"}},"title":"AudioConfig","type":"object"},"realtimekit_ChatMessage":{"properties":{"chat_download_url":{"description":"URL where the chat logs can be downloaded","type":"string"},"chat_download_url_expiry":{"description":"Time when the download URL will expire","type":"string"}},"required":["chat_download_url","chat_download_url_expiry"],"type":"object"},"realtimekit_CreateChatChannelInfo":{"properties":{"custom_participant_ids":{"items":{"type":"string"},"type":"array"},"display_name":{"type":"string"},"visibility":{"enum":["public","private"],"type":"string"}},"type":"object"},"realtimekit_DaywiseStats":{"properties":{"date":{"description":"Date in YYYY-MM-DD format","type":"string"},"recordings_minutes_consumed":{"description":"Total recordings minutes consumed across all sessions in the given time period.","type":"number"},"sessions_count":{"description":"Number of sessions_count happened in the given time period","type":"number"},"sessions_minutes_consumed":{"description":"Total meetings minutes consumed across all sessions in the given time period.","type":"number"}},"type":"object"},"realtimekit_ErrorResponse":{"properties":{"error":{"description":"Object containing details of the error that occurred","properties":{"code":{"description":"Error code","example":404,"type":"number"},"message":{"description":"Error message","example":"Error: resource not found","type":"string"}},"required":["code","message"],"type":"object"},"success":{"description":"Whether the operation succeeded or not","example":false,"type":"boolean"}},"required":["success","error"],"type":"object"},"realtimekit_GenericErrorResponse":{"properties":{"error":{"properties":{"code":{"description":"HTTP status code of the error.","type":"number"},"message":{"description":"Error message describing what went wrong.","type":"string"}},"required":["code","message"],"type":"object"},"success":{"default":false,"description":"Success status of the request.","type":"boolean"}},"required":["success","error"],"type":"object"},"realtimekit_GenericSuccessResponse":{"properties":{"data":{"description":"Data returned by the operation","type":"object"},"success":{"default":true,"description":"Success status of the operation","type":"boolean"}},"required":["success"],"title":"GenericSuccessResponse","type":"object"},"realtimekit_InteractiveConfig":{"description":"Allows you to add timed metadata to your recordings, which are digital markers inserted into a video file to provide contextual information at specific points in the content range. The ID3 tags containing this information are available to clients on the playback timeline in HLS format. The output files are generated in a compressed .tar format.","properties":{"type":{"description":"The metadata is presented in the form of ID3 tags.","enum":["ID3"],"type":"string"}},"title":"InteractiveConfig","type":"object"},"realtimekit_LivestreamBase":{"properties":{"created_at":{"description":"The timestamp at which the livestream was created. The time is returned in ISO format.","format":"date-time","type":"string"},"disabled":{"description":"Specifies if the livestream was disabled.","type":"boolean"},"id":{"description":"The livestream ID.","type":"string"},"ingest_server":{"description":"The server URL to which the RTMP encoder sends the video and audio data.","type":"string"},"meeting_id":{"description":"ID of the meeting.","nullable":true,"type":"string"},"name":{"description":"Name of the livestream.","nullable":true,"type":"string"},"org_id":{"type":"string"},"playback_url":{"description":"The web address that viewers can use to watch the livestream.","type":"string"},"status":{"description":"The status of the livestream.","enum":["LIVE","IDLE","ERRORED","INVOKED"],"type":"string"},"stream_key":{"description":"Unique key for accessing each livestream.","type":"string"},"updated_at":{"description":"The timestamp at which the livestream was updated. The time is returned in ISO format.","format":"date-time","type":"string"}},"type":"object"},"realtimekit_LivestreamingConfig":{"properties":{"rtmp_url":{"description":"RTMP URL to stream to","example":"rtmp://a.rtmp.youtube.com/live2","format":"uri","type":"string"}},"title":"LivestreamingConfig","type":"object"},"realtimekit_Meeting":{"properties":{"created_at":{"description":"Timestamp the object was created at. The time is returned in ISO format.","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"ID of the meeting.","format":"uuid","readOnly":true,"type":"string"},"live_stream_on_start":{"description":"Specifies if the meeting should start getting livestreamed on start.","type":"boolean"},"persist_chat":{"description":"Specifies if Chat within a meeting should persist for a week.","type":"boolean"},"preferred_region":{"description":"The region in which this meeting should be created.","enum":["ap-south-1","ap-southeast-1","us-east-1","eu-central-1",null],"nullable":true,"type":"string"},"record_on_start":{"description":"Specifies if the meeting should start getting recorded as soon as someone joins the meeting.","type":"boolean"},"session_keep_alive_time_in_secs":{"default":60,"description":"Time in seconds, for which a session remains active, after the last participant has left the meeting.","maximum":600,"minimum":60,"type":"number"},"status":{"description":"Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.","enum":["ACTIVE","INACTIVE"],"type":"string"},"summarize_on_end":{"description":"Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.","type":"boolean"},"title":{"description":"Title of the meeting.","type":"string"},"updated_at":{"description":"Timestamp the object was updated at. The time is returned in ISO format.","format":"date-time","readOnly":true,"type":"string"}},"required":["id","created_at","updated_at"],"type":"object"},"realtimekit_OverallStats":{"properties":{"recordings_minutes_consumed":{"description":"Total recordings minutes consumed across all sessions in the given time period.","type":"number"},"sessions_count":{"description":"Number of sessions_count happened in the given time period","type":"number"},"sessions_minutes_consumed":{"description":"Total meetings minutes consumed across all sessions in the given time period.","type":"number"}},"type":"object"},"realtimekit_PagingResponse":{"properties":{"data":{"items":{"type":"object"},"type":"array"},"paging":{"properties":{"end_offset":{"example":30,"type":"number"},"start_offset":{"example":1,"type":"number"},"total_count":{"example":30,"minimum":0,"type":"number"}},"required":["total_count","start_offset","end_offset"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["success","data","paging"],"title":"PagingResponse","type":"object"},"realtimekit_Participant":{"description":"Represents a participant.","properties":{"created_at":{"description":"When this object was created. The time is returned in ISO format.","format":"date-time","type":"string"},"custom_participant_id":{"description":"A unique participant ID generated by the client.","type":"string"},"id":{"description":"ID of the participant.","format":"uuid","type":"string"},"name":{"description":"Name of the participant.","nullable":true,"type":"string"},"picture":{"description":"URL to a picture of the participant.","format":"uri","nullable":true,"type":"string"},"preset_name":{"description":"Preset applied to the participant.","type":"string"},"updated_at":{"description":"When this object was updated. The time is returned in ISO format.","format":"date-time","type":"string"}},"required":["id","custom_participant_id","preset_name","created_at","updated_at"],"title":"Participant","type":"object"},"realtimekit_ParticipantPeerStats":{"properties":{"peer_stats":{"properties":{"config":{"type":"string"},"device_info":{"properties":{"browser":{"type":"string"},"browser_version":{"type":"string"},"cpus":{"type":"number"},"engine":{"type":"string"},"is_mobile":{"type":"boolean"},"memory":{"type":"number"},"os":{"type":"string"},"os_version":{"type":"string"},"sdk_name":{"type":"string"},"sdk_version":{"type":"string"},"user_agent":{"type":"string"},"webgl_support":{"type":"string"}},"type":"object"},"events":{"items":{"properties":{"timestamp":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"ip_information":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"ip_location":{"type":"string"},"ipv4":{"type":"string"},"org":{"type":"string"},"portal":{"type":"string"},"region":{"type":"string"},"timezone":{"type":"string"}},"type":"object"},"precall_network_information":{"properties":{"backend_rtt":{"type":"number"},"effective_networktype":{"type":"string"},"fractional_loss":{"type":"number"},"jitter":{"type":"number"},"reflexive_connectivity":{"type":"boolean"},"relay_connectivity":{"type":"boolean"},"rtt":{"type":"number"},"throughtput":{"type":"number"},"turn_connectivity":{"type":"boolean"}},"type":"object"},"status":{"type":"string"}},"type":"object"}},"type":"object"},"realtimekit_ParticipantQualityStats":{"properties":{"quality_stats":{"items":{"properties":{"audio_bandwidth":{"type":"number"},"audio_packet_loss":{"type":"number"},"audio_stats":{"items":{"properties":{"concealment_events":{"type":"number"},"jitter":{"type":"number"},"packets_lost":{"type":"number"},"quality":{"type":"number"},"timestamp":{"type":"string"}},"type":"object"},"type":"array"},"average_quality":{"type":"number"},"end":{"type":"string"},"peer_id":{"type":"string"},"start":{"type":"string"},"video_bandwidth":{"type":"number"},"video_packet_loss":{"type":"number"},"video_stats":{"items":{"properties":{"frame_height":{"type":"number"},"frame_width":{"type":"number"},"frames_dropped":{"type":"number"},"frames_per_second":{"type":"number"},"jitter":{"type":"number"},"packets_lost":{"type":"number"},"quality":{"type":"number"},"timestamp":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"realtimekit_ParticipantsList":{"properties":{"created_at":{"description":"timestamp when this participant was created.","type":"string"},"custom_participant_id":{"description":"ID passed by client to create this participant.","type":"string"},"display_name":{"description":"Display name of participant when joining the session.","type":"string"},"duration":{"description":"number of minutes for which the participant was in the session.","type":"number"},"id":{"description":"Participant ID. This maps to the corresponding peerId.","type":"string"},"joined_at":{"description":"timestamp at which participant joined the session.","type":"string"},"left_at":{"description":"timestamp at which participant left the session.","type":"string"},"preset_name":{"description":"Name of the preset associated with the participant.","type":"string"},"updated_at":{"description":"timestamp when this participant's data was last updated.","type":"string"},"user_id":{"description":"User id for this participant.","type":"string"}},"type":"object"},"realtimekit_PatchWebhookRequest":{"properties":{"enabled":{"default":true,"type":"boolean"},"events":{"description":"Events that the webhook will get triggered by","items":{"enum":["meeting.started","meeting.ended","meeting.participantJoined","meeting.participantLeft","recording.statusUpdate","livestreaming.statusUpdate","meeting.chatSynced","meeting.transcript","meeting.summary"],"type":"string"},"type":"array"},"name":{"description":"Name of the webhook","type":"string"},"url":{"description":"URL the webhook will send events to","example":"https://webhook.site/b23a5bbd-c7b0-4ced-a9e2-78ae7889897e","format":"uri","type":"string"}},"type":"object"},"realtimekit_Poll":{"properties":{"anonymous":{"type":"boolean"},"created_by":{"type":"string"},"hide_votes":{"type":"boolean"},"id":{"description":"ID of the poll","readOnly":true,"type":"string"},"options":{"description":"Answer options","items":{"properties":{"count":{"type":"number"},"text":{"description":"Text of the answer option","type":"string"},"votes":{"items":{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"type":"array"}},"required":["text","count","votes"],"type":"object"},"type":"array"},"question":{"description":"Question asked by the poll","type":"string"},"voted":{"items":{"type":"string"},"type":"array"}},"required":["id","question","options"],"type":"object"},"realtimekit_Preset":{"properties":{"config":{"properties":{"max_screenshare_count":{"description":"Maximum number of screen shares that can be active at a given time","type":"integer"},"max_video_streams":{"description":"Maximum number of streams that are visible on a device","properties":{"desktop":{"description":"Maximum number of video streams visible on desktop devices","type":"integer"},"mobile":{"description":"Maximum number of streams visible on mobile devices","type":"integer"}},"required":["mobile","desktop"],"type":"object"},"media":{"description":"Media configuration options. eg: Video quality","properties":{"audio":{"description":"Control options for Audio quality.","properties":{"enable_high_bitrate":{"default":false,"description":"Enable High Quality Audio for your meetings","type":"boolean"},"enable_stereo":{"default":false,"description":"Enable Stereo for your meetings","type":"boolean"}},"type":"object"},"screenshare":{"description":"Configuration options for participant screen shares","properties":{"frame_rate":{"description":"Frame rate of screen share","type":"integer"},"quality":{"description":"Quality of screen share ","enum":["hd","vga","qvga"],"type":"string"}},"required":["quality","frame_rate"],"type":"object"},"video":{"description":"Configuration options for participant videos","properties":{"frame_rate":{"description":"Frame rate of participants' video","maximum":30,"type":"integer"},"quality":{"description":"Video quality of participants","enum":["hd","vga","qvga"],"type":"string"}},"required":["quality","frame_rate"],"type":"object"}},"required":["video","screenshare"],"type":"object"},"view_type":{"description":"Type of the meeting","enum":["GROUP_CALL","WEBINAR","AUDIO_ROOM"],"type":"string"}},"required":["view_type","max_video_streams","max_screenshare_count","media"],"type":"object"},"name":{"description":"Name of the preset","type":"string"},"permissions":{"properties":{"accept_waiting_requests":{"description":"Whether this participant can accept waiting requests","type":"boolean"},"can_accept_production_requests":{"type":"boolean"},"can_change_participant_permissions":{"type":"boolean"},"can_edit_display_name":{"type":"boolean"},"can_livestream":{"type":"boolean"},"can_record":{"type":"boolean"},"can_spotlight":{"type":"boolean"},"chat":{"description":"Chat permissions","properties":{"private":{"properties":{"can_receive":{"type":"boolean"},"can_send":{"type":"boolean"},"files":{"type":"boolean"},"text":{"type":"boolean"}},"required":["can_send","can_receive","text","files"],"type":"object"},"public":{"properties":{"can_send":{"description":"Can send messages in general","type":"boolean"},"files":{"description":"Can send file messages","type":"boolean"},"text":{"description":"Can send text messages","type":"boolean"}},"required":["can_send","text","files"],"type":"object"}},"required":["public","private"],"type":"object"},"connected_meetings":{"properties":{"can_alter_connected_meetings":{"type":"boolean"},"can_switch_connected_meetings":{"type":"boolean"},"can_switch_to_parent_meeting":{"type":"boolean"}},"required":["can_alter_connected_meetings","can_switch_connected_meetings","can_switch_to_parent_meeting"],"type":"object"},"disable_participant_audio":{"type":"boolean"},"disable_participant_screensharing":{"type":"boolean"},"disable_participant_video":{"type":"boolean"},"hidden_participant":{"description":"Whether this participant is visible to others or not","type":"boolean"},"is_recorder":{"default":false,"type":"boolean"},"kick_participant":{"type":"boolean"},"media":{"description":"Media permissions","properties":{"audio":{"description":"Audio permissions","properties":{"can_produce":{"description":"Can produce audio","enum":["ALLOWED","NOT_ALLOWED","CAN_REQUEST"],"type":"string"}},"required":["can_produce"],"type":"object"},"screenshare":{"description":"Screenshare permissions","properties":{"can_produce":{"description":"Can produce screen share video","enum":["ALLOWED","NOT_ALLOWED","CAN_REQUEST"],"type":"string"}},"required":["can_produce"],"type":"object"},"video":{"description":"Video permissions","properties":{"can_produce":{"description":"Can produce video","enum":["ALLOWED","NOT_ALLOWED","CAN_REQUEST"],"type":"string"}},"required":["can_produce"],"type":"object"}},"required":["video","audio","screenshare"],"type":"object"},"pin_participant":{"type":"boolean"},"plugins":{"description":"Plugin permissions","properties":{"can_close":{"description":"Can close plugins that are already open","type":"boolean"},"can_edit_config":{"description":"Can edit plugin config","type":"boolean"},"can_start":{"description":"Can start plugins","type":"boolean"},"config":{"oneOf":[{"format":"uuid","type":"string"},{"properties":{"access_control":{"enum":["FULL_ACCESS","VIEW_ONLY"],"type":"string"},"handles_view_only":{"type":"boolean"}},"required":["access_control","handles_view_only"],"type":"object"}]}},"required":["can_close","can_start","can_edit_config","config"],"type":"object"},"polls":{"description":"Poll permissions","properties":{"can_create":{"description":"Can create polls","type":"boolean"},"can_view":{"description":"Can view polls","type":"boolean"},"can_vote":{"description":"Can vote on polls","type":"boolean"}},"required":["can_create","can_vote","can_view"],"type":"object"},"recorder_type":{"default":"NONE","description":"Type of the recording peer","enum":["RECORDER","LIVESTREAMER","NONE"],"type":"string"},"show_participant_list":{"type":"boolean"},"waiting_room_type":{"description":"Waiting room type","enum":["SKIP","ON_PRIVILEGED_USER_ENTRY","SKIP_ON_ACCEPT"],"type":"string"}},"required":["accept_waiting_requests","can_accept_production_requests","can_edit_display_name","can_spotlight","recorder_type","disable_participant_audio","disable_participant_screensharing","disable_participant_video","kick_participant","pin_participant","can_record","can_livestream","waiting_room_type","plugins","connected_meetings","polls","media","chat","hidden_participant","show_participant_list","can_change_participant_permissions"],"type":"object"},"ui":{"properties":{"config_diff":{"type":"object"},"design_tokens":{"properties":{"border_radius":{"enum":["rounded"],"type":"string"},"border_width":{"enum":["thin"],"type":"string"},"colors":{"properties":{"background":{"properties":{"1000":{"default":"#141414","type":"string"},"600":{"default":"#222222","type":"string"},"700":{"default":"#1f1f1f","type":"string"},"800":{"default":"#1b1b1b","type":"string"},"900":{"default":"#181818","type":"string"}},"required":["600","700","800","900","1000"],"type":"object"},"brand":{"properties":{"300":{"default":"#844d1c","type":"string"},"400":{"default":"#9d5b22","type":"string"},"500":{"default":"#b56927","type":"string"},"600":{"default":"#d37c30","type":"string"},"700":{"default":"#d9904f","type":"string"}},"required":["300","400","500","600","700"],"type":"object"},"danger":{"default":"#FF2D2D","type":"string"},"success":{"default":"#62A504","type":"string"},"text":{"default":"#EEEEEE","type":"string"},"text_on_brand":{"default":"#EEEEEE","type":"string"},"video_bg":{"default":"#191919","type":"string"},"warning":{"default":"#FFCD07","type":"string"}},"required":["brand","background","danger","text","text_on_brand","success","video_bg","warning"],"type":"object"},"logo":{"type":"string"},"spacing_base":{"default":4,"type":"number"},"theme":{"enum":["dark"],"type":"string"}},"required":["border_radius","border_width","spacing_base","theme","colors","logo"],"type":"object"}},"required":["design_tokens"],"type":"object"}},"required":["name","config","ui"],"title":"Preset","type":"object"},"realtimekit_PresetListItem":{"description":"Returned by Get All Presets route","properties":{"created_at":{"description":"Timestamp this preset was created at","format":"date-time","type":"string"},"id":{"description":"ID of the preset","format":"uuid","type":"string"},"name":{"description":"Name of the preset","type":"string"},"updated_at":{"description":"Timestamp this preset was last updated","format":"date-time","type":"string"}},"title":"PresetListItem","type":"object"},"realtimekit_Recording":{"properties":{"audio_download_url":{"description":"If the audio_config is passed, the URL for downloading the audio recording is returned.","format":"uri","nullable":true,"readOnly":true,"type":"string"},"download_url":{"description":"URL where the recording can be downloaded.","format":"uri","nullable":true,"readOnly":true,"type":"string"},"download_url_expiry":{"description":"Timestamp when the download URL expires.","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"file_size":{"description":"File size of the recording, in bytes.","nullable":true,"readOnly":true,"type":"number"},"id":{"description":"ID of the recording","format":"uuid","readOnly":true,"type":"string"},"invoked_time":{"description":"Timestamp when this recording was invoked.","format":"date-time","type":"string"},"output_file_name":{"description":"File name of the recording.","type":"string"},"recording_duration":{"description":"Total recording time in seconds.","type":"integer"},"session_id":{"description":"ID of the meeting session this recording is for.","format":"uuid","nullable":true,"readOnly":true,"type":"string"},"started_time":{"description":"Timestamp when this recording actually started after being invoked. Usually a few seconds after `invoked_time`.","format":"date-time","nullable":true,"type":"string"},"status":{"description":"Current status of the recording.","enum":["INVOKED","RECORDING","UPLOADING","UPLOADED","ERRORED","PAUSED"],"type":"string"},"stopped_time":{"description":"Timestamp when this recording was stopped. Optional; is present only when the recording has actually been stopped.","format":"date-time","nullable":true,"type":"string"}},"required":["id","download_url","download_url_expiry","audio_download_url","file_size","session_id","output_file_name","status","invoked_time","started_time","stopped_time"],"title":"Recording","type":"object"},"realtimekit_RecordingConfig":{"description":"Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.\n","properties":{"audio_config":{"$ref":"#/components/schemas/realtimekit_AudioConfig"},"file_name_prefix":{"description":"Adds a prefix to the beginning of the file name of the recording.","type":"string"},"live_streaming_config":{"$ref":"#/components/schemas/realtimekit_LivestreamingConfig"},"max_seconds":{"description":"Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours.","maximum":86400,"minimum":60,"type":"number"},"realtimekit_bucket_config":{"$ref":"#/components/schemas/realtimekit_realtimekitBucketConfig"},"storage_config":{"$ref":"#/components/schemas/realtimekit_StorageConfig"},"video_config":{"$ref":"#/components/schemas/realtimekit_VideoConfig"}},"title":"RecordingConfig","type":"object"},"realtimekit_SessionParticipant":{"properties":{"created_at":{"type":"string"},"email":{"description":"Email of the session participant.","type":"string"},"id":{"description":"ID of the session participant","type":"string"},"name":{"description":"Name of the session participant.","type":"string"},"picture":{"description":"A URL pointing to a picture of the participant.","type":"string"},"updated_at":{"type":"string"}},"required":["id","created_at","updated_at"],"title":"SessionParticipant","type":"object"},"realtimekit_StorageConfig":{"nullable":true,"properties":{"access_key":{"description":"Access key of the storage medium. Access key is not required for the `gcs` storage media type.\n\nNote that this field is not readable by clients, only writeable.","type":"string","writeOnly":true},"auth_method":{"description":"Authentication method used for \"sftp\" type storage medium\n","enum":["KEY","PASSWORD"],"type":"string"},"bucket":{"description":"Name of the storage medium's bucket.","type":"string"},"host":{"description":"SSH destination server host for SFTP type storage medium","type":"string"},"password":{"description":"SSH destination server password for SFTP type storage medium when auth_method is \"PASSWORD\". If auth_method is \"KEY\", this specifies the password for the ssh private key.","type":"string"},"path":{"description":"Path relative to the bucket root at which the recording will be placed.","type":"string"},"port":{"description":"SSH destination server port for SFTP type storage medium","type":"number"},"private_key":{"description":"Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is \"KEY\"","type":"string"},"region":{"description":"Region of the storage medium.","example":"us-east-1","type":"string"},"secret":{"description":"Secret key of the storage medium. Similar to `access_key`, it is only writeable by clients, not readable.","type":"string"},"type":{"description":"Type of storage media.","enum":["aws","azure","digitalocean","gcs","sftp"],"type":"string"},"username":{"description":"SSH destination server username for SFTP type storage medium","type":"string"}},"required":["type"],"title":"StorageConfig","type":"object"},"realtimekit_SummarizationConfig":{"description":"Summary Config","properties":{"summary_type":{"default":"general","description":"Defines the style of the summary, such as general, team meeting, or sales call.","enum":["general","team_meeting","sales_call","client_check_in","interview","daily_standup","one_on_one_meeting","lecture","code_review"],"type":"string"},"text_format":{"default":"markdown","description":"Determines the text format of the summary, such as plain text or markdown.","enum":["plain_text","markdown"],"type":"string"},"word_limit":{"default":500,"description":"Sets the maximum number of words in the meeting summary.","maximum":1000,"minimum":150,"type":"integer"}},"title":"SummarizationConfig","type":"object"},"realtimekit_TrackConfigLayer":{"properties":{"file_name_prefix":{"description":"A file name prefix to apply for files generated from this layer","type":"string"},"outputs":{"items":{"$ref":"#/components/schemas/realtimekit_TrackLayerOutput"},"type":"array"}},"title":"TrackLayerConfig","type":"object"},"realtimekit_TrackLayerOutput":{"properties":{"storage_config":{"$ref":"#/components/schemas/realtimekit_StorageConfig"},"type":{"default":"REALTIMEKIT_BUCKET","description":"The type of output destination this layer is being exported to.","enum":["REALTIMEKIT_BUCKET","STORAGE_CONFIG"],"type":"string"}},"title":"TrackLayerOutput","type":"object"},"realtimekit_Transcript":{"properties":{"sessionId":{"type":"string"},"transcript_download_url":{"description":"URL where the transcript can be downloaded","type":"string"},"transcript_download_url_expiry":{"description":"Time when the download URL will expire","type":"string"}},"required":["sessionId","transcript_download_url","transcript_download_url_expiry"],"type":"object"},"realtimekit_TranscriptSummary":{"properties":{"sessionId":{"type":"string"},"summaryDownloadUrl":{"description":"URL where the summary of transcripts can be downloaded","type":"string"},"summaryDownloadUrlExpiry":{"description":"Time of Expiry before when you need to download the csv file.","type":"string"}},"required":["sessionId","summaryDownloadUrl","summaryDownloadUrlExpiry"],"title":"TranscriptSummary","type":"object"},"realtimekit_TranscriptionConfig":{"description":"Transcription Configurations","properties":{"keywords":{"description":"Adds specific terms to improve accurate detection during transcription.","items":{"type":"string"},"type":"array"},"language":{"default":"en-US","description":"Specifies the language code for transcription to ensure accurate results.","enum":["en-US","en-IN","de","hi","sv","ru","pl","el","fr","nl"],"type":"string"},"profanity_filter":{"default":false,"description":"Control the inclusion of offensive language in transcriptions.","type":"boolean"}},"title":"TranscriptionConfig","type":"object"},"realtimekit_UpdatePreset":{"properties":{"config":{"properties":{"max_screenshare_count":{"description":"Maximum number of screen shares that can be active at a given time","type":"integer"},"max_video_streams":{"description":"Maximum number of streams that are visible on a device","properties":{"desktop":{"description":"Maximum number of video streams visible on desktop devices","type":"integer"},"mobile":{"description":"Maximum number of streams visible on mobile devices","type":"integer"}},"type":"object"},"media":{"description":"Media configuration options. eg: Video quality","properties":{"screenshare":{"description":"Configuration options for participant screen shares","properties":{"frame_rate":{"description":"Frame rate of screen share","type":"integer"},"quality":{"description":"Quality of screen share ","enum":["hd","vga","qvga"],"type":"string"}},"type":"object"},"video":{"description":"Configuration options for participant videos","properties":{"frame_rate":{"description":"Frame rate of participants' video","maximum":30,"type":"integer"},"quality":{"description":"Video quality of participants","enum":["hd","vga","qvga"],"type":"string"}},"type":"object"}},"type":"object"},"view_type":{"description":"Type of the meeting","enum":["GROUP_CALL","WEBINAR","AUDIO_ROOM"],"type":"string"}},"type":"object"},"name":{"description":"Name of the preset","type":"string"},"permissions":{"properties":{"accept_waiting_requests":{"description":"Whether this participant can accept waiting requests","type":"boolean"},"can_accept_production_requests":{"type":"boolean"},"can_change_participant_permissions":{"type":"boolean"},"can_edit_display_name":{"type":"boolean"},"can_livestream":{"type":"boolean"},"can_record":{"type":"boolean"},"can_spotlight":{"type":"boolean"},"chat":{"description":"Chat permissions","properties":{"private":{"properties":{"can_receive":{"type":"boolean"},"can_send":{"type":"boolean"},"files":{"type":"boolean"},"text":{"type":"boolean"}},"type":"object"},"public":{"properties":{"can_send":{"description":"Can send messages in general","type":"boolean"},"files":{"description":"Can send file messages","type":"boolean"},"text":{"description":"Can send text messages","type":"boolean"}},"type":"object"}},"type":"object"},"connected_meetings":{"properties":{"can_alter_connected_meetings":{"type":"boolean"},"can_switch_connected_meetings":{"type":"boolean"},"can_switch_to_parent_meeting":{"type":"boolean"}},"type":"object"},"disable_participant_audio":{"type":"boolean"},"disable_participant_screensharing":{"type":"boolean"},"disable_participant_video":{"type":"boolean"},"hidden_participant":{"description":"Whether this participant is visible to others or not","type":"boolean"},"is_recorder":{"default":false,"type":"boolean"},"kick_participant":{"type":"boolean"},"media":{"description":"Media permissions","properties":{"audio":{"description":"Audio permissions","properties":{"can_produce":{"description":"Can produce audio","enum":["ALLOWED","NOT_ALLOWED","CAN_REQUEST"],"type":"string"}},"type":"object"},"screenshare":{"description":"Screenshare permissions","properties":{"can_produce":{"description":"Can produce screen share video","enum":["ALLOWED","NOT_ALLOWED","CAN_REQUEST"],"type":"string"}},"type":"object"},"video":{"description":"Video permissions","properties":{"can_produce":{"description":"Can produce video","enum":["ALLOWED","NOT_ALLOWED","CAN_REQUEST"],"type":"string"}},"type":"object"}},"type":"object"},"pin_participant":{"type":"boolean"},"plugins":{"description":"Plugin permissions","properties":{"can_close":{"description":"Can close plugins that are already open","type":"boolean"},"can_edit_config":{"description":"Can edit plugin config","type":"boolean"},"can_start":{"description":"Can start plugins","type":"boolean"},"config":{"oneOf":[{"format":"uuid","type":"string"},{"properties":{"access_control":{"enum":["FULL_ACCESS","VIEW_ONLY"],"type":"string"},"handles_view_only":{"type":"boolean"}},"type":"object"}]}},"type":"object"},"polls":{"description":"Poll permissions","properties":{"can_create":{"description":"Can create polls","type":"boolean"},"can_view":{"description":"Can view polls","type":"boolean"},"can_vote":{"description":"Can vote on polls","type":"boolean"}},"type":"object"},"recorder_type":{"default":"NONE","description":"Type of the recording peer","enum":["RECORDER","LIVESTREAMER","NONE"],"type":"string"},"show_participant_list":{"type":"boolean"},"waiting_room_type":{"description":"Waiting room type","enum":["SKIP","ON_PRIVILEGED_USER_ENTRY","SKIP_ON_ACCEPT"],"type":"string"}},"type":"object"},"ui":{"properties":{"config_diff":{"type":"object"},"design_tokens":{"properties":{"border_radius":{"enum":["rounded"],"type":"string"},"border_width":{"enum":["thin"],"type":"string"},"colors":{"properties":{"background":{"properties":{"1000":{"default":"#141414","type":"string"},"600":{"default":"#222222","type":"string"},"700":{"default":"#1f1f1f","type":"string"},"800":{"default":"#1b1b1b","type":"string"},"900":{"default":"#181818","type":"string"}},"type":"object"},"brand":{"properties":{"300":{"default":"#844d1c","type":"string"},"400":{"default":"#9d5b22","type":"string"},"500":{"default":"#b56927","type":"string"},"600":{"default":"#d37c30","type":"string"},"700":{"default":"#d9904f","type":"string"}},"type":"object"},"danger":{"default":"#FF2D2D","type":"string"},"success":{"default":"#62A504","type":"string"},"text":{"default":"#EEEEEE","type":"string"},"text_on_brand":{"default":"#EEEEEE","type":"string"},"video_bg":{"default":"#191919","type":"string"},"warning":{"default":"#FFCD07","type":"string"}},"type":"object"},"logo":{"type":"string"},"spacing_base":{"default":4,"type":"number"},"theme":{"enum":["dark"],"type":"string"}},"type":"object"}},"type":"object"}},"title":"UpdatePreset","type":"object"},"realtimekit_VideoConfig":{"properties":{"codec":{"default":"H264","description":"Codec using which the recording will be encoded.","enum":["H264","VP8"],"type":"string"},"export_file":{"default":true,"description":"Controls whether to export video file seperately","type":"boolean"},"height":{"default":720,"description":"Height of the recording video in pixels","example":720,"maximum":1920,"minimum":1,"type":"integer"},"watermark":{"description":"Watermark to be added to the recording","properties":{"position":{"default":"left top","description":"Position of the watermark","enum":["left top","right top","left bottom","right bottom"],"type":"string"},"size":{"description":"Size of the watermark","properties":{"height":{"description":"Height of the watermark in px","minimum":1,"type":"integer"},"width":{"description":"Width of the watermark in px","minimum":1,"type":"integer"}},"type":"object"},"url":{"description":"URL of the watermark image","format":"uri","type":"string"}},"type":"object"},"width":{"default":1280,"description":"Width of the recording video in pixels","example":1280,"maximum":1920,"minimum":1,"type":"integer"}},"title":"VideoConfig","type":"object"},"realtimekit_Webhook":{"properties":{"created_at":{"description":"Timestamp when this webhook was created","example":"2022-05-28T07:01:53.075Z","format":"date-time","type":"string"},"enabled":{"description":"Set to true if the webhook is active","type":"boolean"},"events":{"description":"Events this webhook will send updates for","example":["meeting.started","meeting.ended","meeting.participantJoined","meeting.participantLeft","meeting.chatSynced","recording.statusUpdate","livestreaming.statusUpdate","meeting.transcript","meeting.summary"],"items":{"enum":["meeting.started","meeting.ended","meeting.participantJoined","meeting.participantLeft","meeting.chatSynced","recording.statusUpdate","livestreaming.statusUpdate","meeting.transcript","meeting.summary"],"type":"string"},"type":"array"},"id":{"description":"ID of the webhook","example":"0d1f069d-43bb-489a-ad8c-7eb95592ba8e","format":"uuid","readOnly":true,"type":"string"},"name":{"description":"Name of the webhook","example":"All events webhook","type":"string"},"updated_at":{"description":"Timestamp when this webhook was updated","example":"2022-05-28T07:01:53.075Z","format":"date-time","type":"string"},"url":{"description":"URL the webhook will send events to","example":"https://webhook.site/b23a5bbd-c7b0-4ced-a9e2-78ae7889897e","format":"uri","type":"string"}},"required":["id","name","url","events","created_at","updated_at","enabled"],"type":"object"},"realtimekit_WebhookRequest":{"properties":{"enabled":{"default":true,"description":"Set whether or not the webhook should be active when created","type":"boolean"},"events":{"description":"Events that this webhook will get triggered by","example":["meeting.started","meeting.ended","meeting.participantJoined","meeting.participantLeft","meeting.chatSynced","recording.statusUpdate","livestreaming.statusUpdate","meeting.transcript","meeting.summary"],"items":{"enum":["meeting.started","meeting.ended","meeting.participantJoined","meeting.participantLeft","meeting.chatSynced","recording.statusUpdate","livestreaming.statusUpdate","meeting.transcript","meeting.summary"],"type":"string"},"type":"array"},"name":{"description":"Name of the webhook","example":"All events webhook","type":"string"},"url":{"description":"URL this webhook will send events to","example":"https://webhook.site/b23a5bbd-c7b0-4ced-a9e2-78ae7889897e","format":"uri","type":"string"}},"required":["name","url","events"],"type":"object"},"realtimekit_WebhookSuccessResponse":{"properties":{"data":{"$ref":"#/components/schemas/realtimekit_Webhook"},"success":{"example":true,"type":"boolean"}},"required":["success","data"],"type":"object"},"realtimekit_WebhooksListSuccessResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/realtimekit_Webhook"},"type":"array"},"success":{"example":true,"type":"boolean"}},"required":["success","data"],"type":"object"},"realtimekit_account_identifier":{"description":"The account identifier tag.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"realtimekit_app_id":{"description":"The app identifier tag.","example":"14a396e7-ca44-4937-bf1f-050a69118543","maxLength":32,"type":"string"},"realtimekit_created":{"description":"The date and time the item was created.","example":"2025-01-02T02:20:00Z","format":"date-time","type":"string"},"realtimekit_identifier":{"description":"A Cloudflare-generated unique identifier for a item.","example":"2a95132c15732412d22c1476fa83f27a","maxLength":32,"minLength":32,"type":"string","x-auditable":true},"realtimekit_modified":{"description":"The date and time the item was last modified.","example":"2025-01-02T02:20:00Z","format":"date-time","type":"string"},"realtimekit_realtimekitBucketConfig":{"properties":{"enabled":{"description":"Controls whether recordings are uploaded to RealtimeKit's bucket. If set to false, `download_url`, `audio_download_url`, `download_url_expiry` won't be generated for a recording.","type":"boolean"}},"required":["enabled"],"title":"realtimekitBucketConfig","type":"object"},"realtimekit_secret":{"description":"Bearer token","example":"66bcf64aa8907b9f9d90ac17746a77ce394c393b92b3916633dc02846e608ad4","maxLength":64,"minLength":64,"type":"string","x-sensitive":true},"realtimekit_startReason":{"properties":{"caller":{"properties":{"name":{"description":"Name of the user who started the recording.","example":"RealtimeKit_test","type":"string"},"type":{"description":"The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.","enum":["ORGANIZATION","USER"],"type":"string"},"user_Id":{"description":"The user ID of the person who started the recording.","example":"d61f6956-e68f-4375-bf10-c38a704d1bec","format":"uuid","type":"string"}},"type":"object"},"reason":{"description":"Specifies if the recording was started using the \"Start a Recording\"API or using the parameter RECORD_ON_START in the \"Create a meeting\" API. \n\nIf the recording is initiated using the \"RECORD_ON_START\" parameter, the user details will not be populated.","enum":["API_CALL","RECORD_ON_START"],"type":"string"}},"title":"startReason","type":"object"},"realtimekit_stopReason":{"properties":{"caller":{"properties":{"name":{"description":"Name of the user who stopped the recording.","example":"RealtimeKit_test","type":"string"},"type":{"description":"The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.","enum":["ORGANIZATION","USER"],"type":"string"},"user_Id":{"description":"The user ID of the person who stopped the recording.","example":"d61f6956-e68f-4375-bf10-c38a704d1bec","format":"uuid","type":"string"}},"type":"object"},"reason":{"description":"Specifies the reason why the recording stopped.","enum":["API_CALL","INTERNAL_ERROR","ALL_PEERS_LEFT"],"type":"string"}},"title":"stopReason","type":"object"},"realtimekit_success":{"type":"boolean"},"registrar-api_address":{"description":"Address.","example":"123 Sesame St.","type":"string"},"registrar-api_address2":{"description":"Optional address line for unit, floor, suite, etc.","example":"Suite 430","type":"string"},"registrar-api_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/registrar-api_api-response-common"},{"properties":{"result":{"items":{},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/registrar-api_result_info"}}}],"type":"object"},"registrar-api_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/registrar-api_messages"},"messages":{"$ref":"#/components/schemas/registrar-api_messages"},"result":{"anyOf":[{"type":"object"},{"items":{"type":"object"},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"registrar-api_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/registrar-api_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/registrar-api_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"registrar-api_api-response-single":{"allOf":[{"$ref":"#/components/schemas/registrar-api_api-response-common"},{"properties":{"result":{"nullable":true,"type":"object"}}}],"type":"object"},"registrar-api_auto_renew":{"description":"Auto-renew controls whether subscription is automatically renewed upon domain expiration.","example":true,"type":"boolean","x-auditable":true},"registrar-api_available":{"description":"Shows if a domain is available for transferring into Cloudflare Registrar.","example":false,"type":"boolean"},"registrar-api_can_register":{"description":"Indicates if the domain can be registered as a new domain.","example":false,"type":"boolean"},"registrar-api_city":{"description":"City.","example":"Austin","type":"string"},"registrar-api_contact_identifier":{"description":"Contact Identifier.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"readOnly":true,"type":"string"},"registrar-api_contact_properties":{"properties":{"address":{"$ref":"#/components/schemas/registrar-api_address"},"address2":{"$ref":"#/components/schemas/registrar-api_address2"},"city":{"$ref":"#/components/schemas/registrar-api_city"},"country":{"$ref":"#/components/schemas/registrar-api_country"},"email":{"$ref":"#/components/schemas/registrar-api_email"},"fax":{"$ref":"#/components/schemas/registrar-api_fax"},"first_name":{"$ref":"#/components/schemas/registrar-api_first_name"},"id":{"$ref":"#/components/schemas/registrar-api_contact_identifier"},"last_name":{"$ref":"#/components/schemas/registrar-api_last_name"},"organization":{"$ref":"#/components/schemas/registrar-api_organization"},"phone":{"$ref":"#/components/schemas/registrar-api_telephone"},"state":{"$ref":"#/components/schemas/registrar-api_state"},"zip":{"$ref":"#/components/schemas/registrar-api_zipcode"}},"required":["first_name","last_name","address","city","state","zip","country","phone","organization"],"type":"object"},"registrar-api_contacts":{"allOf":[{"$ref":"#/components/schemas/registrar-api_contact_properties"}],"type":"object"},"registrar-api_country":{"description":"The country in which the user lives.","example":"US","maxLength":30,"nullable":true,"type":"string"},"registrar-api_created_at":{"description":"Shows time of creation.","example":"2018-08-28T17:26:26Z","format":"date-time","type":"string"},"registrar-api_current_registrar":{"description":"Shows name of current registrar.","example":"Cloudflare","type":"string"},"registrar-api_domain_identifier":{"description":"Domain identifier.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"readOnly":true,"type":"string"},"registrar-api_domain_name":{"description":"Domain name.","example":"cloudflare.com","type":"string"},"registrar-api_domain_properties":{"properties":{"available":{"$ref":"#/components/schemas/registrar-api_available"},"can_register":{"$ref":"#/components/schemas/registrar-api_can_register"},"created_at":{"$ref":"#/components/schemas/registrar-api_created_at"},"current_registrar":{"$ref":"#/components/schemas/registrar-api_current_registrar"},"expires_at":{"$ref":"#/components/schemas/registrar-api_expires_at"},"id":{"$ref":"#/components/schemas/registrar-api_domain_identifier"},"locked":{"$ref":"#/components/schemas/registrar-api_locked"},"registrant_contact":{"$ref":"#/components/schemas/registrar-api_registrant_contact"},"registry_statuses":{"$ref":"#/components/schemas/registrar-api_registry_statuses"},"supported_tld":{"$ref":"#/components/schemas/registrar-api_supported_tld"},"transfer_in":{"$ref":"#/components/schemas/registrar-api_transfer_in"},"updated_at":{"$ref":"#/components/schemas/registrar-api_updated_at"}},"type":"object"},"registrar-api_domain_response_collection":{"allOf":[{"$ref":"#/components/schemas/registrar-api_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/registrar-api_domains"},"type":"array"}}}]},"registrar-api_domain_response_single":{"allOf":[{"$ref":"#/components/schemas/registrar-api_api-response-single"},{"properties":{"result":{"type":"object"}}}]},"registrar-api_domain_update_properties":{"properties":{"auto_renew":{"$ref":"#/components/schemas/registrar-api_auto_renew"},"locked":{"$ref":"#/components/schemas/registrar-api_locked"},"privacy":{"$ref":"#/components/schemas/registrar-api_privacy"}},"type":"object"},"registrar-api_domains":{"allOf":[{"$ref":"#/components/schemas/registrar-api_domain_properties"}],"type":"object"},"registrar-api_email":{"description":"The contact email address of the user.","example":"user@example.com","maxLength":90,"type":"string"},"registrar-api_expires_at":{"description":"Shows when domain name registration expires.","example":"2019-08-28T23:59:59Z","format":"date-time","type":"string"},"registrar-api_fax":{"description":"Contact fax number.","example":"123-867-5309","type":"string"},"registrar-api_first_name":{"description":"User's first name","example":"John","maxLength":60,"nullable":true,"type":"string"},"registrar-api_identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"registrar-api_last_name":{"description":"User's last name","example":"Appleseed","maxLength":60,"nullable":true,"type":"string"},"registrar-api_locked":{"description":"Shows whether a registrar lock is in place for a domain.","example":false,"type":"boolean","x-auditable":true},"registrar-api_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"registrar-api_organization":{"description":"Name of organization.","example":"Cloudflare, Inc.","type":"string"},"registrar-api_privacy":{"description":"Privacy option controls redacting WHOIS information.","example":true,"type":"boolean","x-auditable":true},"registrar-api_registrant_contact":{"allOf":[{"$ref":"#/components/schemas/registrar-api_contacts"}],"description":"Shows contact information for domain registrant."},"registrar-api_registry_statuses":{"description":"A comma-separated list of registry status codes. A full list of status codes can be found at [EPP Status Codes](https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en).","example":"ok,serverTransferProhibited","type":"string"},"registrar-api_result_info":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters","example":2000,"type":"number"}},"type":"object"},"registrar-api_state":{"description":"State.","example":"TX","type":"string"},"registrar-api_supported_tld":{"description":"Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to [TLD Policies](https://www.cloudflare.com/tld-policies/) for a list of supported TLDs.","example":true,"type":"boolean"},"registrar-api_telephone":{"description":"User's telephone number","example":"+1 123-123-1234","maxLength":20,"nullable":true,"type":"string"},"registrar-api_transfer_in":{"description":"Statuses for domain transfers into Cloudflare Registrar.","properties":{"accept_foa":{"description":"Form of authorization has been accepted by the registrant.","enum":["needed","ok"],"example":"needed","type":"string"},"approve_transfer":{"description":"Shows transfer status with the registry.","enum":["needed","ok","pending","trying","rejected","unknown"],"example":"unknown","type":"string"},"can_cancel_transfer":{"description":"Indicates if cancellation is still possible.","example":true,"type":"boolean"},"disable_privacy":{"description":"Privacy guards are disabled at the foreign registrar.","enum":["needed","ok","unknown"],"example":"ok","type":"string"},"enter_auth_code":{"description":"Auth code has been entered and verified.","enum":["needed","ok","pending","trying","rejected"],"example":"needed","type":"string"},"unlock_domain":{"description":"Domain is unlocked at the foreign registrar.","enum":["needed","ok","pending","trying","unknown"],"example":"ok","type":"string"}}},"registrar-api_updated_at":{"description":"Last updated.","example":"2018-08-28T17:26:26Z","format":"date-time","type":"string"},"registrar-api_zipcode":{"description":"The zipcode or postal code where the user lives.","example":"12345","maxLength":20,"nullable":true,"type":"string"},"request-tracer_account_identifier":{"$ref":"#/components/schemas/request-tracer_identifier"},"request-tracer_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/request-tracer_messages"},"messages":{"$ref":"#/components/schemas/request-tracer_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"request-tracer_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/request-tracer_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/request-tracer_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"request-tracer_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"request-tracer_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"request-tracer_trace":{"items":{"description":"List of steps acting on request/response","properties":{"action":{"description":"If step type is rule, then action performed by this rule","example":"execute","pattern":"^[a-z_]+$","type":"string","x-auditable":true},"action_parameters":{"description":"If step type is rule, then action parameters of this rule as JSON","example":{"id":"4814384a9e5d4991b9815dcfc25d2f1f"},"type":"object","x-auditable":true},"description":{"description":"If step type is rule or ruleset, the description of this entity","example":"some rule","type":"string","x-auditable":true},"expression":{"description":"If step type is rule, then expression used to match for this rule","example":"ip.src ne 1.1.1.1","type":"string","x-auditable":true},"kind":{"description":"If step type is ruleset, then kind of this ruleset","example":"zone","type":"string","x-auditable":true},"matched":{"description":"Whether tracing step affected tracing request/response","example":true,"type":"boolean","x-auditable":true},"name":{"description":"If step type is ruleset, then name of this ruleset","example":"some ruleset name","type":"string","x-auditable":true},"step_name":{"description":"Tracing step identifying name","example":"rule_id01","type":"string","x-auditable":true},"trace":{"$ref":"#/components/schemas/request-tracer_trace"},"type":{"description":"Tracing step type","example":"rule","type":"string","x-auditable":true}},"type":"object"},"type":"array"},"resource-sharing_account_id":{"description":"Account identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"resource-sharing_account_name":{"description":"The display name of an account.","example":"Account A","type":"string","x-auditable":true},"resource-sharing_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common"},{"properties":{"result":{"items":{},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/resource-sharing_result_info"}}}],"type":"object"},"resource-sharing_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/resource-sharing_v4errors"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful.","example":true,"type":"boolean"}},"required":["success","errors"],"type":"object"},"resource-sharing_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_v4errors"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","example":false,"type":"boolean","x-auditable":true}},"required":["success","errors","result"],"type":"object"},"resource-sharing_create_share_recipient_request":{"description":"Account or organization ID must be provided.","properties":{"account_id":{"$ref":"#/components/schemas/resource-sharing_account_id"},"organization_id":{"$ref":"#/components/schemas/resource-sharing_organization_id"}},"type":"object"},"resource-sharing_create_share_request":{"properties":{"name":{"$ref":"#/components/schemas/resource-sharing_share_name"},"recipients":{"items":{"$ref":"#/components/schemas/resource-sharing_create_share_recipient_request"},"type":"array"},"resources":{"items":{"$ref":"#/components/schemas/resource-sharing_create_share_resource_request"},"type":"array"}},"required":["name","resources","recipients"],"type":"object"},"resource-sharing_create_share_resource_request":{"properties":{"meta":{"$ref":"#/components/schemas/resource-sharing_resource_meta"},"resource_account_id":{"$ref":"#/components/schemas/resource-sharing_account_id"},"resource_id":{"$ref":"#/components/schemas/resource-sharing_resource_resource_id"},"resource_type":{"$ref":"#/components/schemas/resource-sharing_resource_type"}},"required":["resource_id","resource_type","resource_account_id","meta"],"type":"object"},"resource-sharing_created":{"description":"When the share was created.","example":"2023-09-21T18:56:32.624632Z","format":"date-time","type":"string","x-auditable":true},"resource-sharing_modified":{"description":"When the share was modified.","example":"2023-09-21T18:56:32.624632Z","format":"date-time","type":"string","x-auditable":true},"resource-sharing_organization_id":{"description":"Organization identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"resource-sharing_recipient_association_status":{"description":"Share Recipient association status.","enum":["associating","associated","disassociating","disassociated"],"type":"string","x-auditable":true},"resource-sharing_recipient_id":{"description":"Share Recipient identifier tag.","example":"3fd85f74b32742f1bff64a85009dda07","maxLength":32,"type":"string","x-auditable":true},"resource-sharing_recipient_resource_error":{"description":"Share Recipient error message.","example":"Recipient is missing necessary entitlement","type":"string","x-auditable":true},"resource-sharing_recipient_resource_error_terminal":{"description":"Whether the error is terminal or will be continually retried.","example":true,"type":"boolean","x-auditable":true},"resource-sharing_resource_id":{"description":"Share Resource identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"resource-sharing_resource_meta":{"description":"Resource Metadata.","type":"object"},"resource-sharing_resource_resource_id":{"description":"Share Resource identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"resource-sharing_resource_status":{"description":"Resource Status.","enum":["active","deleting","deleted"],"type":"string","x-auditable":true},"resource-sharing_resource_type":{"description":"Resource Type.","enum":["custom-ruleset","widget","gateway-policy","gateway-destination-ip","gateway-block-page-settings","gateway-extended-email-matching"],"type":"string","x-auditable":true},"resource-sharing_resource_version":{"description":"Resource Version.","type":"integer","x-auditable":true},"resource-sharing_result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"},"total_pages":{"description":"Total number of pages using the given per page.","example":50,"type":"number"}},"type":"object"},"resource-sharing_share_id":{"description":"Share identifier tag.","example":"3fd85f74b32742f1bff64a85009dda07","maxLength":32,"type":"string","x-auditable":true},"resource-sharing_share_kind":{"enum":["sent","received"],"type":"string","x-auditable":true},"resource-sharing_share_name":{"description":"The name of the share.","example":"My Shared WAF Managed Rule","type":"string","x-auditable":true},"resource-sharing_share_object":{"properties":{"account_id":{"$ref":"#/components/schemas/resource-sharing_account_id"},"account_name":{"$ref":"#/components/schemas/resource-sharing_account_name"},"associated_recipient_count":{"description":"The number of recipients in the 'associated' state. This field is only included when requested via the 'include_recipient_counts' parameter.","example":10,"type":"integer"},"associating_recipient_count":{"description":"The number of recipients in the 'associating' state. This field is only included when requested via the 'include_recipient_counts' parameter.","example":1,"type":"integer"},"created":{"$ref":"#/components/schemas/resource-sharing_created"},"disassociated_recipient_count":{"description":"The number of recipients in the 'disassociated' state. This field is only included when requested via the 'include_recipient_counts' parameter.","example":0,"type":"integer"},"disassociating_recipient_count":{"description":"The number of recipients in the 'disassociating' state. This field is only included when requested via the 'include_recipient_counts' parameter.","example":0,"type":"integer"},"id":{"$ref":"#/components/schemas/resource-sharing_share_id"},"kind":{"$ref":"#/components/schemas/resource-sharing_share_kind"},"modified":{"$ref":"#/components/schemas/resource-sharing_modified"},"name":{"$ref":"#/components/schemas/resource-sharing_share_name"},"organization_id":{"$ref":"#/components/schemas/resource-sharing_organization_id"},"resources":{"description":"A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.","items":{"$ref":"#/components/schemas/resource-sharing_share_resource_object"},"type":"array"},"status":{"$ref":"#/components/schemas/resource-sharing_share_status"},"target_type":{"$ref":"#/components/schemas/resource-sharing_share_target_type"}},"required":["id","name","account_id","account_name","organization_id","created","modified","status","target_type"]},"resource-sharing_share_recipient_object":{"properties":{"account_id":{"$ref":"#/components/schemas/resource-sharing_account_id"},"association_status":{"$ref":"#/components/schemas/resource-sharing_recipient_association_status"},"created":{"$ref":"#/components/schemas/resource-sharing_created"},"id":{"$ref":"#/components/schemas/resource-sharing_recipient_id"},"modified":{"$ref":"#/components/schemas/resource-sharing_modified"},"resources":{"items":{"$ref":"#/components/schemas/resource-sharing_share_recipient_resource_object"},"type":"array"}},"required":["id","account_id","association_status","created","modified"]},"resource-sharing_share_recipient_resource_object":{"properties":{"error":{"$ref":"#/components/schemas/resource-sharing_recipient_resource_error"},"resource_id":{"$ref":"#/components/schemas/resource-sharing_resource_resource_id"},"resource_version":{"$ref":"#/components/schemas/resource-sharing_resource_version"},"terminal":{"$ref":"#/components/schemas/resource-sharing_recipient_resource_error_terminal"}},"required":["error","terminal","resource_id","resource_version"]},"resource-sharing_share_recipient_response_collection":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/resource-sharing_share_recipient_object"},"type":"array"}}}],"type":"object"},"resource-sharing_share_recipient_response_single":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/resource-sharing_share_recipient_object"}}}],"type":"object"},"resource-sharing_share_resource_object":{"properties":{"created":{"$ref":"#/components/schemas/resource-sharing_created"},"id":{"$ref":"#/components/schemas/resource-sharing_resource_id"},"meta":{"$ref":"#/components/schemas/resource-sharing_resource_meta"},"modified":{"$ref":"#/components/schemas/resource-sharing_modified"},"resource_account_id":{"$ref":"#/components/schemas/resource-sharing_account_id"},"resource_id":{"$ref":"#/components/schemas/resource-sharing_resource_resource_id"},"resource_type":{"$ref":"#/components/schemas/resource-sharing_resource_type"},"resource_version":{"$ref":"#/components/schemas/resource-sharing_resource_version"},"status":{"$ref":"#/components/schemas/resource-sharing_resource_status"}},"required":["id","resource_id","resource_type","resource_account_id","meta","status","created","modified","resource_version"]},"resource-sharing_share_resource_response_collection":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/resource-sharing_share_resource_object"},"type":"array"}}}],"type":"object"},"resource-sharing_share_resource_response_single":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/resource-sharing_share_resource_object"}}}],"type":"object"},"resource-sharing_share_response_collection":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/resource-sharing_share_object"},"type":"array"}}}],"type":"object"},"resource-sharing_share_response_single":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/resource-sharing_share_object"}}}],"type":"object"},"resource-sharing_share_status":{"enum":["active","deleting","deleted"],"type":"string","x-auditable":true},"resource-sharing_share_target_type":{"enum":["account","organization"],"type":"string","x-auditable":true},"resource-sharing_update_share_recipients_request":{"items":{"$ref":"#/components/schemas/resource-sharing_create_share_recipient_request"},"type":"array"},"resource-sharing_update_share_request":{"properties":{"name":{"$ref":"#/components/schemas/resource-sharing_share_name"}},"required":["name"],"type":"object"},"resource-sharing_update_share_resource_request":{"properties":{"meta":{"$ref":"#/components/schemas/resource-sharing_resource_meta"}},"required":["meta"],"type":"object"},"resource-sharing_v4error":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"resource-sharing_v4errors":{"example":[],"items":{"$ref":"#/components/schemas/resource-sharing_v4error"},"type":"array"},"rulesets_AccountId":{"description":"The unique ID of the account.","example":"abf9b32d38c5f572afde3336ec0ce302","pattern":"^[0-9a-f]{32}$","title":"Account ID","type":"string"},"rulesets_BlockRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["block"]},"action_parameters":{"properties":{"response":{"description":"The response to show when the block is applied.","properties":{"content":{"description":"The content to return.","example":"{\n  \"success\": false,\n  \"error\": \"you have been blocked\"\n}","minLength":1,"title":"Content","type":"string"},"content_type":{"description":"The type of the content to return.","example":"application/json","minLength":1,"title":"Content Type","type":"string"},"status_code":{"description":"The status code to return.","maximum":499,"minimum":400,"title":"Status Code","type":"integer"}},"required":["status_code","content","content_type"],"title":"Response","type":"object"}}},"description":{"example":"Block the request."}},"title":"Block Rule"}]},"rulesets_ChallengeRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["challenge"]},"description":{"example":"Issue an Interactive Challenge if the visitor has not solved an Interactive Challenge prior to the request."}},"title":"Challenge Rule"}]},"rulesets_CompressResponseRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["compress_response"]},"action_parameters":{"properties":{"algorithms":{"description":"Custom order for compression algorithms.","items":{"description":"Compression algorithm to enable.","properties":{"name":{"description":"Name of the compression algorithm to enable.","enum":["none","auto","default","gzip","brotli","zstd"],"example":"none","title":"Algorithm Name","type":"string"}},"title":"Algorithm","type":"object"},"minItems":1,"title":"Algorithms","type":"array","uniqueItems":true}},"required":["algorithms"]},"description":{"example":"Modify the compression algorithm used in the response."}},"title":"Response Compression Rule"}]},"rulesets_Cursor":{"description":"The cursor to use for the next page.","example":"dGhpc2lzYW5leGFtcGxlCg","minLength":1,"title":"Cursor","type":"string"},"rulesets_DDoSDynamicRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["ddos_dynamic"]},"description":{"example":"Perform a specific action according to a set of internal guidelines defined by Cloudflare."}},"title":"DDoS Dynamic Rule"}]},"rulesets_Errors":{"description":"A list of error messages.","items":{"$ref":"#/components/schemas/rulesets_Message"},"title":"Errors","type":"array","uniqueItems":true},"rulesets_ExecuteCategoryOverrides":{"description":"A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.","items":{"description":"A category-level override.","minProperties":2,"properties":{"action":{"allOf":[{"$ref":"#/components/schemas/rulesets_RuleAction"},{"description":"The action to override rules in the category with.","example":"log"}]},"category":{"allOf":[{"$ref":"#/components/schemas/rulesets_RuleCategory"},{"description":"The name of the category to override."}]},"enabled":{"allOf":[{"$ref":"#/components/schemas/rulesets_RuleEnabled"},{"description":"Whether to enable execution of rules in the category."}]},"sensitivity_level":{"allOf":[{"$ref":"#/components/schemas/rulesets_ExecuteSensitivityLevel"},{"description":"The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases."}]}},"required":["category"],"title":"Category Override","type":"object"},"minItems":1,"title":"Category Overrides","type":"array","uniqueItems":true},"rulesets_ExecuteMatchedData":{"description":"The configuration to use for matched data logging.","properties":{"public_key":{"description":"The public key to encrypt matched data logs with.","example":"iGqBmyIUxuWt1rvxoAharN9FUXneUBxA/Y19PyyrEG0=","minLength":1,"title":"Public Key","type":"string"}},"required":["public_key"],"title":"Matched Data","type":"object"},"rulesets_ExecuteOverrides":{"description":"A set of overrides to apply to the target ruleset.","minProperties":1,"properties":{"action":{"allOf":[{"$ref":"#/components/schemas/rulesets_RuleAction"},{"description":"An action to override all rules with. This option has lower precedence than rule and category overrides.","example":"log"}]},"categories":{"$ref":"#/components/schemas/rulesets_ExecuteCategoryOverrides"},"enabled":{"allOf":[{"$ref":"#/components/schemas/rulesets_RuleEnabled"},{"description":"Whether to enable execution of all rules. This option has lower precedence than rule and category overrides."}]},"rules":{"$ref":"#/components/schemas/rulesets_ExecuteRuleOverrides"},"sensitivity_level":{"allOf":[{"$ref":"#/components/schemas/rulesets_ExecuteSensitivityLevel"},{"description":"A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases."}]}},"title":"Overrides","type":"object"},"rulesets_ExecuteRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["execute"]},"action_parameters":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/rulesets_RulesetId"},{"description":"The ID of the ruleset to execute.","example":"4814384a9e5d4991b9815dcfc25d2f1f"}]},"matched_data":{"$ref":"#/components/schemas/rulesets_ExecuteMatchedData"},"overrides":{"$ref":"#/components/schemas/rulesets_ExecuteOverrides"}},"required":["id"]},"description":{"example":"Execute another ruleset."}},"title":"Execute Rule"}]},"rulesets_ExecuteRuleOverrides":{"description":"A list of rule-level overrides. This option has the highest precedence.","items":{"description":"A rule-level override.","minProperties":2,"properties":{"action":{"allOf":[{"$ref":"#/components/schemas/rulesets_RuleAction"},{"description":"The action to override the rule with.","example":"log"}]},"enabled":{"allOf":[{"$ref":"#/components/schemas/rulesets_RuleEnabled"},{"description":"Whether to enable execution of the rule."}]},"id":{"allOf":[{"$ref":"#/components/schemas/rulesets_RuleId"},{"description":"The ID of the rule to override.","example":"8ac8bc2a661e475d940980f9317f28e1"}]},"score_threshold":{"description":"The score threshold to use for the rule.","title":"Score Threshold","type":"integer"},"sensitivity_level":{"allOf":[{"$ref":"#/components/schemas/rulesets_ExecuteSensitivityLevel"},{"description":"The sensitivity level to use for the rule. This option is only applicable for DDoS phases."}]}},"required":["id"],"title":"Rule Override","type":"object"},"minItems":1,"title":"Rule Overrides","type":"array","uniqueItems":true},"rulesets_ExecuteSensitivityLevel":{"enum":["default","medium","low","eoff"],"example":"default","title":"Sensitivity Level","type":"string"},"rulesets_ForceConnectionCloseRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["force_connection_close"]},"description":{"example":"Close ongoing HTTP connections. This action does not block a request, but it forces the client to reconnect. For HTTP/2 and HTTP/3 connections, the connection will be closed even if it breaks other requests running on the same connection."}},"title":"Force Connection Close Rule"}]},"rulesets_JsChallengeRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["js_challenge"]},"description":{"example":"Issue a non-interactive JavaScript Challenge if the visitor has not solved an Interactive Challenge, Managed Challenge, or JavaScript Challenge prior to the request."}},"title":"JavaScript Challenge Rule"}]},"rulesets_LogCustomFieldCookieFields":{"description":"The cookie fields to log.","items":{"description":"The cookie field to log.","properties":{"name":{"description":"The name of the cookie.","example":"myCookie","minLength":1,"title":"Cookie Name","type":"string"}},"required":["name"],"title":"Cookie Field","type":"object"},"minItems":1,"title":"Cookie Fields","type":"array"},"rulesets_LogCustomFieldRawResponseFields":{"description":"The raw response fields to log.","items":{"description":"The raw response field to log.","properties":{"name":{"description":"The name of the response header.","example":"my-response-header","minLength":1,"title":"Header Name","type":"string"},"preserve_duplicates":{"default":false,"description":"Whether to log duplicate values of the same header.","example":true,"title":"Preserve Duplicates","type":"boolean"}},"required":["name"],"title":"Raw Response Field","type":"object"},"minItems":1,"title":"Raw Response Fields","type":"array"},"rulesets_LogCustomFieldRequestFields":{"description":"The raw request fields to log.","items":{"description":"The raw request field to log.","properties":{"name":{"description":"The name of the header.","example":"my-request-header","minLength":1,"title":"Header Name","type":"string"}},"required":["name"],"title":"Raw Request Field","type":"object"},"minItems":1,"title":"Raw Request Fields","type":"array"},"rulesets_LogCustomFieldResponseFields":{"description":"The transformed response fields to log.","items":{"description":"The transformed response field to log.","properties":{"name":{"description":"The name of the response header.","example":"my-response-header","minLength":1,"title":"Header Name","type":"string"},"preserve_duplicates":{"default":false,"description":"Whether to log duplicate values of the same header.","example":true,"title":"Preserve Duplicates","type":"boolean"}},"required":["name"],"title":"Transformed Response Field","type":"object"},"minItems":1,"title":"Transformed Response Fields","type":"array"},"rulesets_LogCustomFieldRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["log_custom_field"]},"action_parameters":{"minProperties":1,"properties":{"cookie_fields":{"$ref":"#/components/schemas/rulesets_LogCustomFieldCookieFields"},"raw_response_fields":{"$ref":"#/components/schemas/rulesets_LogCustomFieldRawResponseFields"},"request_fields":{"$ref":"#/components/schemas/rulesets_LogCustomFieldRequestFields"},"response_fields":{"$ref":"#/components/schemas/rulesets_LogCustomFieldResponseFields"},"transformed_request_fields":{"$ref":"#/components/schemas/rulesets_LogCustomFieldTransformedRequestFields"}}},"description":{"example":"Log additional custom fields."}},"title":"Log Custom Field Rule"}]},"rulesets_LogCustomFieldTransformedRequestFields":{"description":"The transformed request fields to log.","items":{"description":"The transformed request field to log.","properties":{"name":{"description":"The name of the header.","example":"my-request-header","minLength":1,"title":"Header Name","type":"string"}},"required":["name"],"title":"Transformed Request Field","type":"object"},"minItems":1,"title":"Transformed Request Fields","type":"array"},"rulesets_LogRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["log"]},"description":{"example":"Log the request."}},"title":"Log Rule"}]},"rulesets_ManagedChallengeRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["managed_challenge"]},"description":{"example":"Issue a Managed Challenge if the visitor has not solved a Managed Challenge or Interactive Challenge prior to the request."}},"title":"Managed Challenge Rule"}]},"rulesets_ManagedTransform":{"description":"A Managed Transform object.","properties":{"conflicts_with":{"description":"The Managed Transforms that this Managed Transform conflicts with.","items":{"allOf":[{"$ref":"#/components/schemas/rulesets_ManagedTransformId"},{"example":"add_true_client_ip_headers"}]},"minItems":1,"readOnly":true,"title":"Conflicts With","type":"array","uniqueItems":true,"x-stainless-skip":["terraform"]},"enabled":{"description":"Whether the Managed Transform is enabled.","example":true,"title":"Enabled","type":"boolean"},"has_conflict":{"description":"Whether the Managed Transform conflicts with the currently-enabled Managed Transforms.","example":false,"readOnly":true,"title":"Has Conflict","type":"boolean","x-stainless-skip":["terraform"]},"id":{"$ref":"#/components/schemas/rulesets_ManagedTransformId"}},"required":["id","enabled","has_conflict"],"title":"Managed Transform","type":"object"},"rulesets_ManagedTransformId":{"description":"The human-readable identifier of the Managed Transform.","minLength":1,"title":"Transform ID","type":"string"},"rulesets_ManagedTransforms":{"description":"A Managed Transforms object.","properties":{"managed_request_headers":{"description":"The list of Managed Request Transforms.","items":{"allOf":[{"$ref":"#/components/schemas/rulesets_ManagedTransform"},{"properties":{"id":{"example":"add_bot_protection_headers"}}}]},"title":"Managed Request Transforms","type":"array","uniqueItems":true},"managed_response_headers":{"description":"The list of Managed Response Transforms.","items":{"allOf":[{"$ref":"#/components/schemas/rulesets_ManagedTransform"},{"properties":{"id":{"example":"add_security_headers"}}}]},"title":"Managed Response Transforms","type":"array","uniqueItems":true}},"required":["managed_request_headers","managed_response_headers"],"title":"Managed Transforms","type":"object"},"rulesets_Message":{"description":"A message.","properties":{"code":{"description":"A unique code for this message.","example":10000,"title":"Code","type":"integer"},"message":{"description":"A text description of this message.","example":"something bad happened","minLength":1,"title":"Description","type":"string"},"source":{"description":"The source of this message.","properties":{"pointer":{"description":"A JSON pointer to the field that is the source of the message.","example":"/rules/0/action","minLength":1,"title":"Pointer","type":"string"}},"required":["pointer"],"title":"Source","type":"object"}},"required":["message"],"title":"Message","type":"object"},"rulesets_Messages":{"description":"A list of warning messages.","items":{"$ref":"#/components/schemas/rulesets_Message"},"title":"Messages","type":"array","uniqueItems":true},"rulesets_PerPage":{"description":"The number of rulesets to return per page.","example":3,"maximum":50,"minimum":1,"title":"Per Page","type":"integer"},"rulesets_RedirectFromList":{"description":"A redirect based on a bulk list lookup.","properties":{"key":{"description":"An expression that evaluates to the list lookup key.","example":"http.request.full_uri","minLength":1,"title":"Lookup Key","type":"string"},"name":{"description":"The name of the list to match against.","example":"my_list","pattern":"^[a-zA-Z0-9_]+$","title":"List Name","type":"string"}},"required":["name","key"],"title":"Bulk Redirect","type":"object"},"rulesets_RedirectFromValue":{"description":"A redirect based on the request properties.","properties":{"preserve_query_string":{"default":false,"description":"Whether to keep the query string of the original request.","example":true,"title":"Preserve Query String","type":"boolean"},"status_code":{"description":"The status code to use for the redirect.","enum":[301,302,303,307,308],"example":302,"title":"Status Code","type":"integer"},"target_url":{"description":"A URL to redirect the request to.","maxProperties":1,"minProperties":1,"properties":{"expression":{"description":"An expression that evaluates to a URL to redirect the request to.","example":"concat(\"https://example.com\", http.request.uri.path)","minLength":1,"title":"Redirect Expression","type":"string"},"value":{"description":"A URL to redirect the request to.","example":"https://example.com","minLength":1,"title":"Redirect Value","type":"string"}},"title":"Target URL","type":"object"}},"required":["target_url"],"title":"Single Redirect","type":"object"},"rulesets_RedirectRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["redirect"]},"action_parameters":{"maxProperties":1,"minProperties":1,"properties":{"from_list":{"$ref":"#/components/schemas/rulesets_RedirectFromList"},"from_value":{"$ref":"#/components/schemas/rulesets_RedirectFromValue"}}},"description":{"example":"Redirect the request."}},"title":"Redirect Rule"}]},"rulesets_RequestRule":{"discriminator":{"mapping":{"block":"#/components/schemas/rulesets_BlockRule","challenge":"#/components/schemas/rulesets_ChallengeRule","compress_response":"#/components/schemas/rulesets_CompressResponseRule","ddos_dynamic":"#/components/schemas/rulesets_DDoSDynamicRule","execute":"#/components/schemas/rulesets_ExecuteRule","force_connection_close":"#/components/schemas/rulesets_ForceConnectionCloseRule","js_challenge":"#/components/schemas/rulesets_JsChallengeRule","log":"#/components/schemas/rulesets_LogRule","log_custom_field":"#/components/schemas/rulesets_LogCustomFieldRule","managed_challenge":"#/components/schemas/rulesets_ManagedChallengeRule","redirect":"#/components/schemas/rulesets_RedirectRule","rewrite":"#/components/schemas/rulesets_RewriteRule","route":"#/components/schemas/rulesets_RouteRule","score":"#/components/schemas/rulesets_ScoreRule","serve_error":"#/components/schemas/rulesets_ServeErrorRule","set_cache_settings":"#/components/schemas/rulesets_SetCacheSettingsRule","set_config":"#/components/schemas/rulesets_SetConfigRule","skip":"#/components/schemas/rulesets_SkipRule"},"propertyName":"action"},"oneOf":[{"$ref":"#/components/schemas/rulesets_BlockRule"},{"$ref":"#/components/schemas/rulesets_ChallengeRule"},{"$ref":"#/components/schemas/rulesets_CompressResponseRule"},{"$ref":"#/components/schemas/rulesets_DDoSDynamicRule"},{"$ref":"#/components/schemas/rulesets_ExecuteRule"},{"$ref":"#/components/schemas/rulesets_ForceConnectionCloseRule"},{"$ref":"#/components/schemas/rulesets_JsChallengeRule"},{"$ref":"#/components/schemas/rulesets_LogRule"},{"$ref":"#/components/schemas/rulesets_LogCustomFieldRule"},{"$ref":"#/components/schemas/rulesets_ManagedChallengeRule"},{"$ref":"#/components/schemas/rulesets_RedirectRule"},{"$ref":"#/components/schemas/rulesets_RewriteRule"},{"$ref":"#/components/schemas/rulesets_RouteRule"},{"$ref":"#/components/schemas/rulesets_ScoreRule"},{"$ref":"#/components/schemas/rulesets_ServeErrorRule"},{"$ref":"#/components/schemas/rulesets_SetCacheSettingsRule"},{"$ref":"#/components/schemas/rulesets_SetConfigRule"},{"$ref":"#/components/schemas/rulesets_SkipRule"}]},"rulesets_RequestRules":{"default":[],"description":"The list of rules in the ruleset.","items":{"$ref":"#/components/schemas/rulesets_RequestRule"},"title":"Rules","type":"array"},"rulesets_Response":{"description":"A response object.","properties":{"errors":{"$ref":"#/components/schemas/rulesets_Errors"},"messages":{"$ref":"#/components/schemas/rulesets_Messages"},"result":{"description":"A result.","title":"Result"},"success":{"description":"Whether the API call was successful.","title":"Success","type":"boolean"}},"required":["result","success","errors","messages"],"title":"Response","type":"object"},"rulesets_ResponseRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_RequestRule"},{"required":["id","expression","action","ref","enabled"]}]},"rulesets_ResponseRules":{"description":"The list of rules in the ruleset.","items":{"$ref":"#/components/schemas/rulesets_ResponseRule"},"title":"Rules","type":"array"},"rulesets_ResultInfo":{"description":"Information to navigate the results.","properties":{"cursors":{"description":"The set of cursors.","properties":{"after":{"allOf":[{"$ref":"#/components/schemas/rulesets_Cursor"},{"title":"After Cursor"}]}},"required":["after"],"title":"Cursors","type":"object"}},"title":"Result Info","type":"object"},"rulesets_RewriteHeaderExpression":{"description":"An expression that evaluates to a value for the header.","example":"ip.src","minLength":1,"title":"Header Expression","type":"string"},"rulesets_RewriteHeaderOperation":{"description":"The operation to perform on the header.","title":"Operation","type":"string"},"rulesets_RewriteHeaderValue":{"description":"A static value for the header.","example":"my-header-value","minLength":1,"title":"Header Value","type":"string"},"rulesets_RewriteHeaders":{"additionalProperties":{"oneOf":[{"description":"A header with a static value to add.","properties":{"operation":{"allOf":[{"$ref":"#/components/schemas/rulesets_RewriteHeaderOperation"},{"enum":["add"]}]},"value":{"$ref":"#/components/schemas/rulesets_RewriteHeaderValue"}},"required":["operation","value"],"title":"Add Static Header","type":"object"},{"description":"A header with a dynamic value to add.","properties":{"expression":{"$ref":"#/components/schemas/rulesets_RewriteHeaderExpression"},"operation":{"allOf":[{"$ref":"#/components/schemas/rulesets_RewriteHeaderOperation"},{"enum":["add"]}]}},"required":["operation","expression"],"title":"Add Dynamic Header","type":"object"},{"description":"A header with a static value to set.","properties":{"operation":{"allOf":[{"$ref":"#/components/schemas/rulesets_RewriteHeaderOperation"},{"enum":["set"]}]},"value":{"$ref":"#/components/schemas/rulesets_RewriteHeaderValue"}},"required":["operation","value"],"title":"Set Static Header","type":"object"},{"description":"A header with a dynamic value to set.","properties":{"expression":{"$ref":"#/components/schemas/rulesets_RewriteHeaderExpression"},"operation":{"allOf":[{"$ref":"#/components/schemas/rulesets_RewriteHeaderOperation"},{"enum":["set"]}]}},"required":["operation","expression"],"title":"Set Dynamic Header","type":"object"},{"description":"A header to remove.","properties":{"operation":{"allOf":[{"$ref":"#/components/schemas/rulesets_RewriteHeaderOperation"},{"enum":["remove"]}]}},"required":["operation"],"title":"Remove Header","type":"object"}]},"description":"A map of headers to rewrite.","example":{"client-http-version":{"expression":"http.request.version","operation":"set"}},"minProperties":1,"title":"Headers","type":"object"},"rulesets_RewriteRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["rewrite"]},"action_parameters":{"minProperties":1,"properties":{"headers":{"$ref":"#/components/schemas/rulesets_RewriteHeaders"},"uri":{"$ref":"#/components/schemas/rulesets_RewriteUri"}}},"description":{"example":"Rewrite properties of the request or response."}},"title":"Rewrite Rule"}]},"rulesets_RewriteUri":{"allOf":[{"anyOf":[{"description":"A URI path rewrite.","properties":{"path":{"$ref":"#/components/schemas/rulesets_RewriteUriPath"}},"required":["path"],"title":"URI Path"},{"description":"A URI query rewrite.","properties":{"query":{"$ref":"#/components/schemas/rulesets_RewriteUriQuery"}},"required":["query"],"title":"URI Query"}]},{"properties":{"origin":{"description":"Whether to propagate the rewritten URI to origin.","example":false,"readOnly":true,"title":"Origin","type":"boolean"}},"type":"object"}]},"rulesets_RewriteUriPath":{"description":"A URI path rewrite.","maxProperties":1,"minProperties":1,"properties":{"expression":{"description":"An expression that evaluates to a value to rewrite the URI path to.","example":"regex_replace(http.request.uri.path, \"/foo$\", \"/bar\")","minLength":1,"title":"Path Expression","type":"string"},"value":{"description":"A value to rewrite the URI path to.","example":"/foo","minLength":1,"title":"Path Value","type":"string"}},"title":"URI Path","type":"object"},"rulesets_RewriteUriQuery":{"description":"A URI query rewrite.","maxProperties":1,"minProperties":1,"properties":{"expression":{"description":"An expression that evaluates to a value to rewrite the URI query to.","example":"regex_replace(http.request.uri.query, \"foo=bar\", \"\")","minLength":1,"title":"Query Expression","type":"string"},"value":{"description":"A value to rewrite the URI query to.","example":"foo=bar","title":"Query Value","type":"string"}},"title":"URI Query","type":"object"},"rulesets_RouteHostHeader":{"description":"A value to rewrite the HTTP host header to.","example":"static.example.com","minLength":1,"title":"Host Header","type":"string"},"rulesets_RouteOrigin":{"description":"An origin to route to.","minProperties":1,"properties":{"host":{"description":"A resolved host to route to.","example":"static.example.com","minLength":1,"title":"Host","type":"string"},"port":{"description":"A destination port to route to.","example":80,"maximum":65535,"minimum":1,"title":"Port","type":"integer"}},"title":"Origin","type":"object"},"rulesets_RouteRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["route"]},"action_parameters":{"minProperties":1,"properties":{"host_header":{"$ref":"#/components/schemas/rulesets_RouteHostHeader"},"origin":{"$ref":"#/components/schemas/rulesets_RouteOrigin"},"sni":{"$ref":"#/components/schemas/rulesets_RouteSNI"}}},"description":{"example":"Select an origin server to route the request to."}},"title":"Route Rule"}]},"rulesets_RouteSNI":{"description":"A Server Name Indication (SNI) override.","properties":{"value":{"description":"A value to override the SNI to.","example":"static.example.com","minLength":1,"title":"Value","type":"string"}},"required":["value"],"title":"Server Name Indication","type":"object"},"rulesets_Rule":{"properties":{"action":{"$ref":"#/components/schemas/rulesets_RuleAction"},"action_parameters":{"default":{},"description":"The parameters configuring the rule's action.","title":"Action Parameters","type":"object"},"categories":{"$ref":"#/components/schemas/rulesets_RuleCategories"},"description":{"default":"","description":"An informative description of the rule.","title":"Description","type":"string"},"enabled":{"allOf":[{"$ref":"#/components/schemas/rulesets_RuleEnabled"},{"default":true}]},"exposed_credential_check":{"$ref":"#/components/schemas/rulesets_RuleExposedCredentialCheck"},"expression":{"description":"The expression defining which traffic will match the rule.","example":"ip.src eq 1.1.1.1","minLength":1,"title":"Expression","type":"string"},"id":{"$ref":"#/components/schemas/rulesets_RuleId"},"last_updated":{"description":"The timestamp of when the rule was last modified.","example":"2000-01-01T00:00:00.000000Z","format":"date-time","readOnly":true,"title":"Last Updated","type":"string","x-stainless-skip":["terraform"]},"logging":{"$ref":"#/components/schemas/rulesets_RuleLogging"},"ratelimit":{"$ref":"#/components/schemas/rulesets_RuleRatelimit"},"ref":{"description":"The reference of the rule (the rule's ID by default).","example":"my_ref","minLength":1,"title":"Ref","type":"string"},"version":{"description":"The version of the rule.","example":"1","pattern":"^[0-9]+$","readOnly":true,"title":"Version","type":"string","x-stainless-skip":["terraform"]}},"required":["version","last_updated"],"title":"Rule","type":"object"},"rulesets_RuleAction":{"description":"The action to perform when the rule matches.","pattern":"^[a-z_]+$","title":"Action","type":"string"},"rulesets_RuleCategories":{"description":"The categories of the rule.","items":{"$ref":"#/components/schemas/rulesets_RuleCategory"},"minItems":1,"readOnly":true,"title":"Categories","type":"array","uniqueItems":true},"rulesets_RuleCategory":{"description":"The category of a rule.","example":"directory-traversal","minLength":1,"title":"Category","type":"string"},"rulesets_RuleEnabled":{"description":"Whether the rule should be executed.","example":true,"title":"Enabled","type":"boolean"},"rulesets_RuleExposedCredentialCheck":{"description":"Configuration for exposed credential checking.","properties":{"password_expression":{"description":"An expression that selects the password used in the credentials check.","example":"url_decode(http.request.body.form[\\\"password\\\"][0])","minLength":1,"title":"Password Expression","type":"string"},"username_expression":{"description":"An expression that selects the user ID used in the credentials check.","example":"url_decode(http.request.body.form[\\\"username\\\"][0])","minLength":1,"title":"Username Expression","type":"string"}},"required":["username_expression","password_expression"],"title":"Exposed Credential Check","type":"object"},"rulesets_RuleId":{"description":"The unique ID of the rule.","example":"3a03d665bac047339bb530ecb439a90d","pattern":"^[0-9a-f]{32}$","title":"Rule ID","type":"string"},"rulesets_RuleLogging":{"description":"An object configuring the rule's logging behavior.","properties":{"enabled":{"description":"Whether to generate a log when the rule matches.","example":true,"title":"Enabled","type":"boolean"}},"required":["enabled"],"title":"Logging","type":"object"},"rulesets_RulePosition":{"description":"An object configuring where the rule will be placed.","title":"Position","type":"object"},"rulesets_RuleRatelimit":{"description":"An object configuring the rule's rate limit behavior.","properties":{"characteristics":{"description":"Characteristics of the request on which the rate limit counter will be incremented.","items":{"description":"The characteristic of the request.","example":"cf.colo.id","minLength":1,"title":"Characteristic","type":"string"},"minItems":1,"title":"Characteristics","type":"array","uniqueItems":true},"counting_expression":{"description":"An expression that defines when the rate limit counter should be incremented. It defaults to the same as the rule's expression.","example":"http.request.body.raw eq \"abcd\"","minLength":1,"title":"Counting Expression","type":"string"},"mitigation_timeout":{"description":"Period of time in seconds after which the action will be disabled following its first execution.","example":600,"title":"Mitigation Timeout","type":"integer"},"period":{"description":"Period in seconds over which the counter is being incremented.","example":60,"minimum":0,"title":"Period","type":"integer"},"requests_per_period":{"description":"The threshold of requests per period after which the action will be executed for the first time.","example":1000,"minimum":1,"title":"Requests per Period","type":"integer"},"requests_to_origin":{"default":false,"description":"Whether counting is only performed when an origin is reached.","example":true,"title":"Requests to Origin","type":"boolean"},"score_per_period":{"description":"The score threshold per period for which the action will be executed the first time.","example":400,"title":"Score per Period","type":"integer"},"score_response_header_name":{"description":"A response header name provided by the origin, which contains the score to increment rate limit counter with.","example":"my-score","minLength":1,"title":"Score Response Header Name","type":"string"}},"required":["characteristics","period"],"title":"Rate Limit","type":"object"},"rulesets_Ruleset":{"description":"A ruleset object.","properties":{"description":{"default":"","description":"An informative description of the ruleset.","example":"A description for my ruleset.","title":"Description","type":"string"},"id":{"allOf":[{"$ref":"#/components/schemas/rulesets_RulesetId"},{"readOnly":true}]},"last_updated":{"description":"The timestamp of when the ruleset was last modified.","example":"2000-01-01T00:00:00.000000Z","format":"date-time","readOnly":true,"title":"Last Updated","type":"string"},"name":{"description":"The human-readable name of the ruleset.","example":"My ruleset","minLength":1,"title":"Name","type":"string"},"version":{"allOf":[{"$ref":"#/components/schemas/rulesets_RulesetVersion"},{"readOnly":true}]}},"required":["id","version","last_updated"],"title":"Ruleset","type":"object"},"rulesets_RulesetId":{"description":"The unique ID of the ruleset.","example":"2f2feab2026849078ba485f918791bdc","pattern":"^[0-9a-f]{32}$","title":"Ruleset ID","type":"string"},"rulesets_RulesetKind":{"description":"The kind of the ruleset.","enum":["managed","custom","root","zone"],"example":"root","title":"Kind","type":"string"},"rulesets_RulesetPhase":{"description":"The phase of the ruleset.","enum":["ddos_l4","ddos_l7","http_config_settings","http_custom_errors","http_log_custom_fields","http_ratelimit","http_request_cache_settings","http_request_dynamic_redirect","http_request_firewall_custom","http_request_firewall_managed","http_request_late_transform","http_request_origin","http_request_redirect","http_request_sanitize","http_request_sbfm","http_request_transform","http_response_compression","http_response_firewall_managed","http_response_headers_transform","magic_transit","magic_transit_ids_managed","magic_transit_managed","magic_transit_ratelimit"],"example":"http_request_firewall_custom","title":"Phase","type":"string"},"rulesets_RulesetVersion":{"description":"The version of the ruleset.","example":"1","pattern":"^[0-9]+$","title":"Version","type":"string"},"rulesets_ScoreIncrement":{"description":"A delta to change the score by, which can be either positive or negative.","example":3,"title":"Increment","type":"integer"},"rulesets_ScoreRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["score"]},"action_parameters":{"properties":{"increment":{"$ref":"#/components/schemas/rulesets_ScoreIncrement"}},"required":["increment"]},"description":{"example":"Increment the cumulative score."}},"title":"Score Rule"}]},"rulesets_ServeErrorAssetName":{"description":"The name of a custom asset to serve as the error response.","example":"500_errors","minLength":1,"title":"Asset Name","type":"string"},"rulesets_ServeErrorContent":{"description":"The response content.","example":"{\n  \"error\": \"1xxx error occurred\"\n}","minLength":1,"title":"Content","type":"string"},"rulesets_ServeErrorContentType":{"description":"The content type header to set with the error response.","enum":["application/json","text/html","text/plain","text/xml"],"example":"application/json","title":"Content Type","type":"string"},"rulesets_ServeErrorRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["serve_error"]},"action_parameters":{"allOf":[{"properties":{"content_type":{"$ref":"#/components/schemas/rulesets_ServeErrorContentType"},"status_code":{"$ref":"#/components/schemas/rulesets_ServeErrorStatusCode"}},"required":["content_type"]},{"oneOf":[{"properties":{"content":{"$ref":"#/components/schemas/rulesets_ServeErrorContent"}},"required":["content"],"title":"Action Parameters (Content)"},{"properties":{"asset_name":{"$ref":"#/components/schemas/rulesets_ServeErrorAssetName"}},"required":["asset_name"],"title":"Action Parameters (Asset)"}]}]},"description":{"example":"Customize the serving of errors."}},"title":"Serve Error Rule"}]},"rulesets_ServeErrorStatusCode":{"description":"The status code to use for the error.","example":500,"maximum":999,"minimum":400,"title":"Status Code","type":"integer"},"rulesets_SetCacheSettingsAdditionalCacheablePorts":{"description":"A list of additional ports that caching should be enabled on.","items":{"description":"A port to enable caching on.","example":8080,"maximum":65535,"minimum":1,"title":"Additional Cacheable Port","type":"integer"},"minItems":1,"title":"Additional Cacheable Ports (Enterprise-Only)","type":"array","uniqueItems":true},"rulesets_SetCacheSettingsBrowserTTL":{"description":"How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.","properties":{"default":{"description":"The browser TTL (in seconds) if you choose the \"override_origin\" mode.","example":60,"minimum":0,"title":"Default TTL","type":"integer"},"mode":{"description":"The browser TTL mode.","enum":["respect_origin","bypass_by_default","override_origin","bypass"],"example":"override_origin","title":"TTL Mode","type":"string"}},"required":["mode"],"title":"Browser TTL","type":"object"},"rulesets_SetCacheSettingsCache":{"description":"Whether the request's response from the origin is eligible for caching. Caching itself will still depend on the cache control header and your other caching configurations.","example":true,"title":"Cache","type":"boolean"},"rulesets_SetCacheSettingsCacheKey":{"description":"Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.","properties":{"cache_by_device_type":{"description":"Whether to separate cached content based on the visitor's device type.","example":true,"title":"Cache by Device Type","type":"boolean"},"cache_deception_armor":{"description":"Whether to protect from web cache deception attacks, while allowing static assets to be cached.","example":true,"title":"Cache Deception Armor","type":"boolean"},"custom_key":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsCustomCacheKey"},"ignore_query_strings_order":{"description":"Whether to treat requests with the same query parameters the same, regardless of the order those query parameters are in.","example":true,"title":"Ignore Query Strings Order","type":"boolean"}},"title":"Cache Key","type":"object"},"rulesets_SetCacheSettingsCacheReserve":{"description":"Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).","properties":{"eligible":{"description":"Whether Cache Reserve is enabled. If this is true and a request meets eligibility criteria, Cloudflare will write the resource to Cache Reserve.","example":true,"title":"Eligible","type":"boolean"},"minimum_file_size":{"description":"The minimum file size eligible for storage in Cache Reserve.","example":1024,"minimum":0,"title":"Minimum File Size","type":"integer"}},"required":["eligible"],"title":"Cache Reserve","type":"object"},"rulesets_SetCacheSettingsCustomCacheKey":{"description":"Which components of the request are included or excluded from the cache key.","properties":{"cookie":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsCustomCacheKeyCookie"},"header":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsCustomCacheKeyHeader"},"host":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsCustomCacheKeyHost"},"query_string":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsCustomCacheKeyQueryString"},"user":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsCustomCacheKeyUser"}},"title":"Custom Cache Key","type":"object"},"rulesets_SetCacheSettingsCustomCacheKeyCookie":{"description":"Which cookies to include in the cache key.","properties":{"check_presence":{"description":"A list of cookies to check for the presence of. The presence of these cookies is included in the cache key.","items":{"description":"The name of the cookie to check for the presence of.","example":"myCookie","minLength":1,"title":"Cookie Name","type":"string"},"minItems":1,"title":"Check Presence","type":"array","uniqueItems":true},"include":{"description":"A list of cookies to include in the cache key.","items":{"description":"The name of the cookie to include.","example":"myCookie","minLength":1,"title":"Cookie Name","type":"string"},"minItems":1,"title":"Include","type":"array","uniqueItems":true}},"title":"Cookies","type":"object"},"rulesets_SetCacheSettingsCustomCacheKeyHeader":{"description":"Which headers to include in the cache key.","properties":{"check_presence":{"description":"A list of headers to check for the presence of. The presence of these headers is included in the cache key.","items":{"description":"The name of the header to check for the presence of.","example":"my-header","minLength":1,"title":"Header","type":"string"},"minItems":1,"title":"Check Presence","type":"array","uniqueItems":true},"contains":{"additionalProperties":{"description":"A list of values to match the header against.","items":{"description":"The header value to match against.","example":"my-header-value","minLength":1,"title":"Header Value","type":"string"},"minItems":1,"title":"Header Values","type":"array","uniqueItems":true},"description":"A mapping of header names to a list of values. If a header is present in the request and contains any of the values provided, its value is included in the cache key.","example":{"my-header":["my-header-value-1","my-header-value-2"]},"minProperties":1,"title":"Contains","type":"object"},"exclude_origin":{"description":"Whether to exclude the origin header in the cache key.","example":true,"title":"Exclude Origin","type":"boolean"},"include":{"description":"A list of headers to include in the cache key.","items":{"description":"The name of the header to include.","example":"my-header","minLength":1,"title":"Header","type":"string"},"minItems":1,"title":"Include","type":"array","uniqueItems":true}},"title":"Headers","type":"object"},"rulesets_SetCacheSettingsCustomCacheKeyHost":{"description":"How to use the host in the cache key.","properties":{"resolved":{"description":"Whether to use the resolved host in the cache key.","example":true,"title":"Use Resolved Host","type":"boolean"}},"title":"Host","type":"object"},"rulesets_SetCacheSettingsCustomCacheKeyQueryString":{"description":"Which query string parameters to include in or exclude from the cache key.","maxProperties":1,"properties":{"exclude":{"description":"Which query string parameters to exclude from the cache key.","maxProperties":1,"minProperties":1,"properties":{"all":{"description":"Whether to exclude all query string parameters from the cache key.","enum":[true],"title":"Exclude All","type":"boolean"},"list":{"description":"A list of query string parameters to exclude from the cache key.","items":{"description":"The name of the query string parameter to exclude.","example":"foo","minLength":1,"title":"Parameter Name","type":"string"},"minItems":1,"title":"Exclude List","type":"array","uniqueItems":true}},"title":"Exclude","type":"object"},"include":{"description":"Which query string parameters to include in the cache key.","maxProperties":1,"minProperties":1,"properties":{"all":{"description":"Whether to include all query string parameters in the cache key.","enum":[true],"title":"Include All","type":"boolean"},"list":{"description":"A list of query string parameters to include in the cache key.","items":{"description":"The name of the query string parameter to include.","example":"foo","minLength":1,"title":"Parameter Name","type":"string"},"minItems":1,"title":"Include List","type":"array","uniqueItems":true}},"title":"Include","type":"object"}},"title":"Query String Parameters","type":"object"},"rulesets_SetCacheSettingsCustomCacheKeyUser":{"description":"How to use characteristics of the request user agent in the cache key.","properties":{"device_type":{"description":"Whether to use the user agent's device type in the cache key.","example":true,"title":"Device Type","type":"boolean"},"geo":{"description":"Whether to use the user agents's country in the cache key.","example":true,"title":"Country","type":"boolean"},"lang":{"description":"Whether to use the user agent's language in the cache key.","example":true,"title":"Language","type":"boolean"}},"title":"User","type":"object"},"rulesets_SetCacheSettingsEdgeTTL":{"description":"How long the Cloudflare edge network should cache the response.","properties":{"default":{"description":"The edge TTL (in seconds) if you choose the \"override_origin\" mode.","example":60,"minimum":0,"title":"Default TTL","type":"integer"},"mode":{"description":"The edge TTL mode.","enum":["respect_origin","bypass_by_default","override_origin"],"example":"override_origin","title":"TTL Mode","type":"string"},"status_code_ttl":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsStatusCodeTTL"}},"required":["mode"],"title":"Edge TTL","type":"object"},"rulesets_SetCacheSettingsOriginCacheControl":{"description":"Whether Cloudflare will aim to strictly adhere to RFC 7234.","example":true,"title":"Origin Cache Control (Enterprise-Only)","type":"boolean"},"rulesets_SetCacheSettingsOriginErrorPagePassthru":{"description":"Whether to generate Cloudflare error pages for issues from the origin server.","example":true,"title":"Origin Error Page Passthrough","type":"boolean"},"rulesets_SetCacheSettingsReadTimeout":{"description":"A timeout value between two successive read operations to use for your origin server. Historically, the timeout value between two read options from Cloudflare to an origin server is 100 seconds. If you are attempting to reduce HTTP 524 errors because of timeouts from an origin server, try increasing this timeout value.","example":900,"maximum":6000,"minimum":100,"title":"Read Timeout (Enterprise-Only)","type":"integer"},"rulesets_SetCacheSettingsRespectStrongEtags":{"description":"Whether Cloudflare should respect strong ETag (entity tag) headers. If false, Cloudflare converts strong ETag headers to weak ETag headers.","example":true,"title":"Respect Strong ETags","type":"boolean"},"rulesets_SetCacheSettingsRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["set_cache_settings"]},"action_parameters":{"minProperties":1,"properties":{"additional_cacheable_ports":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsAdditionalCacheablePorts"},"browser_ttl":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsBrowserTTL"},"cache":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsCache"},"cache_key":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsCacheKey"},"cache_reserve":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsCacheReserve"},"edge_ttl":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsEdgeTTL"},"origin_cache_control":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsOriginCacheControl"},"origin_error_page_passthru":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsOriginErrorPagePassthru"},"read_timeout":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsReadTimeout"},"respect_strong_etags":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsRespectStrongEtags"},"serve_stale":{"$ref":"#/components/schemas/rulesets_SetCacheSettingsServeStale"}}},"description":{"example":"Configure settings for how the response is cached."}},"title":"Set Cache Settings Rule"}]},"rulesets_SetCacheSettingsServeStale":{"description":"When to serve stale content from cache.","properties":{"disable_stale_while_updating":{"description":"Whether Cloudflare should disable serving stale content while getting the latest content from the origin.","example":true,"title":"Disable Stale While Updating","type":"boolean"}},"title":"Serve Stale","type":"object"},"rulesets_SetCacheSettingsStatusCodeTTL":{"description":"A list of TTLs to apply to specific status codes or status code ranges.","items":{"maxProperties":2,"minProperties":2,"properties":{"status_code":{"description":"A single status code to apply the TTL to.","example":200,"maximum":999,"minimum":100,"title":"Status Code","type":"integer"},"status_code_range":{"description":"A range of status codes to apply the TTL to.","minProperties":1,"properties":{"from":{"description":"The lower bound of the range.","example":200,"maximum":999,"minimum":100,"title":"From","type":"integer"},"to":{"description":"The upper bound of the range.","example":299,"maximum":999,"minimum":100,"title":"To","type":"integer"}},"title":"Status Code Range","type":"object"},"value":{"description":"The time to cache the response for (in seconds). A value of 0 is equivalent to setting the cache control header with the value \"no-cache\". A value of -1 is equivalent to setting the cache control header with the value of \"no-store\".","example":0,"title":"TTL Value","type":"integer"}},"required":["value"],"type":"object"},"minItems":1,"title":"Status Code TTLs","type":"array","uniqueItems":true},"rulesets_SetConfigAutominify":{"description":"Which file extensions to minify automatically.","properties":{"css":{"default":false,"description":"Whether to minify CSS files.","example":true,"title":"CSS","type":"boolean"},"html":{"default":false,"description":"Whether to minify HTML files.","example":true,"title":"HTML","type":"boolean"},"js":{"default":false,"description":"Whether to minify JavaScript files.","example":true,"title":"JavaScript","type":"boolean"}},"title":"Auto-Minify","type":"object"},"rulesets_SetConfigRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["set_config"]},"action_parameters":{"minProperties":1,"properties":{"automatic_https_rewrites":{"description":"Whether to enable Automatic HTTPS Rewrites.","example":true,"title":"Automatic HTTPS Rewrites","type":"boolean"},"autominify":{"$ref":"#/components/schemas/rulesets_SetConfigAutominify"},"bic":{"description":"Whether to enable Browser Integrity Check (BIC).","example":true,"title":"Browser Integrity Check","type":"boolean"},"disable_apps":{"deprecated":true,"description":"Whether to disable Cloudflare Apps.","enum":[true],"title":"Disable Apps","type":"boolean","x-stainless-deprecation-message":"Cloudflare Apps are deprected."},"disable_pay_per_crawl":{"description":"Whether to disable Pay Per Crawl.","enum":[true],"title":"Disable Pay Per Crawl","type":"boolean"},"disable_rum":{"description":"Whether to disable Real User Monitoring (RUM).","enum":[true],"title":"Disable RUM","type":"boolean"},"disable_zaraz":{"description":"Whether to disable Zaraz.","enum":[true],"title":"Disable Zaraz","type":"boolean"},"email_obfuscation":{"description":"Whether to enable Email Obfuscation.","example":true,"title":"Email Obfuscation","type":"boolean"},"fonts":{"description":"Whether to enable Cloudflare Fonts.","example":true,"title":"Cloudflare Fonts","type":"boolean"},"hotlink_protection":{"description":"Whether to enable Hotlink Protection.","example":true,"title":"Hotlink Protection","type":"boolean"},"mirage":{"deprecated":true,"description":"Whether to enable Mirage.","example":true,"title":"Mirage","type":"boolean","x-stainless-deprecation-message":"Mirage is deprecated. More information at https://developers.cloudflare.com/speed/optimization/images/mirage/."},"opportunistic_encryption":{"description":"Whether to enable Opportunistic Encryption.","example":true,"title":"Opportunistic Encryption","type":"boolean"},"polish":{"description":"The Polish level to configure.","enum":["off","lossless","lossy","webp"],"example":"off","title":"Polish","type":"string"},"rocket_loader":{"description":"Whether to enable Rocket Loader.","example":true,"title":"Rocket Loader","type":"boolean"},"security_level":{"description":"The Security Level to configure.","enum":["off","essentially_off","low","medium","high","under_attack"],"example":"off","title":"Security Level","type":"string"},"server_side_excludes":{"description":"Whether to enable Server-Side Excludes.","example":true,"title":"Server-Side Excludes","type":"boolean"},"ssl":{"description":"The SSL level to configure.","enum":["off","flexible","full","strict","origin_pull"],"example":"off","title":"SSL","type":"string"},"sxg":{"description":"Whether to enable Signed Exchanges (SXG).","example":true,"title":"Signed Exchanges","type":"boolean"}}},"description":{"example":"Configure settings for the request and response."}},"title":"Set Configuration Rule"}]},"rulesets_SkipPhase":{"description":"A phase to skip the execution of. This option is only compatible with the products option.","enum":["current"],"title":"Phase","type":"string"},"rulesets_SkipPhases":{"description":"A list of phases to skip the execution of. This option is incompatible with the rulesets option.","items":{"allOf":[{"$ref":"#/components/schemas/rulesets_RulesetPhase"},{"description":"The phase to skip the execution of."}]},"minItems":1,"title":"Phases","type":"array","uniqueItems":true},"rulesets_SkipProducts":{"description":"A list of legacy security products to skip the execution of.","items":{"description":"The name of a legacy security product to skip the execution of.","enum":["bic","hot","rateLimit","securityLevel","uaBlock","waf","zoneLockdown"],"example":"bic","title":"Product","type":"string"},"minItems":1,"title":"Products","type":"array","uniqueItems":true},"rulesets_SkipRule":{"allOf":[{"$ref":"#/components/schemas/rulesets_Rule"},{"properties":{"action":{"enum":["skip"]},"action_parameters":{"minProperties":1,"properties":{"phase":{"$ref":"#/components/schemas/rulesets_SkipPhase"},"phases":{"$ref":"#/components/schemas/rulesets_SkipPhases"},"products":{"$ref":"#/components/schemas/rulesets_SkipProducts"},"rules":{"$ref":"#/components/schemas/rulesets_SkipRules"},"ruleset":{"$ref":"#/components/schemas/rulesets_SkipRuleset"},"rulesets":{"$ref":"#/components/schemas/rulesets_SkipRulesets"}}},"description":{"example":"Skip executing rulesets, rules, phases, and other products."}},"title":"Skip Rule"}]},"rulesets_SkipRules":{"additionalProperties":{"description":"A list of rule IDs in the ruleset to skip the execution of.","items":{"allOf":[{"$ref":"#/components/schemas/rulesets_RuleId"},{"description":"The ID of a rule in the ruleset to skip the execution of.","example":"8ac8bc2a661e475d940980f9317f28e1","title":"Rule"}]},"minItems":1,"title":"Rules","type":"array","uniqueItems":true},"description":"A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option.","example":{"4814384a9e5d4991b9815dcfc25d2f1f":["8ac8bc2a661e475d940980f9317f28e1"]},"minProperties":1,"title":"Rules","type":"object"},"rulesets_SkipRuleset":{"description":"A ruleset to skip the execution of. This option is incompatible with the rulesets option.","enum":["current"],"title":"Ruleset","type":"string"},"rulesets_SkipRulesets":{"description":"A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.","items":{"allOf":[{"$ref":"#/components/schemas/rulesets_RulesetId"},{"description":"The ID of a ruleset to skip the execution of.","example":"4814384a9e5d4991b9815dcfc25d2f1f","title":"Ruleset"}]},"minItems":1,"title":"Rulesets","type":"array","uniqueItems":true},"rulesets_UrlNormalization":{"description":"A URL Normalization object.","properties":{"scope":{"description":"The scope of the URL normalization.","enum":["incoming","both","none"],"example":"incoming","title":"Scope","type":"string"},"type":{"description":"The type of URL normalization performed by Cloudflare.","enum":["cloudflare","rfc3986"],"example":"cloudflare","title":"Type","type":"string"}},"required":["type","scope"],"title":"URL Normalization","type":"object"},"rulesets_ZoneId":{"description":"The unique ID of the zone.","example":"9f1839b6152d298aca64c4e906b6d074","pattern":"^[0-9a-f]{32}$","title":"Zone ID","type":"string"},"rum_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/rum_messages"},"messages":{"$ref":"#/components/schemas/rum_messages"},"success":{"description":"Whether the API call was successful.","example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"rum_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/rum_schemas-messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/rum_schemas-messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"rum_auto_install":{"description":"If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.","example":true,"type":"boolean","x-auditable":true},"rum_create-rule-request":{"properties":{"host":{"example":"example.com","type":"string"},"inclusive":{"description":"Whether the rule includes or excludes traffic from being measured.","example":true,"type":"boolean"},"is_paused":{"description":"Whether the rule is paused or not.","example":false,"type":"boolean"},"paths":{"example":["*"],"items":{"type":"string"},"type":"array"}},"type":"object"},"rum_create-site-request":{"properties":{"auto_install":{"$ref":"#/components/schemas/rum_auto_install"},"host":{"$ref":"#/components/schemas/rum_host"},"zone_tag":{"$ref":"#/components/schemas/rum_zone_tag"}},"type":"object"},"rum_created":{"$ref":"#/components/schemas/rum_timestamp"},"rum_editable":{"example":true,"type":"boolean"},"rum_enabled":{"description":"Enables or disables RUM. This option can be used only when auto_install is set to true.","example":true,"type":"boolean","x-auditable":true},"rum_host":{"description":"The hostname to use for gray-clouded sites.","example":"example.com","type":"string","x-auditable":true},"rum_id":{"example":"rum","type":"string","x-auditable":true},"rum_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"rum_is_host_regex":{"description":"Whether to match the hostname using a regular expression.","example":false,"type":"boolean","x-auditable":true},"rum_lite":{"description":"If enabled, the JavaScript snippet will not be injected for visitors from the EU.","type":"boolean","x-auditable":true},"rum_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"rum_modify-rules-request":{"properties":{"delete_rules":{"description":"A list of rule identifiers to delete.","items":{"$ref":"#/components/schemas/rum_rule_identifier"},"type":"array"},"rules":{"description":"A list of rules to create or update.","items":{"properties":{"host":{"example":"example.com","type":"string"},"id":{"$ref":"#/components/schemas/rum_rule_identifier"},"inclusive":{"example":true,"type":"boolean"},"is_paused":{"example":false,"type":"boolean"},"paths":{"example":["*"],"items":{"type":"string"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"rum_order_by":{"description":"The property used to sort the list of results.","enum":["host","created"],"example":"host","type":"string"},"rum_page":{"description":"Current page within the paginated list of results.","example":1,"type":"number"},"rum_per_page":{"description":"Number of items to return per page of results.","example":10,"type":"number"},"rum_result_info":{"properties":{"count":{"description":"The total number of items on the current page.","example":10,"type":"integer"},"page":{"description":"Current page within the paginated list of results.","example":1,"type":"integer"},"per_page":{"description":"The maximum number of items to return per page of results.","example":10,"type":"integer"},"total_count":{"description":"The total number of items.","example":25,"type":"integer"},"total_pages":{"description":"The total number of pages.","example":3,"nullable":true,"type":"integer"}},"type":"object"},"rum_rule":{"properties":{"created":{"$ref":"#/components/schemas/rum_timestamp"},"host":{"description":"The hostname the rule will be applied to.","example":"example.com","type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/rum_rule_identifier"},"inclusive":{"description":"Whether the rule includes or excludes traffic from being measured.","example":true,"type":"boolean","x-auditable":true},"is_paused":{"description":"Whether the rule is paused or not.","example":false,"type":"boolean","x-auditable":true},"paths":{"description":"The paths the rule will be applied to.","example":["*"],"items":{"type":"string","x-auditable":true},"type":"array"},"priority":{"example":1000,"type":"number","x-auditable":true}},"type":"object"},"rum_rule-id-response-single":{"allOf":[{"$ref":"#/components/schemas/rum_api-response-common"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/rum_rule_identifier"}},"type":"object"}},"type":"object"}]},"rum_rule-response-single":{"allOf":[{"$ref":"#/components/schemas/rum_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/rum_rule"}},"type":"object"}]},"rum_rule_identifier":{"description":"The Web Analytics rule identifier.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","type":"string","x-auditable":true},"rum_rules":{"description":"A list of rules.","items":{"$ref":"#/components/schemas/rum_rule"},"type":"array"},"rum_rules-response-collection":{"allOf":[{"$ref":"#/components/schemas/rum_api-response-common"},{"properties":{"result":{"properties":{"rules":{"$ref":"#/components/schemas/rum_rules"},"ruleset":{"$ref":"#/components/schemas/rum_ruleset"}},"type":"object"}},"type":"object"}]},"rum_ruleset":{"properties":{"enabled":{"description":"Whether the ruleset is enabled.","example":true,"type":"boolean"},"id":{"$ref":"#/components/schemas/rum_ruleset_identifier"},"zone_name":{"example":"example.com","type":"string"},"zone_tag":{"$ref":"#/components/schemas/rum_zone_tag"}},"type":"object"},"rum_ruleset_identifier":{"description":"The Web Analytics ruleset identifier.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","type":"string","x-auditable":true},"rum_rum-site-response-single":{"allOf":[{"$ref":"#/components/schemas/rum_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/rum_rum_site"}},"type":"object"}]},"rum_rum_site":{"properties":{"editable":{"$ref":"#/components/schemas/rum_editable"},"id":{"$ref":"#/components/schemas/rum_id"},"value":{"$ref":"#/components/schemas/rum_value"}},"type":"object"},"rum_schemas-messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"rum_site":{"properties":{"auto_install":{"$ref":"#/components/schemas/rum_auto_install"},"created":{"$ref":"#/components/schemas/rum_timestamp"},"rules":{"$ref":"#/components/schemas/rum_rules"},"ruleset":{"$ref":"#/components/schemas/rum_ruleset"},"site_tag":{"$ref":"#/components/schemas/rum_site_tag"},"site_token":{"$ref":"#/components/schemas/rum_site_token"},"snippet":{"$ref":"#/components/schemas/rum_snippet"}},"type":"object"},"rum_site-response-single":{"allOf":[{"$ref":"#/components/schemas/rum_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/rum_site"}},"type":"object"}]},"rum_site-tag-response-single":{"allOf":[{"$ref":"#/components/schemas/rum_api-response-common"},{"properties":{"result":{"properties":{"site_tag":{"$ref":"#/components/schemas/rum_site_tag"}},"type":"object"}},"type":"object"}]},"rum_site_tag":{"description":"The Web Analytics site identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true},"rum_site_token":{"description":"The Web Analytics site token.","example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true},"rum_sites-response-collection":{"allOf":[{"$ref":"#/components/schemas/rum_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/rum_site"},"type":"array"},"result_info":{"$ref":"#/components/schemas/rum_result_info"}},"type":"object"}]},"rum_snippet":{"description":"Encoded JavaScript snippet.","example":"\u003c!-- Cloudflare Web Analytics --\u003e\u003cscript defer src='https://static.cloudflareinsights.com/beacon.min.js' data-cf-beacon='{\"token\": \"bc40a2d1b5834453aba85c1b9a3054da\"}'\u003e\u003c/script\u003e\u003c!-- End Cloudflare Web Analytics --\u003e","type":"string","x-auditable":true},"rum_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"rum_toggle-rum-request":{"properties":{"value":{"description":"Value can either be On or Off.","example":"on","type":"string"}},"type":"object"},"rum_update-site-request":{"properties":{"auto_install":{"$ref":"#/components/schemas/rum_auto_install"},"enabled":{"$ref":"#/components/schemas/rum_enabled"},"host":{"$ref":"#/components/schemas/rum_host"},"lite":{"$ref":"#/components/schemas/rum_lite"},"zone_tag":{"$ref":"#/components/schemas/rum_zone_tag"}},"type":"object"},"rum_value":{"description":"Current state of RUM. Returns On, Off, or Manual.","example":"on","type":"string","x-auditable":true},"rum_zone_tag":{"description":"The zone identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true},"secondary-dns_account_identifier":{"example":"01a7362d577a6c3019a474fd6f485823","readOnly":true,"type":"string","x-auditable":true},"secondary-dns_acl":{"properties":{"id":{"$ref":"#/components/schemas/secondary-dns_components-schemas-identifier"},"ip_range":{"$ref":"#/components/schemas/secondary-dns_ip_range"},"name":{"$ref":"#/components/schemas/secondary-dns_acl_components-schemas-name"}},"required":["id","name","ip_range"],"type":"object"},"secondary-dns_acl_components-schemas-name":{"description":"The name of the acl.","example":"my-acl-1","type":"string","x-auditable":true},"secondary-dns_algo":{"description":"TSIG algorithm.","example":"hmac-sha512.","type":"string","x-auditable":true},"secondary-dns_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"secondary-dns_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/secondary-dns_messages"},"messages":{"$ref":"#/components/schemas/secondary-dns_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"secondary-dns_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"secondary-dns_api-response-single":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-common"}],"type":"object"},"secondary-dns_auto_refresh_seconds":{"default":86400,"description":"How often should a secondary zone auto refresh regardless of DNS NOTIFY.\nNot applicable for primary zones.","example":86400,"minimum":300,"type":"number","x-auditable":true},"secondary-dns_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/secondary-dns_components-schemas-identifier"}},"type":"object"}},"type":"object"}],"type":"object"},"secondary-dns_components-schemas-identifier":{"example":"23ff594956f20c2a721606e94745a8aa","readOnly":true,"type":"string","x-auditable":true},"secondary-dns_components-schemas-name":{"description":"The name of the peer.","example":"my-peer-1","type":"string","x-auditable":true},"secondary-dns_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/secondary-dns_acl"},"type":"array"}},"type":"object"}],"type":"object"},"secondary-dns_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/secondary-dns_acl"}},"type":"object"}],"type":"object"},"secondary-dns_disable_transfer_response":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/secondary-dns_disable_transfer_result"}},"type":"object"}],"type":"object"},"secondary-dns_disable_transfer_result":{"description":"The zone transfer status of a primary zone.","example":"Disabled","type":"string","x-auditable":true},"secondary-dns_dns-secondary-secondary-zone":{"properties":{"auto_refresh_seconds":{"$ref":"#/components/schemas/secondary-dns_auto_refresh_seconds"},"id":{"$ref":"#/components/schemas/secondary-dns_identifier"},"name":{"$ref":"#/components/schemas/secondary-dns_name"},"peers":{"$ref":"#/components/schemas/secondary-dns_peers"}},"required":["id","name","peers","auto_refresh_seconds"],"type":"object"},"secondary-dns_enable_transfer_response":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/secondary-dns_enable_transfer_result"}},"type":"object"}],"type":"object"},"secondary-dns_enable_transfer_result":{"description":"The zone transfer status of a primary zone.","example":"Enabled","type":"string","x-auditable":true},"secondary-dns_force_response":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/secondary-dns_force_result"}},"type":"object"}],"type":"object"},"secondary-dns_force_result":{"description":"When force_axfr query parameter is set to true, the response is a simple string.","example":"OK","type":"string","x-auditable":true},"secondary-dns_id_response":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/secondary-dns_identifier"}},"type":"object"}},"type":"object"}],"type":"object"},"secondary-dns_identifier":{"example":"269d8f4853475ca241c4e730be286b20","readOnly":true,"type":"string","x-auditable":true},"secondary-dns_ip":{"description":"IPv4/IPv6 address of primary or secondary nameserver, depending on what zone this peer is linked to. For primary zones this IP defines the IP of the secondary nameserver Cloudflare will NOTIFY upon zone changes. For secondary zones this IP defines the IP of the primary nameserver Cloudflare will send AXFR/IXFR requests to.","example":"192.0.2.53","type":"string","x-auditable":true},"secondary-dns_ip_range":{"description":"Allowed IPv4/IPv6 address range of primary or secondary nameservers. This will be applied for the entire account. The IP range is used to allow additional NOTIFY IPs for secondary zones and IPs Cloudflare allows AXFR/IXFR requests from for primary zones. CIDRs are limited to a maximum of /24 for IPv4 and /64 for IPv6 respectively.","example":"192.0.2.53/28","type":"string","x-auditable":true},"secondary-dns_ixfr_enable":{"description":"Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones.","example":false,"type":"boolean","x-auditable":true},"secondary-dns_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"secondary-dns_name":{"description":"Zone name.","example":"www.example.com.","type":"string","x-auditable":true},"secondary-dns_peer":{"properties":{"id":{"$ref":"#/components/schemas/secondary-dns_components-schemas-identifier"},"ip":{"$ref":"#/components/schemas/secondary-dns_ip"},"ixfr_enable":{"$ref":"#/components/schemas/secondary-dns_ixfr_enable"},"name":{"$ref":"#/components/schemas/secondary-dns_components-schemas-name"},"port":{"$ref":"#/components/schemas/secondary-dns_port"},"tsig_id":{"$ref":"#/components/schemas/secondary-dns_tsig_id"}},"required":["id","name"],"type":"object"},"secondary-dns_peers":{"description":"A list of peer tags.","example":["23ff594956f20c2a721606e94745a8aa","00920f38ce07c2e2f4df50b1f61d4194"],"items":{"$ref":"#/components/schemas/secondary-dns_identifier"},"type":"array","x-stainless-collection-type":"set"},"secondary-dns_port":{"description":"DNS port of primary or secondary nameserver, depending on what zone this peer is linked to.","example":53,"type":"number","x-auditable":true},"secondary-dns_response_collection":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/secondary-dns_tsig"},"type":"array"}},"type":"object"}],"type":"object"},"secondary-dns_schemas-force_response":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/secondary-dns_schemas-force_result"}},"type":"object"}],"type":"object"},"secondary-dns_schemas-force_result":{"description":"When force_notify query parameter is set to true, the response is a simple string.","example":"OK","type":"string","x-auditable":true},"secondary-dns_schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/secondary-dns_schemas-identifier"}},"type":"object"}},"type":"object"}],"type":"object"},"secondary-dns_schemas-identifier":{"example":"69cd1e104af3e6ed3cb344f263fd0d5a","readOnly":true,"type":"string","x-auditable":true},"secondary-dns_schemas-name":{"description":"TSIG key name.","example":"tsig.customer.cf.","type":"string","x-auditable":true},"secondary-dns_schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/secondary-dns_peer"},"type":"array"}},"type":"object"}],"type":"object"},"secondary-dns_schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/secondary-dns_peer"}},"type":"object"}],"type":"object"},"secondary-dns_secret":{"description":"TSIG secret.","example":"caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c","type":"string","x-sensitive":true},"secondary-dns_single_request_outgoing":{"properties":{"id":{"$ref":"#/components/schemas/secondary-dns_identifier"},"name":{"$ref":"#/components/schemas/secondary-dns_name"},"peers":{"$ref":"#/components/schemas/secondary-dns_peers"}},"required":["id","name","peers"]},"secondary-dns_single_response":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/secondary-dns_tsig"}},"type":"object"}],"type":"object"},"secondary-dns_single_response_incoming":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-single"},{"properties":{"result":{"properties":{"auto_refresh_seconds":{"$ref":"#/components/schemas/secondary-dns_auto_refresh_seconds"},"checked_time":{"$ref":"#/components/schemas/secondary-dns_time"},"created_time":{"$ref":"#/components/schemas/secondary-dns_time"},"id":{"$ref":"#/components/schemas/secondary-dns_identifier"},"modified_time":{"$ref":"#/components/schemas/secondary-dns_time"},"name":{"$ref":"#/components/schemas/secondary-dns_name"},"peers":{"$ref":"#/components/schemas/secondary-dns_peers"},"soa_serial":{"$ref":"#/components/schemas/secondary-dns_soa_serial"}},"type":"object"}},"type":"object"}],"type":"object"},"secondary-dns_single_response_outgoing":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_api-response-single"},{"properties":{"result":{"properties":{"checked_time":{"$ref":"#/components/schemas/secondary-dns_time"},"created_time":{"$ref":"#/components/schemas/secondary-dns_time"},"id":{"$ref":"#/components/schemas/secondary-dns_identifier"},"last_transferred_time":{"$ref":"#/components/schemas/secondary-dns_time"},"name":{"$ref":"#/components/schemas/secondary-dns_name"},"peers":{"$ref":"#/components/schemas/secondary-dns_peers"},"soa_serial":{"$ref":"#/components/schemas/secondary-dns_soa_serial"}},"type":"object"}},"type":"object"}],"type":"object"},"secondary-dns_soa_serial":{"description":"The serial number of the SOA for the given zone.","example":2019102400,"type":"number","x-auditable":true},"secondary-dns_time":{"description":"The time for a specific event.","example":"2019-10-24T17:09:42.883908+01:00","type":"string","x-auditable":true},"secondary-dns_tsig":{"properties":{"algo":{"$ref":"#/components/schemas/secondary-dns_algo"},"id":{"$ref":"#/components/schemas/secondary-dns_schemas-identifier"},"name":{"$ref":"#/components/schemas/secondary-dns_schemas-name"},"secret":{"$ref":"#/components/schemas/secondary-dns_secret"}},"required":["id","name","secret","algo"],"type":"object"},"secondary-dns_tsig_id":{"description":"TSIG authentication will be used for zone transfer if configured.","example":"69cd1e104af3e6ed3cb344f263fd0d5a","type":"string","x-auditable":true},"secrets-store_SecretStatus":{"enum":["pending","active","deleted"],"type":"string","x-auditable":true},"secrets-store_account_identifier":{"description":"Account Identifier","example":"985e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"secrets-store_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"secrets-store_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/secrets-store_messages"},"messages":{"$ref":"#/components/schemas/secrets-store_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"secrets-store_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/secrets-store_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/secrets-store_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"secrets-store_comment":{"description":"Freeform text describing the secret","example":"info about my secret","type":"string","x-auditable":true},"secrets-store_createSecretObject":{"properties":{"comment":{"$ref":"#/components/schemas/secrets-store_comment"},"name":{"$ref":"#/components/schemas/secrets-store_secret_name"},"scopes":{"$ref":"#/components/schemas/secrets-store_scopes"},"value":{"$ref":"#/components/schemas/secrets-store_value"}},"required":["name","value","scopes"]},"secrets-store_createStoreObject":{"properties":{"name":{"$ref":"#/components/schemas/secrets-store_store_name"}},"required":["name"]},"secrets-store_created":{"description":"Whenthe secret was created.","example":"2023-09-21T18:56:32.624632Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"secrets-store_deleteSecretObject":{"properties":{"id":{"$ref":"#/components/schemas/secrets-store_identifier"}},"required":["id"]},"secrets-store_duplicateSecretObject":{"properties":{"comment":{"$ref":"#/components/schemas/secrets-store_comment"},"name":{"$ref":"#/components/schemas/secrets-store_secret_name"},"scopes":{"$ref":"#/components/schemas/secrets-store_scopes"}},"required":["name","scopes"]},"secrets-store_identifier":{"description":"Secret identifier tag.","example":"3fd85f74b32742f1bff64a85009dda07","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"secrets-store_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"secrets-store_modified":{"description":"When the secret was modified.","example":"2023-09-21T18:56:32.624632Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"secrets-store_patchSecretObject":{"properties":{"comment":{"$ref":"#/components/schemas/secrets-store_comment"},"scopes":{"$ref":"#/components/schemas/secrets-store_scopes"}},"required":["name"]},"secrets-store_quota":{"description":"The number of secrets the account is entitlted to use","example":10,"type":"number","x-auditable":true},"secrets-store_quota_response":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/secrets-store_secretsUsageObject"}}}]},"secrets-store_scopes":{"description":"The list of services that can use this secret.","example":["workers","ai_gateway","dex","access"],"items":{"type":"string"},"type":"array"},"secrets-store_secretObject":{"properties":{"comment":{"$ref":"#/components/schemas/secrets-store_comment"},"created":{"$ref":"#/components/schemas/secrets-store_created"},"id":{"$ref":"#/components/schemas/secrets-store_identifier"},"modified":{"$ref":"#/components/schemas/secrets-store_modified"},"name":{"$ref":"#/components/schemas/secrets-store_secret_name"},"status":{"$ref":"#/components/schemas/secrets-store_SecretStatus"},"store_id":{"$ref":"#/components/schemas/secrets-store_store_identifier"}},"required":["id","name","store_id","created","modified","status"]},"secrets-store_secret_name":{"description":"The name of the secret","example":"MY_API_KEY","type":"string"},"secrets-store_secret_response":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/secrets-store_secretObject"}}}]},"secrets-store_secretsUsageObject":{"properties":{"secrets":{"$ref":"#/components/schemas/secrets-store_usageQuotaObject"}},"required":["secrets"]},"secrets-store_secrets_response_collection":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/secrets-store_secretObject"},"type":"array"}}}]},"secrets-store_storeObject":{"properties":{"created":{"$ref":"#/components/schemas/secrets-store_created"},"id":{"$ref":"#/components/schemas/secrets-store_store_identifier"},"modified":{"$ref":"#/components/schemas/secrets-store_modified"},"name":{"$ref":"#/components/schemas/secrets-store_store_name"}},"required":["id","name","created","modified"]},"secrets-store_store_identifier":{"description":"Store Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"secrets-store_store_name":{"description":"The name of the store","example":"service_x_keys","type":"string"},"secrets-store_store_response":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/secrets-store_storeObject"}}}]},"secrets-store_stores_response_collection":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/secrets-store_storeObject"},"type":"array"}}}]},"secrets-store_usage":{"description":"The number of secrets the account is currently using","example":10,"type":"number","x-auditable":true},"secrets-store_usageQuotaObject":{"properties":{"quota":{"$ref":"#/components/schemas/secrets-store_quota"},"usage":{"$ref":"#/components/schemas/secrets-store_usage"}},"required":["usage","quota"]},"secrets-store_value":{"description":"The value of the secret. Note that this is 'write only' - no API reponse will provide this value, it is only used to create/modify secrets.","example":"api-token-secret-123","type":"string","writeOnly":true,"x-sensitive":true},"security-center_accountId":{"$ref":"#/components/schemas/security-center_identifier"},"security-center_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/security-center_messages"},"messages":{"$ref":"#/components/schemas/security-center_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"security-center_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/security-center_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/security-center_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"security-center_api-response-single":{"allOf":[{"$ref":"#/components/schemas/security-center_api-response-common"}],"type":"object"},"security-center_count":{"description":"Total number of results","example":1,"type":"integer","x-auditable":true},"security-center_dismissed":{"example":false,"type":"boolean","x-auditable":true},"security-center_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"security-center_issue":{"properties":{"dismissed":{"example":false,"type":"boolean","x-auditable":true},"id":{"type":"string","x-auditable":true},"issue_class":{"$ref":"#/components/schemas/security-center_issueClass"},"issue_type":{"$ref":"#/components/schemas/security-center_issueType"},"payload":{"properties":{"detection_method":{"description":"Method used to detect insight","example":"We detected security rules referencing multiple IP addresses directly in the rules.","type":"string","x-auditable":true},"zone_tag":{"type":"string","x-auditable":true}},"type":"object"},"resolve_link":{"type":"string","x-auditable":true},"resolve_text":{"type":"string","x-auditable":true},"severity":{"enum":["Low","Moderate","Critical"],"type":"string","x-auditable":true},"since":{"format":"date-time","type":"string","x-auditable":true},"subject":{"$ref":"#/components/schemas/security-center_subject"},"timestamp":{"format":"date-time","type":"string","x-auditable":true}},"type":"object"},"security-center_issueClass":{"example":"always_use_https_not_enabled","type":"string","x-auditable":true},"security-center_issueClasses":{"example":["a_record_dangling","always_use_https_not_enabled"],"items":{"$ref":"#/components/schemas/security-center_issueClass"},"type":"array"},"security-center_issueType":{"enum":["compliance_violation","email_security","exposed_infrastructure","insecure_configuration","weak_authentication","configuration_suggestion"],"type":"string","x-auditable":true},"security-center_issueTypes":{"example":["compliance_violation","email_security"],"items":{"$ref":"#/components/schemas/security-center_issueType"},"type":"array"},"security-center_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"security-center_page":{"description":"Current page within paginated list of results","example":1,"type":"integer"},"security-center_perPage":{"description":"Number of results per page of results","example":25,"maximum":1000,"minimum":1,"type":"integer"},"security-center_products":{"example":["access","dns"],"items":{"type":"string","x-auditable":true},"type":"array"},"security-center_securityTxt":{"properties":{"acknowledgments":{"example":["https://example.com/hall-of-fame.html"],"items":{"format":"uri","type":"string","x-auditable":true},"type":"array"},"canonical":{"example":["https://www.example.com/.well-known/security.txt"],"items":{"format":"uri","type":"string","x-auditable":true},"type":"array"},"contact":{"example":["mailto:security@example.com","tel:+1-201-555-0123","https://example.com/security-contact.html"],"items":{"format":"uri","type":"string","x-auditable":true},"type":"array"},"enabled":{"example":true,"type":"boolean","x-auditable":true},"encryption":{"example":["https://example.com/pgp-key.txt","dns:5d2d37ab76d47d36._openpgpkey.example.com?type=OPENPGPKEY","openpgp4fpr:5f2de5521c63a801ab59ccb603d49de44b29100f"],"items":{"format":"uri","type":"string"},"type":"array"},"expires":{"format":"date-time","type":"string","x-auditable":true},"hiring":{"example":["https://example.com/jobs.html"],"items":{"format":"uri","type":"string","x-auditable":true},"type":"array"},"policy":{"example":["https://example.com/disclosure-policy.html"],"items":{"format":"uri","type":"string","x-auditable":true},"type":"array"},"preferredLanguages":{"example":"en, es, fr","type":"string","x-auditable":true}},"type":"object"},"security-center_severityQueryParam":{"example":["low","moderate"],"items":{"enum":["low","moderate","critical"],"type":"string","x-auditable":true},"type":"array"},"security-center_subject":{"example":"example.com","type":"string","x-auditable":true},"security-center_subjects":{"items":{"$ref":"#/components/schemas/security-center_subject"},"type":"array"},"security-center_valueCountsResponse":{"allOf":[{"$ref":"#/components/schemas/security-center_api-response-common"},{"properties":{"result":{"anyOf":[{"items":{"properties":{"count":{"example":1,"type":"integer","x-auditable":true},"value":{"type":"string","x-auditable":true}},"type":"object"},"type":"array"}]}}}]},"security-center_zoneId":{"$ref":"#/components/schemas/security-center_identifier"},"smartshield_address":{"description":"The hostname or IP address of the origin server to run health checks on.","example":"www.example.com","type":"string","x-auditable":true},"smartshield_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/smartshield_api-response-common"},{"properties":{"result":{"items":{},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/smartshield_result_info"}}}],"type":"object"},"smartshield_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/smartshield_messages"},"messages":{"$ref":"#/components/schemas/smartshield_messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"smartshield_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/smartshield_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/smartshield_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"smartshield_api-response-single":{"allOf":[{"$ref":"#/components/schemas/smartshield_api-response-common"},{"properties":{"result":{"oneOf":[{"type":"object"},{"type":"string"}]}},"type":"object"}],"type":"object"},"smartshield_base":{"properties":{"id":{"description":"Identifier of the zone setting.","type":"string","x-auditable":true},"modified_on":{"description":"Last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string","x-auditable":true}},"required":["id"],"type":"object"},"smartshield_cache_reserve_clear":{"allOf":[{"$ref":"#/components/schemas/smartshield_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["cache_reserve_clear"],"example":"cache_reserve_clear","type":"string","x-auditable":true}},"type":"object"}],"description":"You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.","title":"Cache Reserve Clear","type":"object"},"smartshield_cache_reserve_clear_end_ts":{"description":"The time that the latest Cache Reserve Clear operation completed.","example":"2023-10-02T12:00:00.12345Z","format":"date-time","type":"string","x-auditable":true},"smartshield_cache_reserve_clear_response_value":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/smartshield_cache_reserve_clear"},{"properties":{"end_ts":{"$ref":"#/components/schemas/smartshield_cache_reserve_clear_end_ts"},"start_ts":{"$ref":"#/components/schemas/smartshield_cache_reserve_clear_start_ts"},"state":{"$ref":"#/components/schemas/smartshield_cache_reserve_clear_state"}},"required":["state","start_ts"],"type":"object"}],"type":"object"}},"type":"object"},"smartshield_cache_reserve_clear_start_ts":{"description":"The time that the latest Cache Reserve Clear operation started.","example":"2023-10-02T10:00:00.12345Z","format":"date-time","type":"string","x-auditable":true},"smartshield_cache_reserve_clear_state":{"description":"The current state of the Cache Reserve Clear operation.","enum":["In-progress","Completed"],"example":"In-progress","type":"string","x-auditable":true},"smartshield_check_regions":{"description":"A list of regions from which to run health checks. Null means Cloudflare will pick a default region.","example":["WEU","ENAM"],"items":{"description":"WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, IN: India, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (BUSINESS and ENTERPRISE customers only).","enum":["WNAM","ENAM","WEU","EEU","NSAM","SSAM","OC","ME","NAF","SAF","IN","SEAS","NEAS","ALL_REGIONS"],"type":"string"},"nullable":true,"type":"array","x-auditable":true},"smartshield_consecutive_fails":{"default":1,"description":"The number of consecutive fails required from a health check before changing the health to unhealthy.","type":"integer","x-auditable":true},"smartshield_consecutive_successes":{"default":1,"description":"The number of consecutive successes required from a health check before changing the health to healthy.","type":"integer","x-auditable":true},"smartshield_description":{"description":"A human-readable description of the health check.","example":"Health check for www.example.com","type":"string","x-auditable":true},"smartshield_failure_reason":{"description":"The current failure reason if status is unhealthy.","example":"","readOnly":true,"type":"string","x-auditable":true},"smartshield_healthchecks":{"properties":{"address":{"$ref":"#/components/schemas/smartshield_address"},"check_regions":{"$ref":"#/components/schemas/smartshield_check_regions"},"consecutive_fails":{"$ref":"#/components/schemas/smartshield_consecutive_fails"},"consecutive_successes":{"$ref":"#/components/schemas/smartshield_consecutive_successes"},"created_on":{"$ref":"#/components/schemas/smartshield_timestamp"},"description":{"$ref":"#/components/schemas/smartshield_description"},"failure_reason":{"$ref":"#/components/schemas/smartshield_failure_reason"},"http_config":{"$ref":"#/components/schemas/smartshield_http_config"},"id":{"$ref":"#/components/schemas/smartshield_identifier"},"interval":{"$ref":"#/components/schemas/smartshield_interval"},"modified_on":{"$ref":"#/components/schemas/smartshield_timestamp"},"name":{"$ref":"#/components/schemas/smartshield_name"},"retries":{"$ref":"#/components/schemas/smartshield_retries"},"status":{"$ref":"#/components/schemas/smartshield_status"},"suspended":{"$ref":"#/components/schemas/smartshield_suspended"},"tcp_config":{"$ref":"#/components/schemas/smartshield_tcp_config"},"timeout":{"$ref":"#/components/schemas/smartshield_timeout"},"type":{"$ref":"#/components/schemas/smartshield_type"}},"type":"object"},"smartshield_http_config":{"description":"Parameters specific to an HTTP or HTTPS health check.","nullable":true,"properties":{"allow_insecure":{"default":false,"description":"Do not validate the certificate when the health check uses HTTPS.","type":"boolean","x-auditable":true},"expected_body":{"description":"A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy.","example":"success","type":"string","x-auditable":true},"expected_codes":{"default":"200","description":"The expected HTTP response codes (e.g. \"200\") or code ranges (e.g. \"2xx\" for all codes starting with 2) of the health check.","example":["2xx","302"],"items":{"type":"string"},"nullable":true,"type":"array","x-auditable":true},"follow_redirects":{"default":false,"description":"Follow redirects if the origin returns a 3xx status code.","type":"boolean","x-auditable":true},"header":{"additionalProperties":{"items":{"type":"string","x-auditable":true},"type":"array"},"description":"The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden.","example":{"Host":["example.com"],"X-App-ID":["abc123"]},"nullable":true,"type":"object"},"method":{"default":"GET","description":"The HTTP method to use for the health check.","enum":["GET","HEAD"],"type":"string","x-auditable":true},"path":{"default":"/","description":"The endpoint path to health check against.","example":"/health","type":"string","x-auditable":true},"port":{"default":80,"description":"Port number to connect to for the health check. Defaults to 80 if type is HTTP or 443 if type is HTTPS.","type":"integer","x-auditable":true}},"type":"object"},"smartshield_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"smartshield_interval":{"default":60,"description":"The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.","type":"integer","x-auditable":true},"smartshield_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"smartshield_name":{"description":"A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.","example":"server-1","type":"string","x-auditable":true},"smartshield_query_healthcheck":{"properties":{"address":{"$ref":"#/components/schemas/smartshield_address"},"check_regions":{"$ref":"#/components/schemas/smartshield_check_regions"},"consecutive_fails":{"$ref":"#/components/schemas/smartshield_consecutive_fails"},"consecutive_successes":{"$ref":"#/components/schemas/smartshield_consecutive_successes"},"description":{"$ref":"#/components/schemas/smartshield_description"},"http_config":{"$ref":"#/components/schemas/smartshield_http_config"},"interval":{"$ref":"#/components/schemas/smartshield_interval"},"name":{"$ref":"#/components/schemas/smartshield_name"},"retries":{"$ref":"#/components/schemas/smartshield_retries"},"suspended":{"$ref":"#/components/schemas/smartshield_suspended"},"tcp_config":{"$ref":"#/components/schemas/smartshield_tcp_config"},"timeout":{"$ref":"#/components/schemas/smartshield_timeout"},"type":{"$ref":"#/components/schemas/smartshield_type"}},"required":["name","address"],"type":"object"},"smartshield_response_collection":{"allOf":[{"$ref":"#/components/schemas/smartshield_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/smartshield_healthchecks"},"type":"array"}}}]},"smartshield_result_info":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters","example":2000,"type":"number"}},"type":"object"},"smartshield_retries":{"default":2,"description":"The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.","type":"integer","x-auditable":true},"smartshield_single_hc_id_response":{"allOf":[{"$ref":"#/components/schemas/smartshield_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/smartshield_identifier"}},"type":"object"}},"type":"object"}]},"smartshield_single_hc_response":{"allOf":[{"$ref":"#/components/schemas/smartshield_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/smartshield_healthchecks"}},"type":"object"}]},"smartshield_single_smart_shield_get_response":{"allOf":[{"$ref":"#/components/schemas/smartshield_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/smartshield_smart_shield_settings_get_response"}},"type":"object"}]},"smartshield_single_smart_shield_patch_response":{"allOf":[{"$ref":"#/components/schemas/smartshield_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/smartshield_smart_shield_settings_patch_response"}},"type":"object"}]},"smartshield_smart_shield_settings":{"description":"A consolidated object containing settings from multiple APIs for partial updates.","properties":{"cache_reserve":{"properties":{"editable":{"description":"Whether the setting is editable.","example":true,"type":"boolean"},"id":{"description":"The id of the Cache Reserve setting.","example":"cache_reserve","type":"string"},"value":{"description":"Specifies the enablement value of Cache Reserve.","enum":["on","off"],"example":"off","type":"string"}}},"regional_tiered_cache":{"properties":{"editable":{"description":"Whether the setting is editable.","example":true,"type":"boolean"},"id":{"description":"The id of the Regional Tiered Cache setting.","example":"regional_tiered_cache","type":"string"},"value":{"description":"Specifies the enablement value of Cache Reserve.","enum":["on","off"],"example":"off","type":"string"}},"type":"object"},"smart_routing":{"properties":{"editable":{"description":"Whether the setting is editable.","example":true,"type":"boolean"},"id":{"description":"The id of the Smart Routing setting.","example":"smart_routing","type":"string"},"value":{"description":"Specifies the enablement value of Argo Smart Routing.","enum":["on","off"],"example":"off","type":"string"}},"type":"object"},"smart_tiered_cache":{"properties":{"editable":{"description":"Whether the setting is editable.","example":true,"type":"boolean"},"id":{"description":"The id of the Smart Tiered Cache setting.","example":"smart_tiered_cache","type":"string"},"modified_on":{"description":"The last time the setting was modified.","example":"2025-09-10T22:53:22.946098Z","type":"string"},"value":{"description":"Specifies the enablement value of Tiered Cache.","enum":["on","off"],"example":"on","type":"string"}},"type":"object"}},"type":"object"},"smartshield_smart_shield_settings_get_response":{"allOf":[{"$ref":"#/components/schemas/smartshield_smart_shield_settings"},{"properties":{"healthchecks_count":{"description":"The total number of health checks associated with the zone.","example":5,"type":"integer"}},"type":"object"}],"description":"The full Smart Shield response from the GET and PATCH operations.","required":["smart_tiered_cache","smart_routing","regional_tiered_cache","cache_reserve","healthchecks_count"],"type":"object"},"smartshield_smart_shield_settings_patch_body":{"description":"The patch body for Smart Shield.","example":{"smart_tiered_cache":{"value":"on"}},"properties":{"cache_reserve":{"properties":{"value":{"description":"Specifies the enablement value of Cache Reserve.","enum":["on","off"],"example":"on","type":"string"}},"type":"object"},"regional_tiered_cache":{"properties":{"value":{"description":"Specifies the enablement value of Regional Tiered Cache.","enum":["on","off"],"example":"on","type":"string"}},"type":"object"},"smart_routing":{"properties":{"value":{"description":"Specifies the enablement value of Smart Routing.","enum":["on","off"],"example":"on","type":"string"}},"type":"object"},"smart_tiered_cache":{"properties":{"value":{"description":"Specifies the enablement value of Smart Tiered Cache.","enum":["on","off"],"example":"on","type":"string"}},"type":"object"}},"type":"object"},"smartshield_smart_shield_settings_patch_response":{"description":"A consolidated object containing settings from multiple APIs for partial updates.","properties":{"smart_tiered_cache":{"properties":{"editable":{"description":"Whether the setting is editable.","example":true,"type":"boolean"},"id":{"description":"The id of the Smart Tiered Cache setting.","example":"smart_tiered_cache","type":"string"},"modified_on":{"description":"The last time the setting was modified.","example":"2025-09-10T22:53:22.946098Z","type":"string"},"value":{"description":"Specifies the enablement value of Tiered Cache.","enum":["on","off"],"example":"on","type":"string"}},"type":"object"}},"required":["smart_tiered_cache","smart_routing","regional_tiered_cache","cache_reserve"],"type":"object"},"smartshield_status":{"description":"The current status of the origin server according to the health check.","enum":["unknown","healthy","unhealthy","suspended"],"example":"healthy","readOnly":true,"type":"string","x-auditable":true},"smartshield_suspended":{"default":false,"description":"If suspended, no health checks are sent to the origin.","type":"boolean","x-auditable":true},"smartshield_tcp_config":{"description":"Parameters specific to TCP health check.","nullable":true,"properties":{"method":{"default":"connection_established","description":"The TCP connection method to use for the health check.","enum":["connection_established"],"type":"string","x-auditable":true},"port":{"default":80,"description":"Port number to connect to for the health check. Defaults to 80.","type":"integer","x-auditable":true}},"type":"object"},"smartshield_timeout":{"default":5,"description":"The timeout (in seconds) before marking the health check as failed.","type":"integer","x-auditable":true},"smartshield_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"smartshield_type":{"default":"HTTP","description":"The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.","example":"HTTPS","type":"string","x-auditable":true},"snippets_Errors":{"description":"A list of error messages.","items":{"$ref":"#/components/schemas/snippets_Message"},"title":"Errors","type":"array"},"snippets_Message":{"description":"A message.","properties":{"code":{"description":"A unique code for this message.","example":10000,"title":"Code","type":"integer","x-auditable":true},"message":{"description":"A text description of this message.","example":"something bad happened","minLength":1,"title":"Description","type":"string","x-auditable":true}},"required":["message"],"title":"Message","type":"object"},"snippets_Messages":{"description":"A list of warning messages.","items":{"$ref":"#/components/schemas/snippets_Message"},"title":"Messages","type":"array"},"snippets_Page":{"default":1,"description":"The current page number.","example":1,"minimum":1,"title":"Page","type":"integer","x-auditable":true},"snippets_PerPage":{"default":25,"description":"The number of results to return per page.","example":25,"minimum":1,"title":"Per Page","type":"integer","x-auditable":true},"snippets_Response":{"description":"A response object.","properties":{"errors":{"$ref":"#/components/schemas/snippets_Errors"},"messages":{"$ref":"#/components/schemas/snippets_Messages"},"result":{"description":"A result.","title":"Result"},"success":{"description":"Whether the API call was successful.","title":"Success","type":"boolean","x-auditable":true}},"required":["result","success","errors","messages"],"title":"Response","type":"object"},"snippets_ResultInfo":{"description":"Additional information to navigate the results.","properties":{"count":{"description":"The number of results in the current page.","example":25,"minimum":0,"title":"Count","type":"integer","x-auditable":true},"page":{"$ref":"#/components/schemas/snippets_Page"},"per_page":{"$ref":"#/components/schemas/snippets_PerPage"},"total_count":{"description":"The total number of results.","example":100,"minimum":0,"title":"Total Count","type":"integer","x-auditable":true},"total_pages":{"description":"The total number of pages.","example":10,"minimum":1,"title":"Total Pages","type":"integer","x-auditable":true}},"required":["page","per_page","total_pages","count","total_count"],"title":"Result Info","type":"object"},"snippets_Snippet":{"description":"A snippet object.","properties":{"created_on":{"description":"The timestamp of when the snippet was created.","example":"2000-01-01T00:00:00.000000Z","format":"date-time","title":"Created On","type":"string","x-auditable":true},"modified_on":{"description":"The timestamp of when the snippet was last modified.","example":"2000-01-01T00:00:00.000000Z","format":"date-time","title":"Modified On","type":"string","x-auditable":true},"snippet_name":{"$ref":"#/components/schemas/snippets_SnippetName"}},"required":["created_on","modified_one","snippet_name"],"title":"Snippet","type":"object"},"snippets_SnippetFiles":{"description":"The list of files belonging to the snippet.","items":{"description":"A file belonging to the snippet.","format":"binary","title":"File","type":"string","x-auditable":true},"minItems":1,"title":"Files","type":"array"},"snippets_SnippetMainModule":{"description":"Name of the file that contains the main module of the snippet.","example":"main.js","minLength":1,"title":"Main Module","type":"string","x-auditable":true},"snippets_SnippetName":{"description":"The identifying name of the snippet.","example":"my_snippet","pattern":"^[A-Za-z0-9_]+$","title":"Snippet Name","type":"string","x-auditable":true},"snippets_SnippetRules":{"description":"A list of snippet rules.","items":{"description":"A snippet rule.","properties":{"description":{"default":"","description":"An informative description of the rule.","example":"Execute my_snippet when IP address is 1.1.1.1.","title":"Description","type":"string","x-auditable":true},"enabled":{"default":false,"description":"Whether the rule should be executed.","example":true,"title":"Enabled","type":"boolean","x-auditable":true},"expression":{"description":"The expression defining which traffic will match the rule.","example":"ip.src eq 1.1.1.1","minLength":1,"title":"Expression","type":"string","x-auditable":true},"id":{"description":"The unique ID of the rule.","example":"3a03d665bac047339bb530ecb439a90d","pattern":"^[0-9a-f]{32}$","readOnly":true,"title":"ID","type":"string","x-auditable":true},"last_updated":{"description":"The timestamp of when the rule was last modified.","example":"2000-01-01T00:00:00.000000Z","format":"date-time","readOnly":true,"title":"Last Updated","type":"string","x-auditable":true},"snippet_name":{"$ref":"#/components/schemas/snippets_SnippetName"}},"required":["id","expression","snippet_name","last_updated"],"title":"Snippet Rule","type":"object"},"title":"Snippet Rules","type":"array"},"snippets_ZoneId":{"description":"The unique ID of the zone.","example":"9f1839b6152d298aca64c4e906b6d074","pattern":"^[0-9a-f]{32}$","title":"Zone ID","type":"string","x-auditable":true},"spectrum-analytics_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/spectrum-analytics_messages"},"messages":{"$ref":"#/components/schemas/spectrum-analytics_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"spectrum-analytics_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/spectrum-analytics_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/spectrum-analytics_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"spectrum-analytics_api-response-single":{"allOf":[{"$ref":"#/components/schemas/spectrum-analytics_api-response-common"}],"type":"object"},"spectrum-analytics_app_id_param":{"description":"Comma-delimited list of Spectrum Application Id(s). If provided, the response will be limited to Spectrum Application Id(s) that match.","example":"ea95132c15732412d22c1476fa83f27a,d122c5f4bb71e25cc9e86ab43b142e2f","type":"string"},"spectrum-analytics_column":{"properties":{"dimensions":{"items":{"type":"string"},"type":"array"},"metrics":{"oneOf":[{"items":{"type":"number"},"type":"array"},{"items":{"items":{"type":"number"},"type":"array"},"type":"array"}]}},"type":"object"},"spectrum-analytics_dimensions":{"description":"Can be used to break down the data by given attributes. Options are: \n\nDimension                 | Name                            | Example\n--------------------------|---------------------------------|--------------------------\nevent                     | Connection Event                | connect, progress, disconnect, originError, clientFiltered\nappID                     | Application ID                  | 40d67c87c6cd4b889a4fd57805225e85\ncoloName                  | Colo Name                       | SFO\nipVersion                 | IP version used by the client   | 4, 6.","example":["event","appID"],"items":{"enum":["event","appID","coloName","ipVersion"],"type":"string"},"type":"array"},"spectrum-analytics_filters":{"description":"Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are:\n\nOperator                  | Name                            | URL Encoded\n--------------------------|---------------------------------|--------------------------\n==                        | Equals                          | %3D%3D\n!=                        | Does not equals                 | !%3D\n\\\u003e                        | Greater Than                    | %3E\n\\\u003c                        | Less Than                       | %3C\n\\\u003e=                       | Greater than or equal to        | %3E%3D\n\\\u003c=                       | Less than or equal to           | %3C%3D","example":"event==disconnect%20AND%20coloName!=SFO","type":"string"},"spectrum-analytics_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"spectrum-analytics_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"spectrum-analytics_metrics":{"description":"One or more metrics to compute. Options are: \n\nMetric                    | Name                                | Example                  | Unit\n--------------------------|-------------------------------------|--------------------------|--------------------------\ncount                     | Count of total events               | 1000                     | Count\nbytesIngress              | Sum of ingress bytes                | 1000                     | Sum\nbytesEgress               | Sum of egress bytes                 | 1000                     | Sum\ndurationAvg               | Average connection duration         | 1.0                      | Time in milliseconds\ndurationMedian            | Median connection duration          | 1.0                      | Time in milliseconds\nduration90th              | 90th percentile connection duration | 1.0                      | Time in milliseconds\nduration99th              | 99th percentile connection duration | 1.0                      | Time in milliseconds.","example":["count","bytesIngress"],"items":{"enum":["count","bytesIngress","bytesEgress","durationAvg","durationMedian","duration90th","duration99th"],"type":"string"},"type":"array"},"spectrum-analytics_query":{"properties":{"dimensions":{"$ref":"#/components/schemas/spectrum-analytics_dimensions"},"filters":{"$ref":"#/components/schemas/spectrum-analytics_filters"},"limit":{"description":"Limit number of returned metrics.","type":"number"},"metrics":{"$ref":"#/components/schemas/spectrum-analytics_metrics"},"since":{"$ref":"#/components/schemas/spectrum-analytics_since"},"sort":{"$ref":"#/components/schemas/spectrum-analytics_sort"},"until":{"$ref":"#/components/schemas/spectrum-analytics_until"}},"type":"object"},"spectrum-analytics_query-response-aggregate":{"allOf":[{"$ref":"#/components/schemas/spectrum-analytics_api-response-single"},{"properties":{"result":{"items":{"properties":{"appID":{"allOf":[{"description":"Application identifier."},{"$ref":"#/components/schemas/spectrum-analytics_identifier"}]},"bytesEgress":{"description":"Number of bytes sent","type":"number"},"bytesIngress":{"description":"Number of bytes received","type":"number"},"connections":{"description":"Number of connections","type":"number"},"durationAvg":{"description":"Average duration of connections","type":"number"}},"required":["appID","bytesIngress","bytesEgress","connections","durationAvg"],"type":"object"},"type":"array"}}}]},"spectrum-analytics_query-response-single":{"allOf":[{"$ref":"#/components/schemas/spectrum-analytics_api-response-single"},{"properties":{"result":{"properties":{"data":{"description":"List of columns returned by the analytics query.","items":{"$ref":"#/components/schemas/spectrum-analytics_column"},"type":"array"},"data_lag":{"description":"Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.","example":3,"minimum":0,"type":"number"},"max":{"allOf":[{"description":"Maximum result for each selected metrics across all data."},{"$ref":"#/components/schemas/spectrum-analytics_stat"}]},"min":{"allOf":[{"description":"Minimum result for each selected metrics across all data."},{"$ref":"#/components/schemas/spectrum-analytics_stat"}]},"query":{"$ref":"#/components/schemas/spectrum-analytics_query"},"rows":{"description":"Total number of rows in the result.","example":5,"minimum":0,"type":"number"},"time_intervals":{"description":"List of time interval buckets: [start, end]","items":{"items":{"$ref":"#/components/schemas/spectrum-analytics_timestamp"},"type":"array"},"type":"array"},"totals":{"allOf":[{"description":"Total result for each selected metrics across all data."},{"$ref":"#/components/schemas/spectrum-analytics_stat"}]}},"required":["rows","data","data_lag","min","max","totals","query"],"type":"object"}}}]},"spectrum-analytics_since":{"allOf":[{"description":"Start of time interval to query, defaults to `until` - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified."},{"$ref":"#/components/schemas/spectrum-analytics_timestamp"}]},"spectrum-analytics_sort":{"description":"The sort order for the result set; sort fields must be included in `metrics` or `dimensions`.","example":["+count","-bytesIngress"],"items":{"type":"string"},"type":"array"},"spectrum-analytics_stat":{"additionalProperties":{"type":"number"},"example":{"bytesEgress":100,"bytesIngress":50},"type":"object"},"spectrum-analytics_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true},"spectrum-analytics_until":{"allOf":[{"description":"End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified."},{"$ref":"#/components/schemas/spectrum-analytics_timestamp"}]},"spectrum-config_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/spectrum-config_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"spectrum-config_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/spectrum-config_messages"},"messages":{"$ref":"#/components/schemas/spectrum-config_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"spectrum-config_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/spectrum-config_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/spectrum-config_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"spectrum-config_api-response-single":{"allOf":[{"$ref":"#/components/schemas/spectrum-config_api-response-common"}],"type":"object"},"spectrum-config_api-response-single-id":{"allOf":[{"$ref":"#/components/schemas/spectrum-config_api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/spectrum-config_identifier"}},"required":["id"],"type":"object"}}}],"type":"object"},"spectrum-config_app_config":{"allOf":[{"$ref":"#/components/schemas/spectrum-config_base_app_config"},{"properties":{"argo_smart_routing":{"$ref":"#/components/schemas/spectrum-config_argo_smart_routing"},"dns":{"$ref":"#/components/schemas/spectrum-config_dns"},"edge_ips":{"$ref":"#/components/schemas/spectrum-config_edge_ips"},"ip_firewall":{"$ref":"#/components/schemas/spectrum-config_ip_firewall"},"origin_direct":{"$ref":"#/components/schemas/spectrum-config_origin_direct"},"origin_dns":{"$ref":"#/components/schemas/spectrum-config_origin_dns"},"origin_port":{"$ref":"#/components/schemas/spectrum-config_origin_port"},"protocol":{"$ref":"#/components/schemas/spectrum-config_protocol"},"proxy_protocol":{"$ref":"#/components/schemas/spectrum-config_proxy_protocol"},"tls":{"$ref":"#/components/schemas/spectrum-config_tls"},"traffic_type":{"$ref":"#/components/schemas/spectrum-config_traffic_type"}},"required":["protocol","dns","traffic_type"],"type":"object"}]},"spectrum-config_app_config_collection":{"allOf":[{"$ref":"#/components/schemas/spectrum-config_api-response-collection"},{"properties":{"result":{"oneOf":[{"items":{"$ref":"#/components/schemas/spectrum-config_app_config"},"type":"array"},{"items":{"$ref":"#/components/schemas/spectrum-config_paygo_app_config"},"type":"array"}]}}}]},"spectrum-config_app_config_single":{"allOf":[{"$ref":"#/components/schemas/spectrum-config_api-response-single"},{"properties":{"result":{"oneOf":[{"$ref":"#/components/schemas/spectrum-config_app_config"},{"$ref":"#/components/schemas/spectrum-config_paygo_app_config"}]}}}]},"spectrum-config_app_identifier":{"allOf":[{"description":"App identifier."},{"readOnly":true},{"$ref":"#/components/schemas/spectrum-config_identifier"}]},"spectrum-config_argo_smart_routing":{"default":false,"description":"Enables Argo Smart Routing for this application.\nNotes: Only available for TCP applications with traffic_type set to \"direct\".","example":true,"type":"boolean"},"spectrum-config_base_app_config":{"properties":{"created_on":{"$ref":"#/components/schemas/spectrum-config_created"},"id":{"$ref":"#/components/schemas/spectrum-config_app_identifier"},"modified_on":{"$ref":"#/components/schemas/spectrum-config_modified"}},"required":["id","created_on","modified_on"],"type":"object"},"spectrum-config_created":{"allOf":[{"description":"When the Application was created."},{"readOnly":true},{"$ref":"#/components/schemas/spectrum-config_timestamp"}]},"spectrum-config_dns":{"description":"The name and type of DNS record for the Spectrum application.","properties":{"name":{"$ref":"#/components/schemas/spectrum-config_dns_name"},"type":{"$ref":"#/components/schemas/spectrum-config_dns_type"}},"type":"object"},"spectrum-config_dns_name":{"description":"The name of the DNS record associated with the application.","example":"ssh.example.com","format":"hostname","type":"string"},"spectrum-config_dns_ttl":{"description":"The TTL of our resolution of your DNS record in seconds.","minimum":600,"type":"integer"},"spectrum-config_dns_type":{"description":"The type of DNS record associated with the application.","enum":["CNAME","ADDRESS"],"example":"CNAME","type":"string"},"spectrum-config_edge_ips":{"default":{"connectivity":"all","type":"dynamic"},"description":"The anycast edge IP configuration for the hostname of this application.","oneOf":[{"properties":{"connectivity":{"description":"The IP versions supported for inbound connections on Spectrum anycast IPs.","enum":["all","ipv4","ipv6"],"example":"all","type":"string"},"type":{"description":"The type of edge IP configuration specified. Dynamically allocated edge IPs use Spectrum anycast IPs in accordance with the connectivity you specify. Only valid with CNAME DNS names.","enum":["dynamic"],"example":"dynamic","type":"string"}},"type":"object"},{"properties":{"ips":{"description":"The array of customer owned IPs we broadcast via anycast for this hostname and application.","example":["192.0.2.1"],"items":{"description":"Edge anycast IPs.","example":"192.0.2.1","type":"string"},"type":"array"},"type":{"description":"The type of edge IP configuration specified. Statically allocated edge IPs use customer IPs in accordance with the ips array you specify. Only valid with ADDRESS DNS names.","enum":["static"],"example":"static","type":"string"}},"type":"object"}]},"spectrum-config_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"spectrum-config_ip_firewall":{"default":false,"description":"Enables IP Access Rules for this application.\nNotes: Only available for TCP applications.","example":false,"type":"boolean"},"spectrum-config_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"spectrum-config_modified":{"allOf":[{"description":"When the Application was last modified."},{"readOnly":true},{"$ref":"#/components/schemas/spectrum-config_timestamp"}]},"spectrum-config_origin_direct":{"description":"List of origin IP addresses. Array may contain multiple IP addresses for load balancing.","items":{"example":"tcp://127.0.0.1:8080","format":"URI","type":"string"},"type":"array"},"spectrum-config_origin_dns":{"description":"The name and type of DNS record for the Spectrum application.","properties":{"name":{"$ref":"#/components/schemas/spectrum-config_origin_dns_name"},"ttl":{"$ref":"#/components/schemas/spectrum-config_dns_ttl"},"type":{"$ref":"#/components/schemas/spectrum-config_origin_dns_type"}},"type":"object"},"spectrum-config_origin_dns_name":{"description":"The name of the DNS record associated with the origin.","example":"origin.example.com","format":"hostname","type":"string"},"spectrum-config_origin_dns_type":{"description":"The type of DNS record associated with the origin. \"\" is used to specify a combination of A/AAAA records.","enum":["","A","AAAA","SRV"],"example":"","type":"string"},"spectrum-config_origin_port":{"anyOf":[{"type":"integer"},{"type":"string"}],"description":"The destination port at the origin. Only specified in conjunction with origin_dns. May use an integer to specify a single origin port, for example `1000`, or a string to specify a range of origin ports, for example `\"1000-2000\"`.\nNotes: If specifying a port range, the number of ports in the range must match the number of ports specified in the \"protocol\" field.","example":22,"maximum":65535,"minimum":1},"spectrum-config_paygo_app_config":{"allOf":[{"$ref":"#/components/schemas/spectrum-config_base_app_config"},{"properties":{"dns":{"$ref":"#/components/schemas/spectrum-config_dns"},"origin_direct":{"$ref":"#/components/schemas/spectrum-config_origin_direct"},"protocol":{"$ref":"#/components/schemas/spectrum-config_protocol"}},"required":["protocol","dns"],"type":"object"}]},"spectrum-config_protocol":{"description":"The port configuration at Cloudflare's edge. May specify a single port, for example `\"tcp/1000\"`, or a range of ports, for example `\"tcp/1000-2000\"`.","example":"tcp/22","type":"string"},"spectrum-config_proxy_protocol":{"default":"off","description":"Enables Proxy Protocol to the origin. Refer to [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/) for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol.","enum":["off","v1","v2","simple"],"example":"off","type":"string"},"spectrum-config_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true},"spectrum-config_tls":{"default":"off","description":"The type of TLS termination associated with the application.","enum":["off","flexible","full","strict"],"example":"off","type":"string"},"spectrum-config_traffic_type":{"default":"direct","description":"Determines how data travels from the edge to your origin. When set to \"direct\", Spectrum will send traffic directly to your origin, and the application's type is derived from the `protocol`. When set to \"http\" or \"https\", Spectrum will apply Cloudflare's HTTP/HTTPS features as it sends traffic to your origin, and the application type matches this property exactly.","enum":["direct","http","https"],"example":"direct","type":"string"},"spectrum-config_update_app_config":{"oneOf":[{"$ref":"#/components/schemas/spectrum-config_app_config"},{"$ref":"#/components/schemas/spectrum-config_paygo_app_config"}]},"spectrum-config_zone_identifier":{"allOf":[{"description":"Zone identifier."},{"readOnly":true},{"$ref":"#/components/schemas/spectrum-config_identifier"}]},"speed_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/speed_messages"},"messages":{"$ref":"#/components/schemas/speed_messages"},"success":{"description":"Whether the API call was successful.","example":true,"type":"boolean","x-auditable":true}},"required":["success","errors","messages"],"type":"object"},"speed_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/speed_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/speed_messages"}],"example":[]},"result":{"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","example":false,"type":"boolean","x-auditable":true}},"required":["success","errors","messages","result"],"type":"object"},"speed_api-response-single-id":{"allOf":[{"$ref":"#/components/schemas/speed_api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/speed_identifier"}},"required":["id"],"type":"object"}},"type":"object"}],"type":"object"},"speed_base":{"properties":{"editable":{"default":true,"description":"Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).","enum":[true,false],"readOnly":true,"type":"boolean","x-auditable":true},"id":{"description":"Identifier of the zone setting.","example":"development_mode","type":"string","x-auditable":true},"modified_on":{"description":"last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"value":{"description":"Current value of the zone setting.","enum":["on","off"],"example":"on","type":"string","x-auditable":true}}},"speed_cloudflare_fonts":{"allOf":[{"$ref":"#/components/schemas/speed_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["fonts"],"example":"fonts","type":"string","x-auditable":true},"value":{"$ref":"#/components/schemas/speed_cloudflare_fonts_value"}},"type":"object"}],"description":"Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain,\nboost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.\n","title":"Cloudflare Fonts"},"speed_cloudflare_fonts_value":{"default":"off","description":"Whether the feature is enabled or disabled.","enum":["on","off"],"type":"string","x-auditable":true},"speed_cloudflare_speed_brain_response":{"allOf":[{"$ref":"#/components/schemas/speed_base"},{"properties":{"value":{"description":"Whether the feature is enabled or disabled.\nDefaults to \"on\" for Free plans, otherwise defaults to \"off\".\n","type":"string"}},"type":"object"}],"title":"Cloudflare Speed Brain response"},"speed_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"speed_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer","x-auditable":true},"message":{"type":"string","x-auditable":true}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"stream_accessRules":{"description":"Defines rules for fine-grained control over content than signed URL tokens alone. Access rules primarily make tokens conditionally valid based on user information. Access Rules are specified on token payloads as the `accessRules` property containing an array of Rule objects.","properties":{"action":{"description":"The action to take when a request matches a rule. If the action is `block`, the signed token blocks views for viewers matching the rule.","enum":["allow","block"],"example":"allow","type":"string","x-auditable":true},"country":{"description":"An array of 2-letter country codes in ISO 3166-1 Alpha-2 format used to match requests.","items":{"type":"string","x-auditable":true},"type":"array"},"ip":{"description":"An array of IPv4 or IPV6 addresses or CIDRs used to match requests.","items":{"type":"string","x-auditable":true},"type":"array"},"type":{"description":"Lists available rule types to match for requests. An `any` type matches all requests and can be used as a wildcard to apply default actions after other rules.","enum":["any","ip.src","ip.geoip.country"],"example":"ip.src","type":"string","x-auditable":true}},"type":"object"},"stream_account_identifier":{"description":"The account identifier tag.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"stream_addAudioTrackResponse":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/stream_additionalAudio"}},"type":"object"}]},"stream_additionalAudio":{"properties":{"default":{"$ref":"#/components/schemas/stream_audio_default"},"label":{"$ref":"#/components/schemas/stream_audio_label"},"status":{"$ref":"#/components/schemas/stream_audio_state"},"uid":{"$ref":"#/components/schemas/stream_identifier"}},"type":"object"},"stream_allowedOrigins":{"description":"Lists the origins allowed to display the video. Enter allowed origin domains in an array and use `*` for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.","example":["example.com"],"items":{"type":"string","x-auditable":true},"type":"array"},"stream_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/stream_messages"},"messages":{"$ref":"#/components/schemas/stream_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"stream_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/stream_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/stream_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"stream_api-response-single":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-common"}],"type":"object"},"stream_asc":{"default":false,"description":"Lists videos in ascending order of creation.","example":true,"type":"boolean"},"stream_audio_default":{"default":false,"description":"Denotes whether the audio track will be played by default in a player.","type":"boolean","x-auditable":true},"stream_audio_identifier":{"description":"The unique identifier for an additional audio track.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"type":"string","x-auditable":true},"stream_audio_label":{"description":"A string to uniquely identify the track amongst other audio track labels for the specified video.","example":"director commentary","type":"string","x-auditable":true},"stream_audio_state":{"description":"Specifies the processing status of the video.","enum":["queued","ready","error"],"type":"string","x-auditable":true},"stream_caption_basic_upload":{"properties":{"file":{"description":"The WebVTT file containing the caption or subtitle content.","example":"@/Users/kyle/Desktop/tr.vtt","type":"string","x-auditable":true}},"required":["file"],"type":"object"},"stream_caption_status":{"description":"The status of a generated caption.","enum":["ready","inprogress","error"],"type":"string","x-auditable":true},"stream_captions":{"properties":{"generated":{"$ref":"#/components/schemas/stream_generated_caption"},"label":{"$ref":"#/components/schemas/stream_label"},"language":{"$ref":"#/components/schemas/stream_language"},"status":{"$ref":"#/components/schemas/stream_caption_status"}},"type":"object"},"stream_clipResponseSingle":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/stream_clipping"}},"type":"object"}]},"stream_clipped_from_video_uid":{"description":"The unique video identifier (UID).","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"stream_clipping":{"properties":{"allowedOrigins":{"$ref":"#/components/schemas/stream_allowedOrigins"},"clippedFromVideoUID":{"$ref":"#/components/schemas/stream_clipped_from_video_uid"},"created":{"$ref":"#/components/schemas/stream_clipping_created"},"creator":{"$ref":"#/components/schemas/stream_creator"},"endTimeSeconds":{"$ref":"#/components/schemas/stream_end_time_seconds"},"maxDurationSeconds":{"$ref":"#/components/schemas/stream_maxDurationSeconds"},"meta":{"$ref":"#/components/schemas/stream_media_metadata"},"modified":{"$ref":"#/components/schemas/stream_live_input_modified"},"playback":{"$ref":"#/components/schemas/stream_playback"},"preview":{"$ref":"#/components/schemas/stream_preview"},"requireSignedURLs":{"$ref":"#/components/schemas/stream_requireSignedURLs"},"startTimeSeconds":{"$ref":"#/components/schemas/stream_start_time_seconds"},"status":{"$ref":"#/components/schemas/stream_media_state"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/stream_thumbnailTimestampPct"},"watermark":{"$ref":"#/components/schemas/stream_watermarkAtUpload"}}},"stream_clipping_created":{"description":"The date and time the clip was created.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string"},"stream_copyAudioTrack":{"properties":{"label":{"$ref":"#/components/schemas/stream_audio_label"},"url":{"description":"An audio track URL. The server must be publicly routable and support `HTTP HEAD` requests and `HTTP GET` range requests. The server should respond to `HTTP HEAD` requests with a `content-range` header that includes the size of the file.","example":"https://www.examplestorage.com/audio_file.mp3","format":"uri","type":"string","x-auditable":true}},"required":["label"],"type":"object"},"stream_create_input_request":{"properties":{"defaultCreator":{"$ref":"#/components/schemas/stream_live_input_default_creator"},"deleteRecordingAfterDays":{"$ref":"#/components/schemas/stream_live_input_recording_deletion"},"meta":{"$ref":"#/components/schemas/stream_live_input_metadata"},"recording":{"$ref":"#/components/schemas/stream_live_input_recording_settings"}}},"stream_create_output_request":{"properties":{"enabled":{"$ref":"#/components/schemas/stream_output_enabled"},"streamKey":{"$ref":"#/components/schemas/stream_output_streamKey"},"url":{"$ref":"#/components/schemas/stream_output_url"}},"required":["url","streamKey"]},"stream_created":{"description":"The date and time the media item was created.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string","x-auditable":true},"stream_creator":{"description":"A user-defined identifier for the media creator.","example":"creator-id_abcde12345","maxLength":64,"type":"string","x-auditable":true},"stream_deleted_response":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-single"},{"properties":{"result":{"example":"ok","type":"string"}},"type":"object"}]},"stream_direct_upload_request":{"properties":{"allowedOrigins":{"$ref":"#/components/schemas/stream_allowedOrigins"},"creator":{"$ref":"#/components/schemas/stream_creator"},"expiry":{"default":"Now + 30 minutes","description":"The date and time after upload when videos will not be accepted.","example":"2021-01-02T02:20:00Z","format":"date-time","type":"string","x-auditable":true},"maxDurationSeconds":{"$ref":"#/components/schemas/stream_maxDurationSeconds"},"meta":{"$ref":"#/components/schemas/stream_media_metadata"},"requireSignedURLs":{"$ref":"#/components/schemas/stream_requireSignedURLs"},"scheduledDeletion":{"$ref":"#/components/schemas/stream_scheduledDeletion"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/stream_thumbnailTimestampPct"},"watermark":{"$ref":"#/components/schemas/stream_watermark_at_upload"}},"required":["maxDurationSeconds"],"type":"object"},"stream_direct_upload_response":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-single"},{"properties":{"result":{"properties":{"scheduledDeletion":{"$ref":"#/components/schemas/stream_scheduledDeletion"},"uid":{"$ref":"#/components/schemas/stream_identifier"},"uploadURL":{"description":"The URL an unauthenticated upload can use for a single `HTTP POST multipart/form-data` request.","example":"www.example.com/samplepath","type":"string"},"watermark":{"$ref":"#/components/schemas/stream_watermarks"}},"type":"object"}},"type":"object"}]},"stream_direct_user":{"default":false,"description":"Provisions a URL to let your end users upload videos directly to Cloudflare Stream without exposing your API token to clients.","example":true,"type":"boolean","x-auditable":true},"stream_download_type":{"default":"default","description":"The type of downloads available are: `default`, `audio`.","example":"audio","type":"string","x-auditable":true},"stream_downloadedFrom":{"description":"The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.","example":"https://company.com/logo.png","type":"string","x-auditable":true},"stream_downloads_response":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"stream_duration":{"description":"The duration of the video in seconds. A value of `-1` means the duration is unknown. The duration becomes available after the upload and before the video is ready.","type":"number","x-auditable":true},"stream_editAudioTrack":{"properties":{"default":{"$ref":"#/components/schemas/stream_audio_default"},"label":{"$ref":"#/components/schemas/stream_audio_label"}},"type":"object"},"stream_end":{"description":"Lists videos created before the specified date.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string"},"stream_end_time_seconds":{"description":"Specifies the end time for the video clip in seconds.","type":"integer","x-auditable":true},"stream_errorReasonCode":{"description":"Specifies why the video failed to encode. This field is empty if the video is not in an `error` state. Preferred for programmatic use.","example":"ERR_NON_VIDEO","type":"string","x-auditable":true},"stream_errorReasonText":{"description":"Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an `error` state.","example":"The file was not recognized as a valid video file.","type":"string","x-auditable":true},"stream_generated_caption":{"description":"Whether the caption was generated via AI.","example":true,"type":"boolean","x-auditable":true},"stream_height":{"description":"The height of the image in pixels.","type":"integer","x-auditable":true},"stream_identifier":{"description":"A Cloudflare-generated unique identifier for a media item.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"type":"string","x-auditable":true},"stream_include_counts":{"default":false,"description":"Includes the total number of videos associated with the submitted query parameters.","example":true,"type":"boolean"},"stream_input":{"properties":{"height":{"description":"The video height in pixels. A value of `-1` means the height is unknown. The value becomes available after the upload and before the video is ready.","type":"integer","x-auditable":true},"width":{"description":"The video width in pixels. A value of `-1` means the width is unknown. The value becomes available after the upload and before the video is ready.","type":"integer","x-auditable":true}},"type":"object"},"stream_input_rtmps":{"description":"Details for streaming to an live input using RTMPS.","properties":{"streamKey":{"$ref":"#/components/schemas/stream_input_rtmps_stream_key"},"url":{"$ref":"#/components/schemas/stream_input_rtmps_url"}},"type":"object"},"stream_input_rtmps_stream_key":{"description":"The secret key to use when streaming via RTMPS to a live input.","example":"2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada","type":"string","x-sensitive":true},"stream_input_rtmps_url":{"description":"The RTMPS URL you provide to the broadcaster, which they stream live video to.","example":"rtmps://live.cloudflare.com:443/live/","type":"string","x-sensitive":true},"stream_input_srt":{"description":"Details for streaming to a live input using SRT.","properties":{"passphrase":{"$ref":"#/components/schemas/stream_input_srt_stream_passphrase"},"streamId":{"$ref":"#/components/schemas/stream_input_srt_stream_id"},"url":{"$ref":"#/components/schemas/stream_input_srt_url"}},"type":"object"},"stream_input_srt_stream_id":{"description":"The identifier of the live input to use when streaming via SRT.","example":"f256e6ea9341d51eea64c9454659e576","type":"string","x-auditable":true},"stream_input_srt_stream_passphrase":{"description":"The secret key to use when streaming via SRT to a live input.","example":"2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada","type":"string","x-sensitive":true},"stream_input_srt_url":{"description":"The SRT URL you provide to the broadcaster, which they stream live video to.","example":"srt://live.cloudflare.com:778","type":"string","x-sensitive":true},"stream_input_webrtc":{"description":"Details for streaming to a live input using WebRTC.","properties":{"url":{"$ref":"#/components/schemas/stream_input_webrtc_url"}},"type":"object"},"stream_input_webrtc_url":{"description":"The WebRTC URL you provide to the broadcaster, which they stream live video to.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/publish","type":"string","x-sensitive":true},"stream_jwk":{"description":"The signing key in JWK format.","example":"eyJ1c2UiOiJzaWciLCJrdHkiOiJSU0EiLCJraWQiOiI1MjEzY2ZhMTIxZjcwYjhjMTM4MDY4NmZmYzM3MWJhMyIsImFsZyI6IlJTMjU2IiwibiI6IjBUandqT2laV21KNDN2ZjNUbzREb1htWFd0SkdOR3lYZmh5dHRMYUJnRjEtRVFXUURLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMtbFlSWW95ckFHRjRBWGh5MzI5YkhDUDFJbHJCQl9Ba0dnbmRMQWd1bnhZMHJSZ2N2T3ppYXc2S0p4Rm5jMlVLMFdVOGIwcDRLS0hHcDFLTDlkazBXVDhkVllxYmVSaUpqQ2xVRW1oOHl2OUNsT1ZhUzRLeGlYNnhUUTREWnc2RGFKZklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWi1peFdmY1RETUg5MnNHdm93MURPanhMaUNOMXpISy1oN2JMb1hUaUxnYzRrdyIsImUiOiJBUUFCIiwiZCI6IndpQWEwaU5mWnNYSGNOcVMxSWhnUmdzVHJHay1TcFlYV2lReDZHTU9kWlJKekhGazN0bkRERFJvNHNKZTBxX0dEOWkzNlEyZkVadS15elpEcEJkc3U5OHNtaHhNU19Ta0s5X3VFYUo1Zm96V2IyN3JRRnFoLVliUU9MUThkUnNPRHZmQl9Hb2txWWJzblJDR3kzWkFaOGZJZ25ocXBUNEpiOHdsaWxpMUgxeFpzM3RnTWtkTEluTm1yMFAtcTYxZEtNd3JYZVRoSWNEc0kyb2Z1LTFtRm1MWndQb2ZGbmxaTW9QN1pfRU5pUGNfWGtWNzFhaHBOZE9pcW5ablZtMHBCNE5QS1UweDRWTjQyYlAzWEhMUmpkV2hJOGt3SC1BdXhqb3BLaHJ0R2tvcG1jZFRkM1ZRdElaOGRpZHByMXpBaEpvQi16ZVlIaTFUel9ZSFFld0FRUSIsInAiOiIyVTZFVUJka3U3TndDYXoyNzZuWGMxRXgwVHpNZjU4U0UtU2M2eUNaYWk2TkwzVURpWi1mNHlIdkRLYnFGUXdLWDNwZ0l2aVE3Y05QYUpkbE9NeS1mU21GTXU3V3hlbVZYamFlTjJCMkRDazhQY0NEOVgxU2hhR3E1ZUdSSHNObVUtSDNxTG1FRGpjLWliazRHZ0RNb2lVYjQ2OGxFZHAwU2pIOXdsOUdsYTgiLCJxIjoiOW5ucXg5ZnNNY2dIZ29DemhfVjJmaDhoRUxUSUM5aFlIOVBCTG9aQjZIaE1TWG1ja1BSazVnUlpPWlFEN002TzlMaWZjNmFDVXdEbjBlQzU2YkFDNUNrcWxjODJsVDhzTWlMeWJyTjh3bWotcjNjSTBGQTlfSGQySEY1ZkgycnJmenVqd0NWM3czb09Ud3p4d1g3c2xKbklRanphel91SzEyWEtucVZZcUYwIiwiZHAiOiJxQklTUTlfVUNWaV9Ucng0UU9VYnZoVU9jc2FUWkNHajJiNzNudU9YeElnOHFuZldSSnN4RG5zd2FKaXdjNWJjYnZ3M1h0VGhRd1BNWnhpeE1UMHFGNlFGWVY5WXZibnJ6UEp4YkdNdTZqajZYc2lIUjFlbWU3U09lVDM4Xzg0aFZyOXV6UkN2RWstb0R0MHlodW9YVzFGWVFNRTE2cGtMV0ZkUjdRUERsQUUiLCJkcSI6Im5zQUp3eXZFbW8tdW5wU01qYjVBMHB6MExCRjBZNFMxeGRJYXNfLVBSYzd0dThsVFdWMl8teExEOFR6dmhqX0lmY0RJR3JJZGNKNjlzVVZnR1M3ZnZkcng3Y21uNjFyai1XcmU0UVJFRC1lV1dxZDlpc2FVRmg5UGVKZ2tCbFZVVnYtdnladVlWdFF2a1NUU05ZR3RtVXl2V2xKZDBPWEFHRm9jdGlfak9aVSIsInFpIjoib0dYaWxLQ2NKRXNFdEE1eG54WUdGQW5UUjNwdkZLUXR5S0F0UGhHaHkybm5ya2VzN1RRaEFxMGhLRWZtU1RzaE1hNFhfd05aMEstX1F0dkdoNDhpeHdTTDVLTEwxZnFsY0k2TF9XUnF0cFQxS21LRERlUHR2bDVCUzFGbjgwSGFwR215cmZRWUU4S09QR2UwUl82S1BOZE1vc3dYQ3Nfd0RYMF92ZzNoNUxRIn0=","type":"string","x-sensitive":true},"stream_key_generation_response":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/stream_keys"}},"type":"object"}]},"stream_key_response_collection":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-common"},{"properties":{"result":{"items":{"properties":{"created":{"$ref":"#/components/schemas/stream_signing_key_created"},"id":{"$ref":"#/components/schemas/stream_schemas-identifier"}},"type":"object"},"type":"array"}},"type":"object"}]},"stream_keys":{"properties":{"created":{"$ref":"#/components/schemas/stream_signing_key_created"},"id":{"$ref":"#/components/schemas/stream_schemas-identifier"},"jwk":{"$ref":"#/components/schemas/stream_jwk"},"pem":{"$ref":"#/components/schemas/stream_pem"}},"type":"object"},"stream_label":{"description":"The language label displayed in the native language to users.","example":"Türkçe","type":"string","x-auditable":true},"stream_language":{"description":"The language tag in BCP 47 format.","example":"tr","type":"string","x-auditable":true},"stream_language_response_collection":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/stream_captions"},"type":"array"}},"type":"object"}]},"stream_language_response_single":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/stream_captions"}},"type":"object"}]},"stream_listAudioTrackResponse":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/stream_additionalAudio"},"type":"array"}},"type":"object"}]},"stream_liveInput":{"description":"The live input ID used to upload a video with Stream Live.","example":"fc0a8dc887b16759bfd9ad922230a014","maxLength":32,"type":"string","x-auditable":true},"stream_live_input":{"description":"Details about a live input.","properties":{"created":{"$ref":"#/components/schemas/stream_live_input_created"},"deleteRecordingAfterDays":{"$ref":"#/components/schemas/stream_live_input_recording_deletion"},"meta":{"$ref":"#/components/schemas/stream_live_input_metadata"},"modified":{"$ref":"#/components/schemas/stream_live_input_modified"},"recording":{"$ref":"#/components/schemas/stream_live_input_recording_settings"},"rtmps":{"$ref":"#/components/schemas/stream_input_rtmps"},"rtmpsPlayback":{"$ref":"#/components/schemas/stream_playback_rtmps"},"srt":{"$ref":"#/components/schemas/stream_input_srt"},"srtPlayback":{"$ref":"#/components/schemas/stream_playback_srt"},"status":{"$ref":"#/components/schemas/stream_live_input_status"},"uid":{"$ref":"#/components/schemas/stream_live_input_identifier"},"webRTC":{"$ref":"#/components/schemas/stream_input_webrtc"},"webRTCPlayback":{"$ref":"#/components/schemas/stream_playback_webrtc"}},"type":"object"},"stream_live_input_created":{"description":"The date and time the live input was created.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string","x-auditable":true},"stream_live_input_default_creator":{"description":"Sets the creator ID asssociated with this live input.","type":"string","x-auditable":true},"stream_live_input_identifier":{"description":"A unique identifier for a live input.","example":"66be4bf738797e01e1fca35a7bdecdcd","maxLength":32,"type":"string","x-auditable":true},"stream_live_input_metadata":{"description":"A user modifiable key-value store used to reference other systems of record for managing live inputs.","example":{"name":"test stream 1"},"type":"object"},"stream_live_input_modified":{"description":"The date and time the live input was last modified.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string","x-auditable":true},"stream_live_input_object_without_url":{"properties":{"created":{"$ref":"#/components/schemas/stream_live_input_created"},"deleteRecordingAfterDays":{"$ref":"#/components/schemas/stream_live_input_recording_deletion"},"meta":{"$ref":"#/components/schemas/stream_live_input_metadata"},"modified":{"$ref":"#/components/schemas/stream_live_input_modified"},"uid":{"$ref":"#/components/schemas/stream_live_input_identifier"}}},"stream_live_input_recording_allowedOrigins":{"description":"Lists the origins allowed to display videos created with this input. Enter allowed origin domains in an array and use `*` for wildcard subdomains. An empty array allows videos to be viewed on any origin.","example":["example.com"],"items":{"type":"string","x-auditable":true},"type":"array"},"stream_live_input_recording_deletion":{"description":"Indicates the number of days after which the live inputs recordings will be deleted. When a stream completes and the recording is ready, the value is used to calculate a scheduled deletion date for that recording. Omit the field to indicate no change, or include with a `null` value to remove an existing scheduled deletion.","example":45,"minimum":30,"type":"number","x-auditable":true},"stream_live_input_recording_hideLiveViewerCount":{"default":false,"description":"Disables reporting the number of live viewers when this property is set to `true`.","example":true,"type":"boolean","x-auditable":true},"stream_live_input_recording_mode":{"default":"off","description":"Specifies the recording behavior for the live input. Set this value to `off` to prevent a recording. Set the value to `automatic` to begin a recording and transition to on-demand after Stream Live stops receiving input.","enum":["off","automatic"],"example":"automatic","type":"string","x-auditable":true},"stream_live_input_recording_requireSignedURLs":{"default":false,"description":"Indicates if a video using the live input has the `requireSignedURLs` property set. Also enforces access controls on any video recording of the livestream with the live input.","example":true,"type":"boolean","x-auditable":true},"stream_live_input_recording_settings":{"description":"Records the input to a Cloudflare Stream video. Behavior depends on the mode. In most cases, the video will initially be viewable as a live video and transition to on-demand after a condition is satisfied.","example":{"hideLiveViewerCount":false,"mode":"off","requireSignedURLs":false,"timeoutSeconds":0},"properties":{"allowedOrigins":{"$ref":"#/components/schemas/stream_live_input_recording_allowedOrigins"},"hideLiveViewerCount":{"$ref":"#/components/schemas/stream_live_input_recording_hideLiveViewerCount"},"mode":{"$ref":"#/components/schemas/stream_live_input_recording_mode"},"requireSignedURLs":{"$ref":"#/components/schemas/stream_live_input_recording_requireSignedURLs"},"timeoutSeconds":{"$ref":"#/components/schemas/stream_live_input_recording_timeoutSeconds"}},"type":"object"},"stream_live_input_recording_timeoutSeconds":{"default":0,"description":"Determines the amount of time a live input configured in `automatic` mode should wait before a recording transitions from live to on-demand. `0` is recommended for most use cases and indicates the platform default should be used.","type":"integer","x-auditable":true},"stream_live_input_response_collection":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-common"},{"properties":{"result":{"properties":{"liveInputs":{"items":{"$ref":"#/components/schemas/stream_live_input_object_without_url"},"type":"array"},"range":{"description":"The total number of remaining live inputs based on cursor position.","example":1000,"type":"integer"},"total":{"description":"The total number of live inputs that match the provided filters.","example":35586,"type":"integer"}},"type":"object"}},"type":"object"}]},"stream_live_input_response_single":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/stream_live_input"}},"type":"object"}]},"stream_live_input_status":{"description":"The connection status of a live input.","enum":[null,"connected","reconnected","reconnecting","client_disconnect","ttl_exceeded","failed_to_connect","failed_to_reconnect","new_configuration_accepted"],"nullable":true,"type":"string","x-auditable":true},"stream_maxDurationSeconds":{"description":"The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of `-1` means the value is unknown.","maximum":36000,"minimum":1,"type":"integer","x-auditable":true},"stream_media_metadata":{"description":"A user modifiable key-value store used to reference other systems of record for managing videos.","example":{"name":"video12345.mp4"},"type":"object"},"stream_media_state":{"description":"Specifies the processing status for all quality levels for a video.","enum":["pendingupload","downloading","queued","inprogress","ready","error","live-inprogress"],"example":"inprogress","type":"string","x-auditable":true},"stream_media_status":{"description":"Specifies a detailed status for a video. If the `state` is `inprogress` or `error`, the `step` field returns `encoding` or `manifest`. If the `state` is `inprogress`, `pctComplete` returns a number between 0 and 100 to indicate the approximate percent of completion. If the `state` is `error`, `errorReasonCode` and `errorReasonText` provide additional details.","properties":{"errorReasonCode":{"$ref":"#/components/schemas/stream_errorReasonCode"},"errorReasonText":{"$ref":"#/components/schemas/stream_errorReasonText"},"pctComplete":{"$ref":"#/components/schemas/stream_pctComplete"},"state":{"$ref":"#/components/schemas/stream_media_state"}}},"stream_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"stream_modified":{"description":"The date and time the media item was last modified.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string","x-auditable":true},"stream_name":{"default":"","description":"A short description of the watermark profile.","example":"Marketing Videos","type":"string","x-auditable":true},"stream_notificationUrl":{"description":"The URL where webhooks will be sent.","example":"https://example.com","format":"uri","type":"string","x-auditable":true},"stream_oneTimeUploadExpiry":{"description":"The date and time when the video upload URL is no longer valid for direct user uploads.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string","x-auditable":true},"stream_opacity":{"default":1,"description":"The translucency of the image. A value of `0.0` makes the image completely transparent, and `1.0` makes the image completely opaque. Note that if the image is already semi-transparent, setting this to `1.0` will not make the image completely opaque.","example":0.75,"maximum":1,"minimum":0,"type":"number","x-auditable":true},"stream_output":{"properties":{"enabled":{"$ref":"#/components/schemas/stream_output_enabled"},"streamKey":{"$ref":"#/components/schemas/stream_output_streamKey"},"uid":{"$ref":"#/components/schemas/stream_output_identifier"},"url":{"$ref":"#/components/schemas/stream_output_url"}}},"stream_output_enabled":{"default":true,"description":"When enabled, live video streamed to the associated live input will be sent to the output URL. When disabled, live video will not be sent to the output URL, even when streaming to the associated live input. Use this to control precisely when you start and stop simulcasting to specific destinations like YouTube and Twitch.","example":true,"type":"boolean","x-auditable":true},"stream_output_identifier":{"description":"A unique identifier for the output.","example":"baea4d9c515887b80289d5c33cf01145","maxLength":32,"type":"string","x-auditable":true},"stream_output_response_collection":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/stream_output"},"type":"array"}},"type":"object"}]},"stream_output_response_single":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/stream_output"}},"type":"object"}]},"stream_output_streamKey":{"description":"The streamKey used to authenticate against an output's target.","example":"uzya-f19y-g2g9-a2ee-51j2","type":"string","x-sensitive":true},"stream_output_url":{"description":"The URL an output uses to restream.","example":"rtmp://a.rtmp.youtube.com/live2","type":"string","x-sensitive":true},"stream_padding":{"default":0.05,"description":"The whitespace between the adjacent edges (determined by position) of the video and the image. `0.0` indicates no padding, and `1.0` indicates a fully padded video width or length, as determined by the algorithm.","example":0.1,"maximum":1,"minimum":0,"type":"number","x-auditable":true},"stream_pctComplete":{"description":"Indicates the size of the entire upload in bytes. The value must be a non-negative integer.","maximum":100,"minimum":0,"type":"string","x-auditable":true},"stream_pem":{"description":"The signing key in PEM format.","example":"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcGdJQkFBS0NBUUVBMFRqd2pPaVpXbUo0M3ZmM1RvNERvWG1YV3RKR05HeVhmaHl0dExhQmdGMStFUVdRCkRLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMrbFkKUllveXJBR0Y0QVhoeTMyOWJIQ1AxSWxyQkIvQWtHZ25kTEFndW54WTByUmdjdk96aWF3NktKeEZuYzJVSzBXVQo4YjBwNEtLSEdwMUtMOWRrMFdUOGRWWXFiZVJpSmpDbFVFbWg4eXY5Q2xPVmFTNEt4aVg2eFRRNERadzZEYUpmCklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWitpeFdmY1QKRE1IOTJzR3ZvdzFET2p4TGlDTjF6SEsraDdiTG9YVGlMZ2M0a3dJREFRQUJBb0lCQVFEQ0lCclNJMTlteGNkdwoycExVaUdCR0N4T3NhVDVLbGhkYUpESG9ZdzUxbEVuTWNXVGUyY01NTkdqaXdsN1NyOFlQMkxmcERaOFJtNzdMCk5rT2tGMnk3M3l5YUhFeEw5S1FyMys0Um9ubCtqTlp2YnV0QVdxSDVodEE0dER4MUd3NE85OEg4YWlTcGh1eWQKRUliTGRrQm54OGlDZUdxbFBnbHZ6Q1dLV0xVZlhGbXplMkF5UjBzaWMyYXZRLzZyclYwb3pDdGQ1T0Vod093agphaCs3N1dZV1l0bkEraDhXZVZreWcvdG44UTJJOXo5ZVJYdlZxR2sxMDZLcWRtZFdiU2tIZzA4cFRUSGhVM2paCnMvZGNjdEdOMWFFanlUQWY0QzdHT2lrcUd1MGFTaW1aeDFOM2RWQzBobngySjJtdlhNQ0VtZ0g3TjVnZUxWUFAKOWdkQjdBQkJBb0dCQU5sT2hGQVhaTHV6Y0Ftczl1K3AxM05STWRFOHpIK2ZFaFBrbk9zZ21Xb3VqUzkxQTRtZgpuK01oN3d5bTZoVU1DbDk2WUNMNGtPM0RUMmlYWlRqTXZuMHBoVEx1MXNYcGxWNDJuamRnZGd3cFBEM0FnL1Y5ClVvV2hxdVhoa1I3RFpsUGg5Nmk1aEE0M1BvbTVPQm9BektJbEcrT3ZKUkhhZEVveC9jSmZScFd2QW9HQkFQWjUKNnNmWDdESElCNEtBczRmMWRuNGZJUkMweUF2WVdCL1R3UzZHUWVoNFRFbDVuSkQwWk9ZRVdUbVVBK3pPanZTNApuM09tZ2xNQTU5SGd1ZW13QXVRcEtwWFBOcFUvTERJaThtNnpmTUpvL3E5M0NOQlFQZngzZGh4ZVh4OXE2Mzg3Cm84QWxkOE42RGs4TThjRis3SlNaeUVJODJzLzdpdGRseXA2bFdLaGRBb0dCQUtnU0VrUGYxQWxZdjA2OGVFRGwKRzc0VkRuTEdrMlFobzltKzk1N2psOFNJUEtwMzFrU2JNUTU3TUdpWXNIT1czRzc4TjE3VTRVTUR6R2NZc1RFOQpLaGVrQldGZldMMjU2OHp5Y1d4akx1bzQrbDdJaDBkWHBudTBqbms5L1AvT0lWYS9iczBRcnhKUHFBN2RNb2JxCkYxdFJXRURCTmVxWkMxaFhVZTBEdzVRQkFvR0JBSjdBQ2NNcnhKcVBycDZVakkyK1FOS2M5Q3dSZEdPRXRjWFMKR3JQL2owWE83YnZKVTFsZHYvc1N3L0U4NzRZL3lIM0F5QnF5SFhDZXZiRkZZQmt1MzczYThlM0pwK3RhNC9scQozdUVFUkEvbmxscW5mWXJHbEJZZlQzaVlKQVpWVkZiL3I4bWJtRmJVTDVFazBqV0JyWmxNcjFwU1hkRGx3QmhhCkhMWXY0em1WQW9HQkFLQmw0cFNnbkNSTEJMUU9jWjhXQmhRSjAwZDZieFNrTGNpZ0xUNFJvY3RwNTY1SHJPMDAKSVFLdElTaEg1a2s3SVRHdUYvOERXZEN2djBMYnhvZVBJc2NFaStTaXk5WDZwWENPaS8xa2FyYVU5U3BpZ3czago3YjVlUVV0UlovTkIycVJwc3EzMEdCUENqanhudEVmK2lqelhUS0xNRndyUDhBMTlQNzRONGVTMAotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=","type":"string","x-sensitive":true},"stream_playback":{"properties":{"dash":{"description":"DASH Media Presentation Description for the video.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd","type":"string","x-auditable":true},"hls":{"description":"The HLS manifest for the video.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8","type":"string","x-auditable":true}},"type":"object"},"stream_playback_rtmps":{"description":"Details for playback from an live input using RTMPS.","properties":{"streamKey":{"$ref":"#/components/schemas/stream_playback_rtmps_stream_key"},"url":{"$ref":"#/components/schemas/stream_playback_rtmps_url"}},"type":"object"},"stream_playback_rtmps_stream_key":{"description":"The secret key to use for playback via RTMPS.","example":"2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada","type":"string","x-sensitive":true},"stream_playback_rtmps_url":{"description":"The URL used to play live video over RTMPS.","example":"rtmps://live.cloudflare.com:443/live/","type":"string","x-sensitive":true},"stream_playback_srt":{"description":"Details for playback from an live input using SRT.","properties":{"passphrase":{"$ref":"#/components/schemas/stream_playback_srt_stream_passphrase"},"streamId":{"$ref":"#/components/schemas/stream_playback_srt_stream_id"},"url":{"$ref":"#/components/schemas/stream_playback_srt_url"}},"type":"object"},"stream_playback_srt_stream_id":{"description":"The identifier of the live input to use for playback via SRT.","example":"f256e6ea9341d51eea64c9454659e576","type":"string","x-auditable":true},"stream_playback_srt_stream_passphrase":{"description":"The secret key to use for playback via SRT.","example":"2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada","type":"string","x-sensitive":true},"stream_playback_srt_url":{"description":"The URL used to play live video over SRT.","example":"rtmps://live.cloudflare.com:443/live/","type":"string","x-sensitive":true},"stream_playback_webrtc":{"description":"Details for playback from a live input using WebRTC.","properties":{"url":{"$ref":"#/components/schemas/stream_playback_webrtc_url"}},"type":"object"},"stream_playback_webrtc_url":{"description":"The URL used to play live video over WebRTC.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/play","type":"string","x-sensitive":true},"stream_position":{"default":"upperRight","description":"The location of the image. Valid positions are: `upperRight`, `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the `padding` parameter.","example":"center","type":"string","x-auditable":true},"stream_preview":{"description":"The video's preview page URI. This field is omitted until encoding is complete.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch","format":"uri","type":"string","x-auditable":true},"stream_readyToStream":{"description":"Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.","example":true,"type":"boolean","x-auditable":true},"stream_readyToStreamAt":{"description":"Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string","x-auditable":true},"stream_requireSignedURLs":{"default":false,"description":"Indicates whether the video can be a accessed using the UID. When set to `true`, a signed token must be generated with a signing key to view the video.","example":true,"type":"boolean","x-auditable":true},"stream_scale":{"default":0.15,"description":"The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. `0.0` indicates no scaling (use the size of the image as-is), and `1.0 `fills the entire video.","example":0.1,"maximum":1,"minimum":0,"type":"number","x-auditable":true},"stream_scheduledDeletion":{"description":"Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a `null` value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string","x-auditable":true},"stream_schemas-identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"stream_search":{"description":"Provides a partial word match of the `name` key in the `meta` field. Slow for medium to large video libraries. May be unavailable for very large libraries.","example":"puppy.mp4","type":"string","x-auditable":true},"stream_signed_token_request":{"properties":{"accessRules":{"description":"The optional list of access rule constraints on the token. Access can be blocked or allowed based on an IP, IP range, or by country. Access rules are evaluated from first to last. If a rule matches, the associated action is applied and no further rules are evaluated.","example":[{"action":"block","country":["US","MX"],"type":"ip.geoip.country"},{"action":"allow","ip":["93.184.216.0/24","2400:cb00::/32"],"type":"ip.src"},{"action":"block","type":"any"}],"items":{"$ref":"#/components/schemas/stream_accessRules"},"type":"array"},"downloadable":{"default":false,"description":"The optional boolean value that enables using signed tokens to access MP4 download links for a video.","type":"boolean","x-auditable":true},"exp":{"description":"The optional unix epoch timestamp that specficies the time after a token is not accepted. The maximum time specification is 24 hours from issuing time. If this field is not set, the default is one hour after issuing.","type":"integer"},"id":{"description":"The optional ID of a Stream signing key. If present, the `pem` field is also required.","example":"ab0d4ef71g4425f8dcba9041231813000","type":"string","x-auditable":true},"nbf":{"description":"The optional unix epoch timestamp that specifies the time before a the token is not accepted. If this field is not set, the default is one hour before issuing.","type":"integer","x-auditable":true},"pem":{"description":"The optional base64 encoded private key in PEM format associated with a Stream signing key. If present, the `id` field is also required.","example":"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcEFJQkFBS0NBUUVBc284dnBvOFpEWXRkOUgzbWlPaW1qYXAzVXlVM0oyZ3kwTUYvN1R4blJuRnkwRHpDCkxqUk9naFZsQ0hPQmxsd3NVaE9GU0lyYnN4K05tUTdBeS90TFpXSGxuVGF3UWJ5WGZGOStJeDhVSnNlSHBGV1oKNVF5Z1JYd2liSjh1MVVsZ2xlcmZHMkpueldjVXpZTzEySktZN3doSkw1ajROMWgxZFJNUXQ5Q1pkZFlCQWRzOQpCdk02cjRFMDcxQkhQekhWeDMrUTI1VWtubGdUNXIwS3FiM1E1Y0dlTlBXY1JreW1ybkJEWWR0OXR4eFFMb1dPCllzNXdsMnVYWFVYL0VGcDMwajU0Nmp6czllWExLYlNDbjJjTDZFVE96Y2x3aG9DRGx2a2VQT05rUE9LMDVKNUMKTm1TdFdhMG9hV1VGRzM0MFl3cVVrWGt4OU9tNndXd1JldU1uU1FJREFRQUJBb0lCQUFJOHo1ck5kOEdtOGJBMgo1S3pxQjI1R2lOVENwbUNJeW53NXRJWHZTQmNHcEdydUcvdlN2WG9kVlFVSVY0TWdHQkVXUEFrVzdsNWVBcHI4CnA1ZFd5SkRXYTNkdklFSE9vSEpYU3dBYksxZzZEMTNVa2NkZ1EyRGpoNVhuWDhHZCtBY2c2SmRTQWgxOWtYSHEKMk54RUtBVDB6Ri83a1g2MkRkREFBcWxmQkpGSXJodVIvZUdEVWh4L2piTTRhQ2JCcFdiM0pnRE9OYm5tS1ZoMwpxS2ZwZmRZZENZU1lzWUxrNTlxRDF2VFNwUVFUQ0VadW9VKzNzRVNhdkJzaUs1bU0vTzY5ZkRMRXNURG1MeTVQCmhEK3BMQXI0SlhNNjFwRGVBS0l3cUVqWWJybXlDRHRXTUdJNnZzZ0E1eXQzUUJaME9vV2w5QUkwdWxoZ3p4dXQKZ2ZFNTRRRUNnWUVBN0F3a0lhVEEzYmQ4Nk9jSVZnNFlrWGk1cm5aNDdsM1k4V24zcjIzUmVISXhLdkllRUtSbgp5bUlFNDFtRVBBSmlGWFpLK1VPTXdkeS9EcnFJUithT1JiT2NiV01jWUg2QzgvbG1wdVJFaXE3SW1Ub3VWcnA4CnlnUkprMWprVDA4cTIvNmg4eTBEdjJqMitsaHFXNzRNOUt0cmwxcTRlWmZRUFREL01tR1NnTWtDZ1lFQXdhY04KaSttN1p6dnJtL3NuekF2VlZ5SEtwZHVUUjNERk1naC9maC9tZ0ZHZ1RwZWtUOVV5b3FleGNYQXdwMVlhL01iQQoyNTVJVDZRbXZZTm5yNXp6Wmxic2tMV0hsYllvbWhmWnVXTHhXR3hRaEFORWdaMFVVdUVTRGMvbWx2UXZHbEtSCkZoaGhBUWlVSmdDamhPaHk1SlBiNGFldGRKd0UxK09lVWRFaE1vRUNnWUVBNG8yZ25CM1o4ck5xa3NzemlBek4KYmNuMlJVbDJOaW9pejBwS3JMaDFaT29NNE5BekpQdjJsaHRQMzdtS0htS1hLMHczRjFqTEgwSTBxZmxFVmVZbQpSU1huakdHazJjUnpBYUVzOGgrQzNheDE0Z01pZUtGU3BqNUpNOEFNbVVZOXQ1cUVhN2FYc3o0V1ZoOUlMYmVTCkRiNzlhKzVwd21LQVBrcnBsTHhyZFdrQ2dZQlNNSHVBWVdBbmJYZ1BDS2FZWklGVWJNUWNacmY0ZnpWQ2lmYksKYWZHampvRlNPZXdEOGdGK3BWdWJRTGwxbkFieU44ek1xVDRaaHhybUhpcFlqMjJDaHV2NmN3RXJtbGRiSnpwQwpBMnRaVXdkTk1ESFlMUG5lUHlZeGRJWnlsUXFVeW14SGkydElUQUxNcWtLOGV3ZWdXZHpkeGhQSlJScU5JazhrCmZIVHhnUUtCZ1FEUFc2UXIxY3F3QjNUdnVWdWR4WGRqUTdIcDFodXhrNEVWaEFJZllKNFhSTW1NUE5YS28wdHUKdUt6LzE0QW14R0dvSWJxYVc1bDMzeFNteUxhem84clNUN0tSTjVKME9JSHcrZkR5SFgxdHpVSjZCTldDcEFTcwpjbWdNK0htSzVON0w2bkNaZFJQY2IwU1hGaVRQUGhCUG1PVWFDUnpER0ZMK2JYM1VwajJKbWc9PQotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=","type":"string","x-sensitive":true}},"type":"object"},"stream_signed_token_response":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-single"},{"properties":{"result":{"properties":{"token":{"description":"The signed token used with the signed URLs feature.","example":"eyJhbGciOiJSUzI1NiIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIn0.eyJzdWIiOiJlYTk1MTMyYzE1NzMyNDEyZDIyYzE0NzZmYTgzZjI3YSIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIiwiZXhwIjoiMTUzNzQ2MDM2NSIsIm5iZiI6IjE1Mzc0NTMxNjUifQ.OZhqOARADn1iubK6GKcn25hN3nU-hCFF5q9w2C4yup0C4diG7aMIowiRpP-eDod8dbAJubsiFuTKrqPcmyCKWYsiv0TQueukqbQlF7HCO1TV-oF6El5-7ldJ46eD-ZQ0XgcIYEKrQOYFF8iDQbqPm3REWd6BnjKZdeVrLzuRaiSnZ9qqFpGu5dfxIY9-nZKDubJHqCr3Imtb211VIG_b9MdtO92JjvkDS-rxT_pkEfTZSafl1OU-98A7KBGtPSJHz2dHORIrUiTA6on4eIXTj9aFhGiir4rSn-rn0OjPRTtJMWIDMoQyE_fwrSYzB7MPuzL2t82BWaEbHZTfixBm5A","type":"string","x-sensitive":true}},"type":"object"}},"type":"object"}]},"stream_signing_key_created":{"description":"The date and time a signing key was created.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string","x-auditable":true},"stream_size":{"description":"The size of the media item in bytes.","example":4190963,"type":"number","x-auditable":true},"stream_start":{"description":"Lists videos created after the specified date.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string"},"stream_start_time_seconds":{"description":"Specifies the start time for the video clip in seconds.","type":"integer","x-auditable":true},"stream_storage_use_response":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-single"},{"properties":{"result":{"properties":{"creator":{"$ref":"#/components/schemas/stream_creator"},"totalStorageMinutes":{"description":"The total minutes of video content stored in the account.","type":"integer"},"totalStorageMinutesLimit":{"description":"The storage capacity alloted for the account.","type":"integer"},"videoCount":{"description":"The total count of videos associated with the account.","type":"integer"}},"type":"object"}},"type":"object"}]},"stream_thumbnailTimestampPct":{"default":0,"description":"The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video.  If this value is not set, the default thumbnail image is taken from 0s of the video.","example":0.529241,"maximum":1,"minimum":0,"type":"number","x-auditable":true},"stream_thumbnail_url":{"description":"The media item's thumbnail URI. This field is omitted until encoding is complete.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg","format":"uri","type":"string","x-auditable":true},"stream_tus_resumable":{"description":"Specifies the TUS protocol version. This value must be included in every upload request.\nNotes: The only supported version of TUS protocol is 1.0.0.","enum":["1.0.0"],"example":"1.0.0","type":"string","x-auditable":true},"stream_type":{"description":"Specifies whether the video is `vod` or `live`.","example":"live","type":"string","x-auditable":true},"stream_update_input_request":{"properties":{"defaultCreator":{"$ref":"#/components/schemas/stream_live_input_default_creator"},"deleteRecordingAfterDays":{"$ref":"#/components/schemas/stream_live_input_recording_deletion"},"meta":{"$ref":"#/components/schemas/stream_live_input_metadata"},"recording":{"$ref":"#/components/schemas/stream_live_input_recording_settings"}}},"stream_update_output_request":{"properties":{"enabled":{"$ref":"#/components/schemas/stream_output_enabled"}},"required":["enabled"]},"stream_upload_length":{"description":"Indicates the size of the entire upload in bytes. The value must be a non-negative integer.","minimum":0,"type":"integer","x-auditable":true},"stream_upload_metadata":{"description":"Comma-separated key-value pairs following the TUS protocol specification. Values are Base-64 encoded.\nSupported keys: `name`, `requiresignedurls`, `allowedorigins`, `thumbnailtimestamppct`, `watermark`, `scheduleddeletion`, `maxdurationseconds`.","example":"name aGVsbG8gd29ybGQ=, requiresignedurls, allowedorigins ZXhhbXBsZS5jb20sdGVzdC5jb20=","type":"string","x-auditable":true},"stream_uploaded":{"description":"The date and time the media item was uploaded.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string","x-auditable":true},"stream_videoClipStandard":{"properties":{"allowedOrigins":{"$ref":"#/components/schemas/stream_allowedOrigins"},"clippedFromVideoUID":{"$ref":"#/components/schemas/stream_clipped_from_video_uid"},"creator":{"$ref":"#/components/schemas/stream_creator"},"endTimeSeconds":{"$ref":"#/components/schemas/stream_end_time_seconds"},"maxDurationSeconds":{"$ref":"#/components/schemas/stream_maxDurationSeconds"},"requireSignedURLs":{"$ref":"#/components/schemas/stream_requireSignedURLs"},"startTimeSeconds":{"$ref":"#/components/schemas/stream_start_time_seconds"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/stream_thumbnailTimestampPct"},"watermark":{"$ref":"#/components/schemas/stream_watermarkAtUpload"}},"required":["clippedFromVideoUID","startTimeSeconds","endTimeSeconds"],"type":"object"},"stream_video_copy_request":{"properties":{"allowedOrigins":{"$ref":"#/components/schemas/stream_allowedOrigins"},"creator":{"$ref":"#/components/schemas/stream_creator"},"meta":{"$ref":"#/components/schemas/stream_media_metadata"},"requireSignedURLs":{"$ref":"#/components/schemas/stream_requireSignedURLs"},"scheduledDeletion":{"$ref":"#/components/schemas/stream_scheduledDeletion"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/stream_thumbnailTimestampPct"},"url":{"description":"A video's URL. The server must be publicly routable and support `HTTP HEAD` requests and `HTTP GET` range requests. The server should respond to `HTTP HEAD` requests with a `content-range` header that includes the size of the file.","example":"https://example.com/myvideo.mp4","format":"uri","type":"string"},"watermark":{"$ref":"#/components/schemas/stream_watermark_at_upload"}},"required":["url"]},"stream_video_name":{"description":"Provides a fast, exact string match on the `name` key in the `meta` field.","example":"puppy.mp4","type":"string","x-auditable":true},"stream_video_response_collection":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/stream_videos"},"type":"array"}},"type":"object"},{"properties":{"range":{"description":"The total number of remaining videos based on cursor position.","example":1000,"type":"integer"},"total":{"description":"The total number of videos that match the provided filters.","example":35586,"type":"integer"}},"type":"object"}]},"stream_video_response_single":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/stream_videos"}},"type":"object"}]},"stream_video_update":{"properties":{"allowedOrigins":{"$ref":"#/components/schemas/stream_allowedOrigins"},"creator":{"$ref":"#/components/schemas/stream_creator"},"maxDurationSeconds":{"$ref":"#/components/schemas/stream_maxDurationSeconds"},"meta":{"$ref":"#/components/schemas/stream_media_metadata"},"requireSignedURLs":{"$ref":"#/components/schemas/stream_requireSignedURLs"},"scheduledDeletion":{"$ref":"#/components/schemas/stream_scheduledDeletion"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/stream_thumbnailTimestampPct"},"uploadExpiry":{"$ref":"#/components/schemas/stream_oneTimeUploadExpiry"}},"type":"object"},"stream_videos":{"properties":{"allowedOrigins":{"$ref":"#/components/schemas/stream_allowedOrigins"},"created":{"$ref":"#/components/schemas/stream_created"},"creator":{"$ref":"#/components/schemas/stream_creator"},"duration":{"$ref":"#/components/schemas/stream_duration"},"input":{"$ref":"#/components/schemas/stream_input"},"liveInput":{"$ref":"#/components/schemas/stream_liveInput"},"maxDurationSeconds":{"$ref":"#/components/schemas/stream_maxDurationSeconds"},"meta":{"$ref":"#/components/schemas/stream_media_metadata"},"modified":{"$ref":"#/components/schemas/stream_modified"},"playback":{"$ref":"#/components/schemas/stream_playback"},"preview":{"$ref":"#/components/schemas/stream_preview"},"readyToStream":{"$ref":"#/components/schemas/stream_readyToStream"},"readyToStreamAt":{"$ref":"#/components/schemas/stream_readyToStreamAt"},"requireSignedURLs":{"$ref":"#/components/schemas/stream_requireSignedURLs"},"scheduledDeletion":{"$ref":"#/components/schemas/stream_scheduledDeletion"},"size":{"$ref":"#/components/schemas/stream_size"},"status":{"$ref":"#/components/schemas/stream_media_status"},"thumbnail":{"$ref":"#/components/schemas/stream_thumbnail_url"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/stream_thumbnailTimestampPct"},"uid":{"$ref":"#/components/schemas/stream_identifier"},"uploadExpiry":{"$ref":"#/components/schemas/stream_oneTimeUploadExpiry"},"uploaded":{"$ref":"#/components/schemas/stream_uploaded"},"watermark":{"$ref":"#/components/schemas/stream_watermarks"}},"type":"object"},"stream_watermarkAtUpload":{"properties":{"uid":{"description":"The unique identifier for the watermark profile.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"type":"string","x-auditable":true}},"type":"object"},"stream_watermark_at_upload":{"properties":{"uid":{"description":"The unique identifier for the watermark profile.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"type":"string","x-auditable":true}},"type":"object"},"stream_watermark_basic_upload":{"properties":{"file":{"description":"The image file to upload.","example":"@/Users/rchen/Downloads/watermark.png","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/stream_name"},"opacity":{"$ref":"#/components/schemas/stream_opacity"},"padding":{"$ref":"#/components/schemas/stream_padding"},"position":{"$ref":"#/components/schemas/stream_position"},"scale":{"$ref":"#/components/schemas/stream_scale"}},"required":["file"],"type":"object"},"stream_watermark_created":{"description":"The date and a time a watermark profile was created.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string","x-auditable":true},"stream_watermark_identifier":{"description":"The unique identifier for a watermark profile.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"type":"string","x-auditable":true},"stream_watermark_response_collection":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/stream_watermarks"},"type":"array"}},"type":"object"}]},"stream_watermark_response_single":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/stream_watermarks"}},"type":"object"}]},"stream_watermark_size":{"description":"The size of the image in bytes.","example":29472,"type":"number","x-auditable":true},"stream_watermarks":{"properties":{"created":{"$ref":"#/components/schemas/stream_watermark_created"},"downloadedFrom":{"$ref":"#/components/schemas/stream_downloadedFrom"},"height":{"$ref":"#/components/schemas/stream_height"},"name":{"$ref":"#/components/schemas/stream_name"},"opacity":{"$ref":"#/components/schemas/stream_opacity"},"padding":{"$ref":"#/components/schemas/stream_padding"},"position":{"$ref":"#/components/schemas/stream_position"},"scale":{"$ref":"#/components/schemas/stream_scale"},"size":{"$ref":"#/components/schemas/stream_watermark_size"},"uid":{"$ref":"#/components/schemas/stream_watermark_identifier"},"width":{"$ref":"#/components/schemas/stream_width"}},"type":"object"},"stream_webhook_request":{"properties":{"notificationUrl":{"$ref":"#/components/schemas/stream_notificationUrl"}},"required":["notificationUrl"]},"stream_webhook_response_single":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"stream_width":{"description":"The width of the image in pixels.","type":"integer","x-auditable":true},"teams-devices_access_serial_number_list_input_request":{"properties":{"id":{"description":"UUID of Access List.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string","x-auditable":true}},"required":["id"],"title":"Serial Number","type":"object"},"teams-devices_account":{"properties":{"account_type":{"deprecated":true,"type":"string"},"id":{"deprecated":true,"type":"string"},"name":{"description":"The name of the enrolled account.","example":"Company","type":"string","x-auditable":true}},"type":"object"},"teams-devices_allow_mode_switch":{"default":false,"description":"Whether to allow the user to switch WARP between modes.","example":true,"type":"boolean"},"teams-devices_allow_updates":{"default":false,"description":"Whether to receive update notifications when a new version of the client is available.","example":true,"type":"boolean"},"teams-devices_allowed_to_leave":{"default":true,"description":"Whether to allow devices to leave the organization.","example":true,"type":"boolean"},"teams-devices_antivirus_input_request":{"properties":{"update_window_days":{"description":"Number of days that the antivirus should be updated within.","example":7,"type":"number"}},"title":"Antivirus","type":"object"},"teams-devices_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-common"},{"properties":{"result":{"items":{"type":"object"},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/teams-devices_result_info"}},"type":"object"}],"type":"object"},"teams-devices_api-response-collection-common":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-common"},{"properties":{"result":{"items":{"type":"object"},"nullable":true,"type":"array"}},"type":"object"}],"type":"object"},"teams-devices_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/teams-devices_messages"},"messages":{"$ref":"#/components/schemas/teams-devices_messages"},"result":{"anyOf":[{"type":"object"},{"items":{"type":"object"},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"teams-devices_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/teams-devices_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/teams-devices_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"teams-devices_api-response-single":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-common"},{"properties":{"result":{"anyOf":[{"type":"object"},{"type":"string"}],"nullable":true,"type":"object"}},"type":"object"}],"type":"object"},"teams-devices_application_input_request":{"properties":{"operating_system":{"description":"Operating system.","enum":["windows","linux","mac"],"example":"mac","type":"string","x-auditable":true},"path":{"description":"Path for the application.","example":"/bin/cat","type":"string","x-auditable":true},"sha256":{"description":"SHA-256.","example":"b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c","type":"string","x-auditable":true},"thumbprint":{"description":"Signing certificate thumbprint.","example":"0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e","type":"string","x-auditable":true}},"required":["path","operating_system"],"title":"Application","type":"object"},"teams-devices_auto_connect":{"default":0,"description":"The amount of time in seconds to reconnect after having been disabled.","example":0,"type":"number"},"teams-devices_captive_portal":{"default":180,"description":"Turn on the captive portal after the specified amount of time.","example":180,"type":"number"},"teams-devices_carbonblack_input_request":{"properties":{"operating_system":{"description":"Operating system.","enum":["windows","linux","mac"],"example":"mac","type":"string","x-auditable":true},"path":{"description":"File path.","example":"/bin/cat","type":"string","x-auditable":true},"sha256":{"description":"SHA-256.","example":"b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c","type":"string","x-auditable":true},"thumbprint":{"description":"Signing certificate thumbprint.","example":"0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e","type":"string","x-auditable":true}},"required":["path","operating_system"],"title":"Carbonblack","type":"object"},"teams-devices_checkDisks":{"description":"List of volume names to be checked for encryption.","example":["C","D","G"],"items":{"type":"string"},"type":"array"},"teams-devices_client_certificate_input_request":{"properties":{"certificate_id":{"description":"UUID of Cloudflare managed certificate.","example":"b14ddcc4-bcd2-4df4-bd4f-eb27d5a50c30","maxLength":36,"type":"string"},"cn":{"description":"Common Name that is protected by the certificate.","example":"example.com","type":"string"}},"required":["certificate_id","cn"],"title":"Client Certificate","type":"object"},"teams-devices_client_certificate_v2_input_request":{"properties":{"certificate_id":{"description":"UUID of Cloudflare managed certificate.","example":"b14ddcc4-bcd2-4df4-bd4f-eb27d5a50c30","maxLength":36,"type":"string"},"check_private_key":{"description":"Confirm the certificate was not imported from another device. We recommend keeping this enabled unless the certificate was deployed without a private key.","example":true,"type":"boolean"},"cn":{"description":"Certificate Common Name. This may include one or more variables in the ${ } notation. Only ${serial_number} and ${hostname} are valid variables.","example":"${hostname}.com.${serial_number}","type":"string"},"extended_key_usage":{"description":"List of values indicating purposes for which the certificate public key can be used.","example":["clientAuth","emailProtection"],"items":{"$ref":"#/components/schemas/teams-devices_extended_key_usage_enum"},"type":"array"},"locations":{"properties":{"paths":{"$ref":"#/components/schemas/teams-devices_paths"},"trust_stores":{"$ref":"#/components/schemas/teams-devices_trust_stores"}},"type":"object"},"operating_system":{"description":"Operating System.","enum":["windows","mac","linux"],"example":"windows","type":"string"},"subject_alternative_names":{"description":"List of certificate Subject Alternative Names.","example":["example.com","sample.com"],"items":{"type":"string"},"type":"array"}},"required":["certificate_id","check_private_key","operating_system"],"title":"Client Certificate V2","type":"object"},"teams-devices_components-schemas-name":{"description":"The name of the device posture integration.","example":"My Workspace One Integration","type":"string","x-auditable":true},"teams-devices_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/teams-devices_device-managed-networks"},"type":"array"}},"type":"object"}]},"teams-devices_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/teams-devices_device-managed-networks"}},"type":"object"}]},"teams-devices_components-schemas-type":{"description":"The type of device managed network.","enum":["tls"],"example":"tls","type":"string","x-auditable":true},"teams-devices_components-schemas-uuid":{"description":"UUID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"readOnly":true,"type":"string","x-auditable":true},"teams-devices_config_request":{"description":"The configuration object containing third-party integration information.","example":{"api_url":"https://as123.awmdm.com/API","auth_url":"https://na.uemauth.vmwservices.com/connect/token","client_id":"example client id","client_secret":"example client secret"},"oneOf":[{"$ref":"#/components/schemas/teams-devices_workspace_one_config_request"},{"$ref":"#/components/schemas/teams-devices_crowdstrike_config_request"},{"$ref":"#/components/schemas/teams-devices_uptycs_config_request"},{"$ref":"#/components/schemas/teams-devices_intune_config_request"},{"$ref":"#/components/schemas/teams-devices_kolide_config_request"},{"$ref":"#/components/schemas/teams-devices_tanium_config_request"},{"$ref":"#/components/schemas/teams-devices_sentinelone_s2s_config_request"},{"$ref":"#/components/schemas/teams-devices_custom_s2s_config_request"}],"type":"object"},"teams-devices_config_response":{"description":"The configuration object containing third-party integration information.","example":{"api_url":"https://as123.awmdm.com/API","auth_url":"https://na.uemauth.vmwservices.com/connect/token","client_id":"example client id"},"oneOf":[{"$ref":"#/components/schemas/teams-devices_workspace_one_config_response"}],"type":"object"},"teams-devices_created":{"description":"When the device was created.","example":"2017-06-14T00:00:00Z","format":"date-time","type":"string","x-auditable":true},"teams-devices_crowdstrike_config_request":{"properties":{"api_url":{"description":"The Crowdstrike API URL.","example":"https://api.us-2.crowdstrike.com","type":"string","x-auditable":true},"client_id":{"description":"The Crowdstrike client ID.","example":"example client id","type":"string"},"client_secret":{"description":"The Crowdstrike client secret.","example":"example client secret","type":"string","x-sensitive":true},"customer_id":{"description":"The Crowdstrike customer ID.","example":"example customer id","type":"string","x-auditable":true}},"required":["api_url","customer_id","client_id","client_secret"],"title":"Crowdstrike Config","type":"object"},"teams-devices_crowdstrike_input_request":{"properties":{"connection_id":{"description":"Posture Integration ID.","example":"bc7cbfbb-600a-42e4-8a23-45b5e85f804f","type":"string","x-auditable":true},"last_seen":{"description":"For more details on last seen, please refer to the Crowdstrike documentation.","example":"15d3h20m4s","type":"string","x-auditable":true},"operator":{"description":"Operator.","enum":["\u003c","\u003c=","\u003e","\u003e=","=="],"example":"\u003e","type":"string","x-auditable":true},"os":{"description":"Os Version.","example":"13.3.0","type":"string","x-auditable":true},"overall":{"description":"Overall.","example":90,"type":"string","x-auditable":true},"sensor_config":{"description":"SensorConfig.","example":90,"type":"string","x-auditable":true},"state":{"description":"For more details on state, please refer to the Crowdstrike documentation.","enum":["online","offline","unknown"],"example":"online","type":"string","x-auditable":true},"version":{"description":"Version.","example":"13.3.0","type":"string","x-auditable":true},"versionOperator":{"description":"Version Operator.","enum":["\u003c","\u003c=","\u003e","\u003e=","=="],"example":"\u003e","type":"string","x-auditable":true}},"required":["connection_id"],"title":"Crowdstrike S2S Input","type":"object"},"teams-devices_cursor_result_info":{"description":"V4 public API Pagination/Cursor info.","example":{"count":1,"cursor":"ais86dftf.asdf7ba8","per_page":10,"total_count":null},"properties":{"count":{"description":"Number of records in the response.","type":"integer"},"cursor":{"description":"Opaque token to request the next set of records.","type":"string"},"per_page":{"description":"The limit for the number of records in the response.","type":"integer"},"total_count":{"description":"Total number of records available.","nullable":true,"type":"integer"}},"required":["per_page","count","cursor"],"type":"object"},"teams-devices_custom_s2s_config_request":{"properties":{"access_client_id":{"description":"This id will be passed in the `CF-Access-Client-ID` header when hitting the `api_url`.","example":"88bf3b6d86161464f6509f7219099e57.access","type":"string"},"access_client_secret":{"description":"This secret will be passed in the `CF-Access-Client-Secret` header when hitting the `api_url`.","example":"bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5","type":"string","x-sensitive":true},"api_url":{"description":"The Custom Device Posture Integration  API URL.","example":"https://example.custom-s2s.com","type":"string","x-auditable":true}},"required":["api_url","access_client_id","access_client_secret"],"title":"Custom Device Posture Integration Config","type":"object"},"teams-devices_custom_s2s_input_request":{"properties":{"connection_id":{"description":"Posture Integration ID.","example":"bc7cbfbb-600a-42e4-8a23-45b5e85f804f","type":"string"},"operator":{"description":"Operator.","enum":["\u003c","\u003c=","\u003e","\u003e=","=="],"example":"\u003e","type":"string"},"score":{"description":"A value between 0-100 assigned to devices set by the 3rd party posture provider.","example":100,"type":"number"}},"required":["connection_id","score","operator"],"title":"Custom Device Posture Integration Input","type":"object"},"teams-devices_default":{"description":"Whether the policy is the default policy for an account.","example":false,"type":"boolean"},"teams-devices_default_device_settings_policy":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/teams-devices_allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/teams-devices_allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/teams-devices_allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/teams-devices_auto_connect"},"captive_portal":{"$ref":"#/components/schemas/teams-devices_captive_portal"},"default":{"description":"Whether the policy will be applied to matching devices.","example":true,"type":"boolean"},"disable_auto_fallback":{"$ref":"#/components/schemas/teams-devices_disable_auto_fallback"},"enabled":{"default":true,"description":"Whether the policy will be applied to matching devices.","example":true,"type":"boolean"},"exclude":{"$ref":"#/components/schemas/teams-devices_exclude"},"exclude_office_ips":{"$ref":"#/components/schemas/teams-devices_exclude_office_ips"},"fallback_domains":{"$ref":"#/components/schemas/teams-devices_fallback_domains"},"gateway_unique_id":{"$ref":"#/components/schemas/teams-devices_gateway_unique_id"},"include":{"$ref":"#/components/schemas/teams-devices_include"},"register_interface_ip_with_dns":{"$ref":"#/components/schemas/teams-devices_register_interface_ip_with_dns"},"sccm_vpn_boundary_support":{"$ref":"#/components/schemas/teams-devices_sccm_vpn_boundary_support"},"service_mode_v2":{"$ref":"#/components/schemas/teams-devices_service_mode_v2"},"support_url":{"$ref":"#/components/schemas/teams-devices_support_url"},"switch_locked":{"$ref":"#/components/schemas/teams-devices_switch_locked"},"tunnel_protocol":{"$ref":"#/components/schemas/teams-devices_tunnel_protocol"}},"type":"object"},"teams-devices_default_device_settings_response":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/teams-devices_default_device_settings_policy"}},"type":"object"}]},"teams-devices_deleted":{"description":"True if the device was deleted.","example":true,"type":"boolean"},"teams-devices_description":{"default":"","description":"The description of the device posture rule.","example":"The rule for admin serial numbers","type":"string","x-auditable":true},"teams-devices_device":{"properties":{"account":{"$ref":"#/components/schemas/teams-devices_account"},"created":{"$ref":"#/components/schemas/teams-devices_created"},"deleted":{"$ref":"#/components/schemas/teams-devices_deleted"},"device_type":{"$ref":"#/components/schemas/teams-devices_device_type"},"gateway_device_id":{"$ref":"#/components/schemas/teams-devices_gateway_device_id"},"id":{"$ref":"#/components/schemas/teams-devices_registration_id"},"ip":{"$ref":"#/components/schemas/teams-devices_ip"},"key":{"$ref":"#/components/schemas/teams-devices_key"},"key_type":{"$ref":"#/components/schemas/teams-devices_key_type"},"last_seen":{"$ref":"#/components/schemas/teams-devices_last_seen"},"mac_address":{"$ref":"#/components/schemas/teams-devices_mac_address"},"model":{"$ref":"#/components/schemas/teams-devices_model"},"name":{"$ref":"#/components/schemas/teams-devices_schemas-name"},"os_version":{"$ref":"#/components/schemas/teams-devices_os_version"},"serial_number":{"$ref":"#/components/schemas/teams-devices_serial_number"},"tunnel_type":{"$ref":"#/components/schemas/teams-devices_tunnel_type"},"updated":{"$ref":"#/components/schemas/teams-devices_updated"},"user":{"$ref":"#/components/schemas/teams-devices_user"},"version":{"$ref":"#/components/schemas/teams-devices_version"}},"type":"object"},"teams-devices_device-dex-test-schemas-data":{"description":"The configuration object which contains the details for the WARP client to conduct the test.","example":{"host":"https://dash.cloudflare.com","kind":"http","method":"GET"},"properties":{"host":{"description":"The desired endpoint to test.","example":"https://dash.cloudflare.com","type":"string"},"kind":{"description":"The type of test.","example":"http","type":"string"},"method":{"description":"The HTTP request method type.","example":"GET","type":"string"}},"type":"object"},"teams-devices_device-dex-test-schemas-description":{"description":"Additional details about the test.","example":"Checks the dash endpoint every 30 minutes","type":"string"},"teams-devices_device-dex-test-schemas-enabled":{"description":"Determines whether or not the test is active.","example":true,"type":"boolean"},"teams-devices_device-dex-test-schemas-http":{"properties":{"data":{"$ref":"#/components/schemas/teams-devices_device-dex-test-schemas-data"},"description":{"$ref":"#/components/schemas/teams-devices_device-dex-test-schemas-description"},"enabled":{"$ref":"#/components/schemas/teams-devices_device-dex-test-schemas-enabled"},"interval":{"$ref":"#/components/schemas/teams-devices_device-dex-test-schemas-interval"},"name":{"$ref":"#/components/schemas/teams-devices_device-dex-test-schemas-name"},"target_policies":{"$ref":"#/components/schemas/teams-devices_device-dex-test-target-policies"},"targeted":{"type":"boolean"},"test_id":{"$ref":"#/components/schemas/teams-devices_schemas-test-id"}},"required":["name","interval","enabled","data"],"type":"object"},"teams-devices_device-dex-test-schemas-interval":{"description":"How often the test will run.","example":"30m","type":"string"},"teams-devices_device-dex-test-schemas-name":{"description":"The name of the DEX test. Must be unique.","example":"HTTP dash health check","type":"string"},"teams-devices_device-dex-test-target-policies":{"description":"Device settings profiles targeted by this test.","items":{"$ref":"#/components/schemas/teams-devices_dex_target_policy"},"type":"array"},"teams-devices_device-managed-networks":{"properties":{"config":{"$ref":"#/components/schemas/teams-devices_schemas-config_response"},"name":{"$ref":"#/components/schemas/teams-devices_device-managed-networks_components-schemas-name"},"network_id":{"$ref":"#/components/schemas/teams-devices_uuid"},"type":{"$ref":"#/components/schemas/teams-devices_components-schemas-type"}},"type":"object"},"teams-devices_device-managed-networks_components-schemas-name":{"description":"The name of the device managed network. This name must be unique.","example":"managed-network-1","type":"string","x-auditable":true},"teams-devices_device-posture-integrations":{"properties":{"config":{"$ref":"#/components/schemas/teams-devices_config_response"},"id":{"$ref":"#/components/schemas/teams-devices_uuid"},"interval":{"$ref":"#/components/schemas/teams-devices_interval"},"name":{"$ref":"#/components/schemas/teams-devices_components-schemas-name"},"type":{"$ref":"#/components/schemas/teams-devices_schemas-type"}},"type":"object"},"teams-devices_device-posture-rules":{"properties":{"description":{"$ref":"#/components/schemas/teams-devices_description"},"expiration":{"$ref":"#/components/schemas/teams-devices_expiration"},"id":{"$ref":"#/components/schemas/teams-devices_uuid"},"input":{"$ref":"#/components/schemas/teams-devices_input"},"match":{"$ref":"#/components/schemas/teams-devices_match"},"name":{"$ref":"#/components/schemas/teams-devices_name"},"schedule":{"$ref":"#/components/schemas/teams-devices_schedule"},"type":{"$ref":"#/components/schemas/teams-devices_type"}},"type":"object"},"teams-devices_device_response":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/teams-devices_device"}},"type":"object"}]},"teams-devices_device_settings_policy":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/teams-devices_allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/teams-devices_allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/teams-devices_allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/teams-devices_auto_connect"},"captive_portal":{"$ref":"#/components/schemas/teams-devices_captive_portal"},"default":{"$ref":"#/components/schemas/teams-devices_default"},"description":{"$ref":"#/components/schemas/teams-devices_schemas-description"},"disable_auto_fallback":{"$ref":"#/components/schemas/teams-devices_disable_auto_fallback"},"enabled":{"default":true,"description":"Whether the policy will be applied to matching devices.","example":true,"type":"boolean"},"exclude":{"$ref":"#/components/schemas/teams-devices_exclude"},"exclude_office_ips":{"$ref":"#/components/schemas/teams-devices_exclude_office_ips"},"fallback_domains":{"$ref":"#/components/schemas/teams-devices_fallback_domains"},"gateway_unique_id":{"$ref":"#/components/schemas/teams-devices_gateway_unique_id"},"include":{"$ref":"#/components/schemas/teams-devices_include"},"lan_allow_minutes":{"$ref":"#/components/schemas/teams-devices_lan_allow_minutes"},"lan_allow_subnet_size":{"$ref":"#/components/schemas/teams-devices_lan_allow_subnet_size"},"match":{"$ref":"#/components/schemas/teams-devices_schemas-match"},"name":{"description":"The name of the device settings profile.","example":"Allow Developers","maxLength":100,"type":"string"},"policy_id":{"$ref":"#/components/schemas/teams-devices_schemas-uuid"},"precedence":{"$ref":"#/components/schemas/teams-devices_precedence"},"register_interface_ip_with_dns":{"$ref":"#/components/schemas/teams-devices_register_interface_ip_with_dns"},"sccm_vpn_boundary_support":{"$ref":"#/components/schemas/teams-devices_sccm_vpn_boundary_support"},"service_mode_v2":{"$ref":"#/components/schemas/teams-devices_service_mode_v2"},"support_url":{"$ref":"#/components/schemas/teams-devices_support_url"},"switch_locked":{"$ref":"#/components/schemas/teams-devices_switch_locked"},"target_tests":{"items":{"$ref":"#/components/schemas/teams-devices_target_dex_test"},"type":"array"},"tunnel_protocol":{"$ref":"#/components/schemas/teams-devices_tunnel_protocol"}},"type":"object"},"teams-devices_device_settings_response":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/teams-devices_device_settings_policy"}},"type":"object"}]},"teams-devices_device_settings_response_collection":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/teams-devices_device_settings_policy"},"type":"array"}},"type":"object"}]},"teams-devices_device_type":{"example":"windows","type":"string","x-auditable":true},"teams-devices_devices":{"properties":{"created":{"$ref":"#/components/schemas/teams-devices_created"},"deleted":{"$ref":"#/components/schemas/teams-devices_deleted"},"device_type":{"$ref":"#/components/schemas/teams-devices_platform"},"id":{"$ref":"#/components/schemas/teams-devices_registration_id"},"ip":{"$ref":"#/components/schemas/teams-devices_ip"},"key":{"$ref":"#/components/schemas/teams-devices_key"},"last_seen":{"$ref":"#/components/schemas/teams-devices_last_seen"},"mac_address":{"$ref":"#/components/schemas/teams-devices_mac_address"},"manufacturer":{"$ref":"#/components/schemas/teams-devices_manufacturer"},"model":{"$ref":"#/components/schemas/teams-devices_model"},"name":{"$ref":"#/components/schemas/teams-devices_schemas-name"},"os_distro_name":{"$ref":"#/components/schemas/teams-devices_os_distro_name"},"os_distro_revision":{"$ref":"#/components/schemas/teams-devices_os_distro_revision"},"os_version":{"$ref":"#/components/schemas/teams-devices_os_version"},"os_version_extra":{"$ref":"#/components/schemas/teams-devices_os_version_extra"},"revoked_at":{"$ref":"#/components/schemas/teams-devices_revoked_at"},"serial_number":{"$ref":"#/components/schemas/teams-devices_serial_number"},"updated":{"$ref":"#/components/schemas/teams-devices_updated"},"user":{"$ref":"#/components/schemas/teams-devices_user"},"version":{"$ref":"#/components/schemas/teams-devices_version"}},"type":"object"},"teams-devices_devices_policy_certificates":{"properties":{"enabled":{"description":"The current status of the device policy certificate provisioning feature for WARP clients.","example":true,"type":"boolean"}},"required":["enabled"],"type":"object"},"teams-devices_devices_policy_certificates_single":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/teams-devices_devices_policy_certificates"}},"type":"object"}]},"teams-devices_devices_response":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/teams-devices_devices"},"type":"array"}},"type":"object"}]},"teams-devices_dex-delete-response-collection":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-common"},{"properties":{"result":{"properties":{"dex_tests":{"items":{"$ref":"#/components/schemas/teams-devices_device-dex-test-schemas-http"},"type":"array"}},"type":"object"}},"type":"object"}]},"teams-devices_dex-response_collection":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-collection-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/teams-devices_device-dex-test-schemas-http"},"type":"array"}},"type":"object"}]},"teams-devices_dex-single_response":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/teams-devices_device-dex-test-schemas-http"}},"type":"object"}]},"teams-devices_dex_target_policy":{"properties":{"default":{"description":"Whether the profile is the account default.","type":"boolean"},"id":{"description":"The id of the device settings profile.","type":"string"},"name":{"description":"The name of the device settings profile.","type":"string"}},"type":"object"},"teams-devices_disable_auto_fallback":{"default":false,"description":"If the `dns_server` field of a fallback domain is not present, the client will fall back to a best guess of the default/system DNS resolvers unless this policy option is set to `true`.","example":true,"type":"boolean","x-auditable":true},"teams-devices_disable_for_time":{"properties":{"1":{"description":"Override code that is valid for 1 hour.","example":"9106681","type":"string"},"12":{"description":"Override code that is valid for 12 hour2.","example":"3424359","type":"string"},"24":{"description":"Override code that is valid for 24 hour.2.","example":"2887634","type":"string"},"3":{"description":"Override code that is valid for 3 hours.","example":"5356247","type":"string"},"6":{"description":"Override code that is valid for 6 hours.","example":"9478972","type":"string"}},"type":"object"},"teams-devices_disconnect":{"description":"Disconnects all devices on the account using Global WARP override.","example":false,"type":"boolean","x-auditable":true},"teams-devices_disk_encryption_input_request":{"properties":{"checkDisks":{"$ref":"#/components/schemas/teams-devices_checkDisks"},"requireAll":{"$ref":"#/components/schemas/teams-devices_requireAll"}},"title":"Disk Encryption","type":"object"},"teams-devices_domain_joined_input_request":{"properties":{"domain":{"description":"Domain.","example":"example.com","type":"string","x-auditable":true},"operating_system":{"description":"Operating System.","enum":["windows"],"example":"windows","type":"string","x-auditable":true}},"required":["operating_system"],"title":"Domain Joined","type":"object"},"teams-devices_email":{"description":"The contact email address of the user.","example":"user@example.com","maxLength":90,"type":"string","x-auditable":true},"teams-devices_empty_body":{"nullable":true,"type":"object"},"teams-devices_exclude":{"default":[{"address":"10.0.0.0/8"},{"address":"100.64.0.0/10"},{"address":"169.254.0.0/16","description":"DHCP Unspecified"},{"address":"172.16.0.0/12"},{"address":"192.0.0.0/24"},{"address":"192.168.0.0/16"},{"address":"224.0.0.0/24"},{"address":"240.0.0.0/4"},{"address":"255.255.255.255/32","description":"DHCP Broadcast"},{"address":"fe80::/10","description":"IPv6 Link Local"},{"address":"fd00::/8"},{"address":"ff01::/16"},{"address":"ff02::/16"},{"address":"ff03::/16"},{"address":"ff04::/16"},{"address":"ff05::/16"}],"description":"List of routes excluded in the WARP client's tunnel.","items":{"$ref":"#/components/schemas/teams-devices_split_tunnel"},"type":"array"},"teams-devices_exclude_office_ips":{"default":false,"description":"Whether to add Microsoft IPs to Split Tunnel exclusions.","example":true,"type":"boolean"},"teams-devices_exclude_request":{"description":"List of routes excluded in the WARP client's tunnel. Both 'exclude' and 'include' cannot be set in the same request.","items":{"$ref":"#/components/schemas/teams-devices_split_tunnel"},"type":"array"},"teams-devices_exclude_split_tunnel_with_address":{"properties":{"address":{"$ref":"#/components/schemas/teams-devices_split_tunnel_address"},"description":{"$ref":"#/components/schemas/teams-devices_split_tunnel_description"}},"required":["address"],"type":"object"},"teams-devices_exclude_split_tunnel_with_host":{"properties":{"description":{"$ref":"#/components/schemas/teams-devices_split_tunnel_description"},"host":{"$ref":"#/components/schemas/teams-devices_split_tunnel_host"}},"required":["host"],"type":"object"},"teams-devices_expiration":{"description":"Sets the expiration time for a posture check result. If empty, the result remains valid until it is overwritten by new data from the WARP client.","example":"1h","type":"string"},"teams-devices_extended_key_usage_enum":{"enum":["clientAuth","emailProtection"],"type":"string","x-auditable":true},"teams-devices_fallback_domain":{"properties":{"description":{"description":"A description of the fallback domain, displayed in the client UI.","example":"Domain bypass for local development","maxLength":100,"type":"string","x-auditable":true},"dns_server":{"description":"A list of IP addresses to handle domain resolution.","items":{"$ref":"#/components/schemas/teams-devices_ip"},"type":"array"},"suffix":{"description":"The domain suffix to match when resolving locally.","example":"example.com","type":"string","x-auditable":true}},"required":["suffix"],"type":"object"},"teams-devices_fallback_domain_response_collection":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/teams-devices_fallback_domain"},"type":"array"}},"type":"object"}]},"teams-devices_fallback_domains":{"default":[{"suffix":"intranet"},{"suffix":"internal"},{"suffix":"private"},{"suffix":"localdomain"},{"suffix":"domain"},{"suffix":"lan"},{"suffix":"home"},{"suffix":"host"},{"suffix":"corp"},{"suffix":"local"},{"suffix":"localhost"},{"suffix":"home.arpa"},{"suffix":"invalid"},{"suffix":"test"}],"items":{"$ref":"#/components/schemas/teams-devices_fallback_domain"},"type":"array"},"teams-devices_file_input_request":{"properties":{"exists":{"description":"Whether or not file exists.","example":true,"type":"boolean","x-auditable":true},"operating_system":{"description":"Operating system.","enum":["windows","linux","mac"],"example":"mac","type":"string","x-auditable":true},"path":{"description":"File path.","example":"/bin/cat","type":"string","x-auditable":true},"sha256":{"description":"SHA-256.","example":"https://api.us-2.crowdstrike.com","type":"string"},"thumbprint":{"description":"Signing certificate thumbprint.","example":"0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e","type":"string"}},"required":["path","operating_system"],"title":"File Check","type":"object"},"teams-devices_firewall_input_request":{"properties":{"enabled":{"description":"Enabled.","example":true,"type":"boolean","x-auditable":true},"operating_system":{"description":"Operating System.","enum":["windows","mac"],"example":"windows","type":"string","x-auditable":true}},"required":["operating_system","enabled"],"title":"Firewall","type":"object"},"teams-devices_gateway_device_id":{"deprecated":true,"example":"PD33E90AXfafe14643cbbbc-4a0ed4fc8415Q","type":"string"},"teams-devices_gateway_unique_id":{"example":"699d98642c564d2e855e9661899b7252","type":"string"},"teams-devices_global_warp_override":{"properties":{"disconnect":{"$ref":"#/components/schemas/teams-devices_disconnect"},"timestamp":{"$ref":"#/components/schemas/teams-devices_timestamp"}},"type":"object"},"teams-devices_global_warp_override_request":{"properties":{"disconnect":{"$ref":"#/components/schemas/teams-devices_disconnect"},"justification":{"$ref":"#/components/schemas/teams-devices_justification"}},"required":["disconnect"],"title":"Global WARP override request","type":"object"},"teams-devices_global_warp_override_response":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/teams-devices_global_warp_override"}},"type":"object"}],"type":"object"},"teams-devices_id_response":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/teams-devices_uuid"}},"type":"object"}},"type":"object"}]},"teams-devices_identifier":{"example":"699d98642c564d2e855e9661899b7252"},"teams-devices_include":{"description":"List of routes included in the WARP client's tunnel.","items":{"$ref":"#/components/schemas/teams-devices_split_tunnel_include"},"type":"array"},"teams-devices_include_request":{"description":"List of routes included in the WARP client's tunnel. Both 'exclude' and 'include' cannot be set in the same request.","items":{"$ref":"#/components/schemas/teams-devices_split_tunnel_include"},"type":"array"},"teams-devices_include_split_tunnel_address":{"description":"The address in CIDR format to include in the tunnel. If `address` is present, `host` must not be present.","example":"192.0.2.0/24","type":"string"},"teams-devices_include_split_tunnel_description":{"description":"A description of the Split Tunnel item, displayed in the client UI.","example":"Include testing domains in the tunnel","maxLength":100,"type":"string"},"teams-devices_include_split_tunnel_host":{"description":"The domain name to include in the tunnel. If `host` is present, `address` must not be present.","example":"*.example.com","type":"string"},"teams-devices_include_split_tunnel_with_address":{"properties":{"address":{"$ref":"#/components/schemas/teams-devices_include_split_tunnel_address"},"description":{"$ref":"#/components/schemas/teams-devices_include_split_tunnel_description"}},"required":["address"],"type":"object"},"teams-devices_include_split_tunnel_with_host":{"properties":{"description":{"$ref":"#/components/schemas/teams-devices_include_split_tunnel_description"},"host":{"$ref":"#/components/schemas/teams-devices_include_split_tunnel_host"}},"required":["host"],"type":"object"},"teams-devices_input":{"description":"The value to be checked against.","example":{"operating_system":"linux","path":"/bin/cat","thumbprint":"0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e"},"oneOf":[{"$ref":"#/components/schemas/teams-devices_file_input_request"},{"$ref":"#/components/schemas/teams-devices_unique_client_id_input_request"},{"$ref":"#/components/schemas/teams-devices_domain_joined_input_request"},{"$ref":"#/components/schemas/teams-devices_os_version_input_request"},{"$ref":"#/components/schemas/teams-devices_firewall_input_request"},{"$ref":"#/components/schemas/teams-devices_sentinelone_input_request"},{"$ref":"#/components/schemas/teams-devices_carbonblack_input_request"},{"$ref":"#/components/schemas/teams-devices_access_serial_number_list_input_request"},{"$ref":"#/components/schemas/teams-devices_disk_encryption_input_request"},{"$ref":"#/components/schemas/teams-devices_application_input_request"},{"$ref":"#/components/schemas/teams-devices_client_certificate_input_request"},{"$ref":"#/components/schemas/teams-devices_client_certificate_v2_input_request"},{"$ref":"#/components/schemas/teams-devices_antivirus_input_request"},{"$ref":"#/components/schemas/teams-devices_workspace_one_input_request"},{"$ref":"#/components/schemas/teams-devices_crowdstrike_input_request"},{"$ref":"#/components/schemas/teams-devices_intune_input_request"},{"$ref":"#/components/schemas/teams-devices_kolide_input_request"},{"$ref":"#/components/schemas/teams-devices_tanium_input_request"},{"$ref":"#/components/schemas/teams-devices_sentinelone_s2s_input_request"},{"$ref":"#/components/schemas/teams-devices_custom_s2s_input_request"}],"type":"object"},"teams-devices_interval":{"description":"The interval between each posture check with the third-party API. Use `m` for minutes (e.g. `5m`) and `h` for hours (e.g. `12h`).","example":"10m","type":"string","x-auditable":true},"teams-devices_intune_config_request":{"properties":{"client_id":{"description":"The Intune client ID.","example":"example client id","type":"string"},"client_secret":{"description":"The Intune client secret.","example":"example client secret","type":"string","x-sensitive":true},"customer_id":{"description":"The Intune customer ID.","example":"example customer id","type":"string"}},"required":["customer_id","client_id","client_secret"],"title":"Intune Config","type":"object"},"teams-devices_intune_input_request":{"properties":{"compliance_status":{"description":"Compliance Status.","enum":["compliant","noncompliant","unknown","notapplicable","ingraceperiod","error"],"example":"compliant","type":"string","x-auditable":true},"connection_id":{"description":"Posture Integration ID.","example":"bc7cbfbb-600a-42e4-8a23-45b5e85f804f","type":"string","x-auditable":true}},"required":["connection_id","compliance_status"],"title":"Intune S2S Input","type":"object"},"teams-devices_ip":{"description":"IPv4 or IPv6 address.","example":"1.1.1.1","type":"string","x-auditable":true},"teams-devices_justification":{"description":"Reasoning for setting the Global WARP override state. This will be surfaced in the audit log.","example":"Turning off WARP for testing purposes.","type":"string","x-auditable":true},"teams-devices_key":{"description":"The device's public key.","example":"yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc=","type":"string"},"teams-devices_key_type":{"description":"Type of the key.","example":"curve25519","type":"string","x-auditable":true},"teams-devices_kolide_config_request":{"properties":{"client_id":{"description":"The Kolide client ID.","example":"example client id","type":"string"},"client_secret":{"description":"The Kolide client secret.","example":"example client secret","type":"string","x-sensitive":true}},"required":["client_id","client_secret"],"title":"Kolide Config","type":"object"},"teams-devices_kolide_input_request":{"properties":{"connection_id":{"description":"Posture Integration ID.","example":"bc7cbfbb-600a-42e4-8a23-45b5e85f804f","type":"string","x-auditable":true},"countOperator":{"description":"Count Operator.","enum":["\u003c","\u003c=","\u003e","\u003e=","=="],"example":"\u003e","type":"string","x-auditable":true},"issue_count":{"description":"The Number of Issues.","example":1,"type":"string","x-auditable":true}},"required":["connection_id","countOperator","issue_count"],"title":"Kolide S2S Input","type":"object"},"teams-devices_lan_allow_minutes":{"description":"The amount of time in minutes a user is allowed access to their LAN. A value of 0 will allow LAN access until the next WARP reconnection, such as a reboot or a laptop waking from sleep. Note that this field is omitted from the response if null or unset.","example":30,"type":"number"},"teams-devices_lan_allow_subnet_size":{"description":"The size of the subnet for the local access network. Note that this field is omitted from the response if null or unset.","example":24,"type":"number"},"teams-devices_last_seen":{"description":"When the device last connected to Cloudflare services.","example":"2017-06-14T00:00:00Z","format":"date-time","type":"string","x-auditable":true},"teams-devices_mac_address":{"description":"The device mac address.","example":"00-00-5E-00-53-00","type":"string","x-auditable":true},"teams-devices_manufacturer":{"description":"The device manufacturer name.","example":"My phone corp","type":"string"},"teams-devices_match":{"description":"The conditions that the client must match to run the rule.","items":{"$ref":"#/components/schemas/teams-devices_match_item"},"type":"array"},"teams-devices_match_item":{"properties":{"platform":{"$ref":"#/components/schemas/teams-devices_platform"}},"type":"object"},"teams-devices_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"teams-devices_model":{"description":"The device model name.","example":"MyPhone(pro-X)","type":"string"},"teams-devices_name":{"description":"The name of the device posture rule.","example":"Admin Serial Numbers","type":"string","x-auditable":true},"teams-devices_os_distro_name":{"description":"The Linux distro name.","example":"ubuntu","type":"string","x-auditable":true},"teams-devices_os_distro_revision":{"description":"The Linux distro revision.","example":"1.0.0","type":"string","x-auditable":true},"teams-devices_os_version":{"description":"The operating system version.","example":"10.0.0","type":"string"},"teams-devices_os_version_extra":{"description":"Additional operating system version details. For Windows, the UBR (Update Build Revision). For Mac or iOS, the Product Version Extra. For Linux, the distribution name and version.","example":"(a) or 6889 or Ubuntu 24.04","type":"string"},"teams-devices_os_version_input_request":{"properties":{"operating_system":{"description":"Operating System.","enum":["windows"],"example":"windows","type":"string","x-auditable":true},"operator":{"description":"Operator.","enum":["\u003c","\u003c=","\u003e","\u003e=","=="],"example":"13.3.0","type":"string","x-auditable":true},"os_distro_name":{"description":"Operating System Distribution Name (linux only).","example":"ubuntu","type":"string","x-auditable":true},"os_distro_revision":{"description":"Version of OS Distribution (linux only).","example":"11.3.1","type":"string","x-auditable":true},"os_version_extra":{"description":"Additional operating system version details. For Windows, the UBR (Update Build Revision). For Mac or iOS, the Product Version Extra. For Linux, the distribution name and version.","example":"(a) or 6889 or Ubuntu 24.04","type":"string","x-auditable":true},"version":{"description":"Version of OS.","example":"13.3.0","type":"string","x-auditable":true}},"required":["operating_system","version","operator"],"title":"OS Version","type":"object"},"teams-devices_override_codes":{"properties":{"disable_for_time":{"additionalProperties":{"type":"string"},"type":"object"}}},"teams-devices_override_codes_response":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-collection"},{"properties":{"result":{"properties":{"disable_for_time":{"$ref":"#/components/schemas/teams-devices_disable_for_time"}},"type":"object"}},"type":"object"}]},"teams-devices_paths":{"description":"List of paths to check for client certificate on linux.","example":["/path1","/path2"],"items":{"type":"string"},"type":"array"},"teams-devices_physical_device":{"description":"A WARP Device.","properties":{"active_registrations":{"description":"The number of active registrations for the device. Active registrations are those which haven't been revoked or deleted.","example":1,"type":"integer","x-auditable":true},"client_version":{"description":"Version of the WARP client.","example":"1.0.0","nullable":true,"type":"string","x-auditable":true},"created_at":{"description":"The RFC3339 timestamp when the device was created.","example":"2025-02-14T13:17:00Z","type":"string","x-auditable":true},"deleted_at":{"description":"The RFC3339 timestamp when the device was deleted.","example":"2025-02-14T13:17:00Z","nullable":true,"type":"string","x-auditable":true},"device_type":{"description":"The device operating system.","example":"linux","nullable":true,"type":"string","x-auditable":true},"hardware_id":{"description":"A string that uniquely identifies the hardware or virtual machine (VM).","nullable":true,"type":"string","x-auditable":true},"id":{"description":"The unique ID of the device.","example":"fc9ab6ab-3b94-4319-9941-459462b3d73e","type":"string","x-auditable":true},"last_seen_at":{"description":"The RFC3339 timestamp when the device was last seen.","example":"2025-02-14T13:17:00Z","nullable":true,"type":"string","x-auditable":true},"last_seen_registration":{"allOf":[{"$ref":"#/components/schemas/teams-devices_registration_details"}],"description":"The last seen registration for the device.","nullable":true,"type":"object"},"last_seen_user":{"allOf":[{"$ref":"#/components/schemas/teams-devices_user"}],"description":"The last user to use the WARP device.","nullable":true,"type":"object"},"mac_address":{"description":"The device MAC address.","example":"f5:01:73:cf:12:23","nullable":true,"type":"string","x-auditable":true},"manufacturer":{"description":"The device manufacturer.","example":"ACME","nullable":true,"type":"string","x-auditable":true},"model":{"description":"The model name of the device.","example":"Mark VII","nullable":true,"type":"string","x-auditable":true},"name":{"description":"The name of the device.","example":"My Device","type":"string","x-auditable":true},"os_version":{"description":"The device operating system version number.","nullable":true,"type":"string","x-auditable":true},"os_version_extra":{"description":"Additional operating system version details. For Windows, the UBR (Update Build Revision). For Mac or iOS, the Product Version Extra. For Linux, the distribution name and version.","nullable":true,"type":"string","x-auditable":true},"public_ip":{"deprecated":true,"description":"**Deprecated**: IP information is provided by DEX - see https://developers.cloudflare.com/api/resources/zero_trust/subresources/dex/subresources/fleet_status/subresources/devices/methods/list/\n","example":"1.1.1.1","nullable":true,"type":"string","x-auditable":true},"serial_number":{"description":"The device serial number.","example":"ABS765ASD8A","nullable":true,"type":"string","x-auditable":true},"updated_at":{"description":"The RFC3339 timestamp when the device was last updated.","example":"2025-02-14T13:17:00Z","type":"string","x-auditable":true}},"required":["id","name","created_at","updated_at","last_seen_at","active_registrations"],"type":"object"},"teams-devices_platform":{"enum":["windows","mac","linux","android","ios","chromeos"],"example":"windows","type":"string","x-auditable":true},"teams-devices_policy_summary":{"description":"The device settings profile assigned to this registration.","properties":{"default":{"description":"Whether the device settings profile is the default profile for the account.","type":"boolean"},"deleted":{"description":"Whether the device settings profile was deleted.","type":"boolean"},"id":{"description":"The ID of the device settings profile.","example":"11ffb86f-3f0c-4306-b4a2-e62f872b166a","type":"string"},"name":{"description":"The name of the device settings profile.","type":"string"},"updated_at":{"description":"The RFC3339 timestamp of when the device settings profile last changed for the registration.","example":"2025-02-14T13:17:00Z","type":"string"}},"required":["id","name","updated_at","default","deleted"],"type":"object"},"teams-devices_precedence":{"description":"The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field.","example":100,"type":"number"},"teams-devices_register_interface_ip_with_dns":{"default":true,"description":"Determines if the operating system will register WARP's local interface IP with your on-premises DNS server.","example":true,"type":"boolean"},"teams-devices_registration":{"description":"A WARP configuration tied to a single user. Multiple registrations can be created from a single WARP device.","properties":{"created_at":{"description":"The RFC3339 timestamp when the registration was created.","example":"2025-02-14T13:17:00Z","type":"string","x-auditable":true},"deleted_at":{"description":"The RFC3339 timestamp when the registration was deleted.","example":"2025-02-14T13:17:00Z","nullable":true,"type":"string","x-auditable":true},"device":{"$ref":"#/components/schemas/teams-devices_registration_device_details"},"id":{"description":"The ID of the registration.","example":"11ffb86f-3f0c-4306-b4a2-e62f872b166a","type":"string","x-auditable":true},"key":{"description":"The public key used to connect to the Cloudflare network.","example":"U+QTP50RsWfeLGHF4tlGDnmGeuwtsz46KCHr5OyhWq00Rsdfl45mgnQAuEJ6CO0YrkyTl9FUf5iB0bwYR3g4EEFEHhtu6jFaqfMrBMBSz6itv9HQXkaR9OieKQ==","type":"string","x-auditable":true},"key_type":{"description":"The type of encryption key used by the WARP client for the active key. Currently 'curve25519' for WireGuard and 'secp256r1' for MASQUE.","example":"secp256r1","nullable":true,"type":"string","x-auditable":true},"last_seen_at":{"description":"The RFC3339 timestamp when the registration was last seen.","example":"2025-02-14T13:17:00Z","type":"string","x-auditable":true},"policy":{"$ref":"#/components/schemas/teams-devices_policy_summary"},"revoked_at":{"description":"The RFC3339 timestamp when the registration was revoked.","example":"2025-02-14T13:17:00Z","nullable":true,"type":"string","x-auditable":true},"tunnel_type":{"description":"Type of the tunnel - wireguard or masque.","example":"masque","nullable":true,"type":"string","x-auditable":true},"updated_at":{"description":"The RFC3339 timestamp when the registration was last updated.","example":"2025-02-14T13:17:00Z","type":"string","x-auditable":true},"user":{"$ref":"#/components/schemas/teams-devices_user"}},"required":["id","key","device","created_at","updated_at","last_seen_at"],"type":"object"},"teams-devices_registration_details":{"description":"The summary of a registration.","properties":{"policy":{"allOf":[{"$ref":"#/components/schemas/teams-devices_policy_summary"}],"description":"A summary of the device profile evaluated for the registration.","nullable":true,"type":"object"}},"type":"object"},"teams-devices_registration_device_details":{"description":"Device details embedded inside of a registration.","properties":{"client_version":{"description":"Version of the WARP client.","example":"1.0.0","type":"string","x-auditable":true},"id":{"description":"The ID of the device.","example":"32aa0404-78f1-49a4-99e0-97f575081356","type":"string","x-auditable":true},"name":{"description":"The name of the device.","example":"My Device","type":"string","x-auditable":true}},"required":["id","name"],"type":"object"},"teams-devices_registration_id":{"description":"Registration ID. Equal to Device ID except for accounts which enabled [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/).","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string","x-auditable":true},"teams-devices_requireAll":{"description":"Whether to check all disks for encryption.","example":true,"type":"boolean","x-auditable":true},"teams-devices_response_collection":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/teams-devices_device-posture-rules"},"type":"array"}},"type":"object"}]},"teams-devices_result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"},"teams-devices_revoke_devices_request":{"description":"A list of Registration IDs to revoke.","items":{"$ref":"#/components/schemas/teams-devices_registration_id"},"maxLength":200,"type":"array"},"teams-devices_revoked_at":{"description":"When the device was revoked.","example":"2017-06-14T00:00:00Z","format":"date-time","type":"string","x-auditable":true},"teams-devices_sccm_vpn_boundary_support":{"default":false,"description":"Determines whether the WARP client indicates to SCCM that it is inside a VPN boundary. (Windows only).","example":false,"type":"boolean"},"teams-devices_schedule":{"description":"Polling frequency for the WARP client posture check. Default: `5m` (poll every five minutes). Minimum: `1m`.","example":"1h","type":"string","x-auditable":true},"teams-devices_schemas-config_request":{"description":"The configuration object containing information for the WARP client to detect the managed network.","example":{"sha256":"b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c","tls_sockaddr":"foo.bar:1234"},"oneOf":[{"$ref":"#/components/schemas/teams-devices_tls_config_request"}],"type":"object"},"teams-devices_schemas-config_response":{"description":"The configuration object containing information for the WARP client to detect the managed network.","example":{"sha256":"b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c","tls_sockaddr":"foo.bar:1234"},"oneOf":[{"$ref":"#/components/schemas/teams-devices_tls_config_response"}],"type":"object"},"teams-devices_schemas-description":{"description":"A description of the policy.","example":"Policy for test teams.","maxLength":500,"type":"string"},"teams-devices_schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},"teams-devices_schemas-match":{"description":"The wirefilter expression to match devices. Available values: \"identity.email\", \"identity.groups.id\", \"identity.groups.name\", \"identity.groups.email\", \"identity.service_token_uuid\", \"identity.saml_attributes\", \"network\", \"os.name\", \"os.version\".","example":"identity.email == \"test@cloudflare.com\"","maxLength":500,"type":"string"},"teams-devices_schemas-name":{"description":"The device name.","example":"My mobile device","type":"string"},"teams-devices_schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/teams-devices_device-posture-integrations"},"type":"array"}},"type":"object"}]},"teams-devices_schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/teams-devices_device-posture-integrations"}},"type":"object"}]},"teams-devices_schemas-test-id":{"description":"The unique identifier for the test.","example":"372e67954025e0ba6aaa6d586b9e0b59","maxLength":32,"readOnly":true,"type":"string"},"teams-devices_schemas-type":{"description":"The type of device posture integration.","enum":["workspace_one","crowdstrike_s2s","uptycs","intune","kolide","tanium_s2s","sentinelone_s2s","custom_s2s"],"example":"workspace_one","type":"string","x-auditable":true},"teams-devices_schemas-uuid":{"example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string","x-auditable":true},"teams-devices_sentinelone_input_request":{"properties":{"operating_system":{"description":"Operating system.","enum":["windows","linux","mac"],"example":"mac","type":"string","x-auditable":true},"path":{"description":"File path.","example":"/bin/cat","type":"string","x-auditable":true},"sha256":{"description":"SHA-256.","example":"b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c","type":"string","x-auditable":true},"thumbprint":{"description":"Signing certificate thumbprint.","example":"0aabab210bdb998e9cf45da2c9ce352977ab531c681b74cf1e487be1bbe9fe6e","type":"string","x-auditable":true}},"required":["path","operating_system"],"title":"Sentinelone","type":"object"},"teams-devices_sentinelone_s2s_config_request":{"properties":{"api_url":{"description":"The SentinelOne S2S API URL.","example":"https://example.sentinelone.net","type":"string"},"client_secret":{"description":"The SentinelOne S2S client secret.","example":"example client secret","type":"string","x-sensitive":true}},"required":["api_url","client_secret"],"title":"SentinelOne S2S Config","type":"object"},"teams-devices_sentinelone_s2s_input_request":{"properties":{"active_threats":{"description":"The Number of active threats.","example":1,"type":"number"},"connection_id":{"description":"Posture Integration ID.","example":"bc7cbfbb-600a-42e4-8a23-45b5e85f804f","type":"string"},"infected":{"description":"Whether device is infected.","example":true,"type":"boolean"},"is_active":{"description":"Whether device is active.","example":true,"type":"boolean"},"network_status":{"description":"Network status of device.","enum":["connected","disconnected","disconnecting","connecting"],"example":"connected","type":"string"},"operational_state":{"description":"Agent operational state.","enum":["na","partially_disabled","auto_fully_disabled","fully_disabled","auto_partially_disabled","disabled_error","db_corruption"],"type":"string"},"operator":{"description":"Operator.","enum":["\u003c","\u003c=","\u003e","\u003e=","=="],"example":"\u003e","type":"string"}},"required":["connection_id"],"title":"SentinelOne S2S Input","type":"object"},"teams-devices_serial_number":{"description":"The device serial number.","example":"EXAMPLEHMD6R","type":"string"},"teams-devices_service_mode_v2":{"properties":{"mode":{"description":"The mode to run the WARP client under.","example":"proxy","type":"string","x-auditable":true},"port":{"description":"The port number when used with proxy mode.","example":3000,"type":"number","x-auditable":true}},"type":"object"},"teams-devices_single_response":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/teams-devices_device-posture-rules"}},"type":"object"}]},"teams-devices_split_tunnel":{"oneOf":[{"$ref":"#/components/schemas/teams-devices_exclude_split_tunnel_with_address"},{"$ref":"#/components/schemas/teams-devices_exclude_split_tunnel_with_host"}],"type":"object"},"teams-devices_split_tunnel_address":{"description":"The address in CIDR format to exclude from the tunnel. If `address` is present, `host` must not be present.","example":"192.0.2.0/24","type":"string"},"teams-devices_split_tunnel_description":{"description":"A description of the Split Tunnel item, displayed in the client UI.","example":"Exclude testing domains from the tunnel","maxLength":100,"type":"string"},"teams-devices_split_tunnel_host":{"description":"The domain name to exclude from the tunnel. If `host` is present, `address` must not be present.","example":"*.example.com","type":"string"},"teams-devices_split_tunnel_include":{"oneOf":[{"$ref":"#/components/schemas/teams-devices_include_split_tunnel_with_address"},{"$ref":"#/components/schemas/teams-devices_include_split_tunnel_with_host"}],"type":"object"},"teams-devices_split_tunnel_include_response_collection":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/teams-devices_split_tunnel_include"},"type":"array"}},"type":"object"}]},"teams-devices_split_tunnel_response_collection":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/teams-devices_split_tunnel"},"type":"array"}},"type":"object"}]},"teams-devices_support_url":{"default":"","description":"The URL to launch when the Send Feedback button is clicked.","example":"https://1.1.1.1/help","type":"string"},"teams-devices_switch_locked":{"default":false,"description":"Whether to allow the user to turn off the WARP switch and disconnect the client.","example":true,"type":"boolean"},"teams-devices_tanium_config_request":{"properties":{"access_client_id":{"description":"If present, this id will be passed in the `CF-Access-Client-ID` header when hitting the `api_url`.","example":"88bf3b6d86161464f6509f7219099e57.access","type":"string"},"access_client_secret":{"description":"If present, this secret will be passed in the `CF-Access-Client-Secret` header when hitting the `api_url`.","example":"bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5","type":"string","x-sensitive":true},"api_url":{"description":"The Tanium API URL.","example":"https://dummy-tanium-api.cloudflare.com/plugin/products/gateway/graphql","type":"string","x-auditable":true},"client_secret":{"description":"The Tanium client secret.","example":"example client secret","type":"string","x-sensitive":true}},"required":["api_url","client_secret"],"title":"Tanium Config","type":"object"},"teams-devices_tanium_input_request":{"properties":{"connection_id":{"description":"Posture Integration ID.","example":"bc7cbfbb-600a-42e4-8a23-45b5e85f804f","type":"string","x-auditable":true},"eid_last_seen":{"description":"For more details on eid last seen, refer to the Tanium documentation.","example":"2023-07-20T23:16:32Z","type":"string","x-auditable":true},"operator":{"description":"Operator to evaluate risk_level or eid_last_seen.","enum":["\u003c","\u003c=","\u003e","\u003e=","=="],"example":"\u003e","type":"string","x-auditable":true},"risk_level":{"description":"For more details on risk level, refer to the Tanium documentation.","enum":["low","medium","high","critical"],"example":"low","type":"string","x-auditable":true},"scoreOperator":{"description":"Score Operator.","enum":["\u003c","\u003c=","\u003e","\u003e=","=="],"example":"\u003e","type":"string","x-auditable":true},"total_score":{"description":"For more details on total score, refer to the Tanium documentation.","example":1,"type":"number","x-auditable":true}},"required":["connection_id"],"title":"Tanium S2S Input","type":"object"},"teams-devices_target_dex_test":{"properties":{"id":{"description":"The id of the DEX test targeting this policy.","type":"string"},"name":{"description":"The name of the DEX test targeting this policy.","type":"string"}},"type":"object"},"teams-devices_timestamp":{"description":"When the Global WARP override state was updated.","example":"1970-01-01T00:00:00.000Z","format":"date-time","type":"string","x-auditable":true},"teams-devices_tls_config_request":{"properties":{"sha256":{"description":"The SHA-256 hash of the TLS certificate presented by the host found at tls_sockaddr. If absent, regular certificate verification (trusted roots, valid timestamp, etc) will be used to validate the certificate.","example":"b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c","type":"string"},"tls_sockaddr":{"description":"A network address of the form \"host:port\" that the WARP client will use to detect the presence of a TLS host.","example":"foobar:1234","type":"string"}},"required":["tls_sockaddr"],"type":"object"},"teams-devices_tls_config_response":{"description":"The Managed Network TLS Config Response.","properties":{"sha256":{"description":"The SHA-256 hash of the TLS certificate presented by the host found at tls_sockaddr. If absent, regular certificate verification (trusted roots, valid timestamp, etc) will be used to validate the certificate.","example":"b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c","type":"string"},"tls_sockaddr":{"description":"A network address of the form \"host:port\" that the WARP client will use to detect the presence of a TLS host.","example":"foobar:1234","type":"string","x-auditable":true}},"required":["tls_sockaddr"],"type":"object"},"teams-devices_trust_stores":{"description":"List of trust stores to check for client certificate.","example":["system","user"],"items":{"$ref":"#/components/schemas/teams-devices_trust_stores_enum"},"type":"array"},"teams-devices_trust_stores_enum":{"enum":["system","user"],"type":"string","x-auditable":true},"teams-devices_tunnel_protocol":{"default":"","description":"Determines which tunnel protocol to use.","example":"wireguard","type":"string"},"teams-devices_tunnel_type":{"description":"Type of the tunnel connection used.","example":"masque","type":"string","x-auditable":true},"teams-devices_type":{"description":"The type of device posture rule.","enum":["file","application","tanium","gateway","warp","disk_encryption","serial_number","sentinelone","carbonblack","firewall","os_version","domain_joined","client_certificate","client_certificate_v2","antivirus","unique_client_id","kolide","tanium_s2s","crowdstrike_s2s","intune","workspace_one","sentinelone_s2s","custom_s2s"],"example":"file","type":"string","x-auditable":true},"teams-devices_unique_client_id_input_request":{"properties":{"id":{"description":"List ID.","example":"da3de859-8f6e-47ea-a2b5-b2433858471f","type":"string","x-auditable":true},"operating_system":{"description":"Operating System.","enum":["android","ios","chromeos"],"example":"android","type":"string","x-auditable":true}},"required":["operating_system","id"],"title":"Unique Client ID","type":"object"},"teams-devices_unrevoke_devices_request":{"description":"A list of Registration IDs to unrevoke.","items":{"$ref":"#/components/schemas/teams-devices_registration_id"},"maxLength":200,"type":"array"},"teams-devices_updated":{"description":"When the device was updated.","example":"2017-06-14T00:00:00Z","format":"date-time","type":"string","x-auditable":true},"teams-devices_uptycs_config_request":{"properties":{"api_url":{"description":"The Uptycs API URL.","example":"rnd.uptycs.io","type":"string","x-auditable":true},"client_key":{"description":"The Uptycs client secret.","example":"example client key","type":"string"},"client_secret":{"description":"The Uptycs client secret.","example":"example client secret","type":"string","x-sensitive":true},"customer_id":{"description":"The Uptycs customer ID.","example":"example customer id","type":"string"}},"required":["api_url","client_key","customer_id","client_secret"],"title":"Uptycs Config","type":"object"},"teams-devices_user":{"properties":{"email":{"$ref":"#/components/schemas/teams-devices_email"},"id":{"$ref":"#/components/schemas/teams-devices_components-schemas-uuid"},"name":{"description":"The enrolled device user's name.","example":"John Appleseed","type":"string"}},"type":"object"},"teams-devices_uuid":{"description":"API UUID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string","x-auditable":true},"teams-devices_v4_response_message":{"description":"A message which can be returned in either the 'errors' or 'messages' fields in a v4 API response.","properties":{"code":{"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"teams-devices_version":{"description":"The WARP client version.","example":"1.0.0","type":"string"},"teams-devices_workspace_one_config_request":{"properties":{"api_url":{"description":"The Workspace One API URL provided in the Workspace One Admin Dashboard.","example":"https://as123.awmdm.com/API","type":"string"},"auth_url":{"description":"The Workspace One Authorization URL depending on your region.","example":"https://na.uemauth.vmwservices.com/connect/token","type":"string"},"client_id":{"description":"The Workspace One client ID provided in the Workspace One Admin Dashboard.","example":"example client id","type":"string"},"client_secret":{"description":"The Workspace One client secret provided in the Workspace One Admin Dashboard.","example":"example client secret","type":"string","x-sensitive":true}},"required":["api_url","auth_url","client_id","client_secret"],"title":"Workspace One Config","type":"object"},"teams-devices_workspace_one_config_response":{"description":"The Workspace One Config Response.","properties":{"api_url":{"description":"The Workspace One API URL provided in the Workspace One Admin Dashboard.","example":"https://as123.awmdm.com/API","type":"string"},"auth_url":{"description":"The Workspace One Authorization URL depending on your region.","example":"https://na.uemauth.vmwservices.com/connect/token","type":"string"},"client_id":{"description":"The Workspace One client ID provided in the Workspace One Admin Dashboard.","example":"example client id","type":"string"}},"required":["api_url","auth_url","client_id"],"type":"object"},"teams-devices_workspace_one_input_request":{"properties":{"compliance_status":{"description":"Compliance Status.","enum":["compliant","noncompliant","unknown"],"example":"compliant","type":"string","x-auditable":true},"connection_id":{"description":"Posture Integration ID.","example":"bc7cbfbb-600a-42e4-8a23-45b5e85f804f","type":"string","x-auditable":true}},"required":["connection_id","compliance_status"],"title":"Workspace One S2S Input","type":"object"},"teams-devices_zero-trust-account-device-settings":{"properties":{"disable_for_time":{"description":"Sets the time limit, in seconds, that a user can use an override code to bypass WARP.","type":"number"},"external_emergency_signal_enabled":{"description":"Controls whether the external emergency disconnect feature is enabled.","example":true,"type":"boolean"},"external_emergency_signal_fingerprint":{"description":"The SHA256 fingerprint (64 hexadecimal characters) of the HTTPS server certificate for the external_emergency_signal_url. If provided, the WARP client will use this value to verify the server's identity. The device will ignore any response if the server's certificate fingerprint does not exactly match this value.","example":"abcd1234567890abcd1234567890abcd1234567890abcd1234567890abcd1234","type":"string"},"external_emergency_signal_interval":{"description":"The interval at which the WARP client fetches the emergency disconnect signal, formatted as a duration string (e.g., \"5m\", \"2m30s\", \"1h\"). Minimum 30 seconds.","example":"5m","type":"string"},"external_emergency_signal_url":{"description":"The HTTPS URL from which to fetch the emergency disconnect signal. Must use HTTPS and have an IPv4 or IPv6 address as the host.","example":"https://192.0.2.1/signal","type":"string"},"gateway_proxy_enabled":{"description":"Enable gateway proxy filtering on TCP.","example":true,"type":"boolean"},"gateway_udp_proxy_enabled":{"description":"Enable gateway proxy filtering on UDP.","example":true,"type":"boolean"},"root_certificate_installation_enabled":{"description":"Enable installation of cloudflare managed root certificate.","example":true,"type":"boolean"},"use_zt_virtual_ip":{"description":"Enable using CGNAT virtual IPv4.","example":true,"type":"boolean"}},"type":"object"},"teams-devices_zero-trust-account-device-settings-response":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/teams-devices_zero-trust-account-device-settings"}},"type":"object"}],"type":"object"},"tls-certificates-and-hostnames_advanced_certificate_pack_response_single":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_pack"}},"type":"object"}]},"tls-certificates-and-hostnames_advanced_type":{"description":"Type of certificate pack.","enum":["advanced"],"example":"advanced","type":"string","x-auditable":true},"tls-certificates-and-hostnames_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"tls-certificates-and-hostnames_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_messages"},"messages":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"tls-certificates-and-hostnames_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"tls-certificates-and-hostnames_api-response-single":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common"}],"type":"object"},"tls-certificates-and-hostnames_associationObject":{"properties":{"service":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_service"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-status"}}},"tls-certificates-and-hostnames_association_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_associationObject"},"type":"array"}}}]},"tls-certificates-and-hostnames_base":{"properties":{"created_on":{"description":"When the Keyless SSL was created.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"enabled":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_enabled"},"host":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_host"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-identifier"},"modified_on":{"description":"When the Keyless SSL was last modified.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_name"},"permissions":{"description":"Available permissions for the Keyless SSL for the current user requesting the item.","example":["#ssl:read","#ssl:edit"],"items":{"type":"string","x-auditable":true},"readOnly":true,"type":"array"},"port":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_port"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-status"},"tunnel":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_tunnel"}},"required":["id","name","host","port","status","enabled","permissions","created_on","modified_on"],"type":"object"},"tls-certificates-and-hostnames_brand_check":{"description":"Certificate Authority is manually reviewing the order.","example":false,"type":"boolean","x-auditable":true},"tls-certificates-and-hostnames_bundle_method":{"default":"ubiquitous","description":"A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.","enum":["ubiquitous","optimal","force"],"example":"ubiquitous","type":"string","x-auditable":true},"tls-certificates-and-hostnames_ca":{"description":"Indicates whether the certificate is a CA or leaf certificate.","example":true,"type":"boolean","x-auditable":true},"tls-certificates-and-hostnames_cert_id":{"description":"Certificate identifier tag.","example":"2458ce5a-0c35-4c7f-82c7-8e9487d3ff60","maxLength":36,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_cert_pack_uuid":{"description":"Certificate Pack UUID.","example":"a77f8bd7-3b47-46b4-a6f1-75cf98109948","type":"string","x-auditable":true},"tls-certificates-and-hostnames_certificate":{"description":"The zone's SSL certificate or certificate and the intermediate(s).","example":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","type":"string"},"tls-certificates-and-hostnames_certificate-packs_components-schemas-status":{"description":"Status of certificate pack.","enum":["initializing","pending_validation","deleted","pending_issuance","pending_deployment","pending_deletion","pending_expiration","expired","active","initializing_timed_out","validation_timed_out","issuance_timed_out","deployment_timed_out","deletion_timed_out","pending_cleanup","staging_deployment","staging_active","deactivating","inactive","backup_issued","holding_deployment"],"example":"initializing","type":"string","x-auditable":true},"tls-certificates-and-hostnames_certificateObject":{"properties":{"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate"},"expires_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-expires_on"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"issuer":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_issuer"},"signature":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_signature"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-status"},"uploaded_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-uploaded_on"}}},"tls-certificates-and-hostnames_certificateObjectPost":{"properties":{"ca":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ca"},"certificates":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-certificates"},"expires_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-expires_on"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"issuer":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-issuer"},"name":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-name"},"serial_number":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-serial_number"},"signature":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_signature"},"updated_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-updated_at"},"uploaded_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on"}}},"tls-certificates-and-hostnames_certificate_analyze_response":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"type":"object"}}}]},"tls-certificates-and-hostnames_certificate_authority":{"description":"The Certificate Authority that will issue the certificate","enum":["digicert","google","lets_encrypt","ssl_com"],"example":"google","type":"string","x-auditable":true},"tls-certificates-and-hostnames_certificate_pack":{"description":"A certificate pack with all its properties.","properties":{"certificate_authority":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_authority"},"certificates":{"description":"Array of certificates in this pack.","items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_pack_certificate"},"type":"array"},"cloudflare_branding":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_cloudflare_branding"},"hosts":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-hosts"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"primary_certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_primary"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate-packs_components-schemas-status"},"type":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-type"},"validation_errors":{"description":"Domain validation errors that have been received by the certificate authority (CA).","items":{"properties":{"message":{"description":"A domain validation error.","example":"SERVFAIL looking up CAA for app.example.com","type":"string","x-auditable":true}},"type":"object"},"type":"array"},"validation_method":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_validation_method"},"validation_records":{"description":"Certificates' validation records.","items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_validation_record"},"type":"array"},"validity_days":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_validity_days"}},"required":["id","type","hosts","certificates","status"],"type":"object"},"tls-certificates-and-hostnames_certificate_pack_certificate":{"description":"An individual certificate within a certificate pack.","properties":{"bundle_method":{"description":"Certificate bundle method.","example":"ubiquitous","type":"string","x-auditable":true},"expires_on":{"description":"When the certificate from the authority expires.","example":"2024-01-01T00:00:00Z","format":"date-time","type":"string","x-auditable":true},"geo_restrictions":{"description":"Specify the region where your private key can be held locally.","properties":{"label":{"enum":["us","eu","highest_security"],"example":"us","type":"string","x-auditable":true}},"type":"object"},"hosts":{"description":"Hostnames covered by this certificate.","example":["example.com","*.example.com"],"items":{"type":"string"},"type":"array","x-auditable":true},"id":{"description":"Certificate identifier.","example":"7e7b8deba8538af625850b7b2530034c","type":"string","x-auditable":true},"issuer":{"description":"The certificate authority that issued the certificate.","example":"Let's Encrypt","type":"string","x-auditable":true},"modified_on":{"description":"When the certificate was last modified.","example":"2014-01-01T05:20:00Z","format":"date-time","type":"string","x-auditable":true},"priority":{"description":"The order/priority in which the certificate will be used.","type":"number","x-auditable":true},"signature":{"description":"The type of hash used for the certificate.","example":"ECDSAWithSHA256","type":"string","x-auditable":true},"status":{"description":"Certificate status.","example":"active","type":"string","x-auditable":true},"uploaded_on":{"description":"When the certificate was uploaded to Cloudflare.","example":"2014-01-01T05:20:00Z","format":"date-time","type":"string","x-auditable":true},"zone_id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},"required":["id","hosts","status"],"type":"object"},"tls-certificates-and-hostnames_certificate_pack_quota_response":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"properties":{"advanced":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_quota"}},"type":"object"}},"type":"object"}]},"tls-certificates-and-hostnames_certificate_pack_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_pack"},"type":"array"}}}]},"tls-certificates-and-hostnames_certificate_pack_response_single":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_pack"}},"type":"object"}]},"tls-certificates-and-hostnames_certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom-certificate"},"type":"array"}}}]},"tls-certificates-and-hostnames_certificate_response_id_only":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},"type":"object"}}}]},"tls-certificates-and-hostnames_certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom-certificate"}}}]},"tls-certificates-and-hostnames_certificate_response_single_post":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificateObjectPost"}],"type":"object"}}}]},"tls-certificates-and-hostnames_certificate_revoke_response":{"allOf":[{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"revoked_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_revoked_at"}}}},"type":"object"}]},"tls-certificates-and-hostnames_certificate_status":{"description":"Current status of certificate.","enum":["initializing","authorizing","active","expired","issuing","timing_out","pending_deployment"],"example":"active","type":"string","x-auditable":true},"tls-certificates-and-hostnames_certificates":{"properties":{"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificates_components-schemas-certificate"},"csr":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_csr"},"expires_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-expires_on"},"hostnames":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostnames"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"request_type":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_request_type"},"requested_validity":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_requested_validity"}},"required":["hostnames","csr","requested_validity","request_type"],"type":"object"},"tls-certificates-and-hostnames_certificates_components-schemas-certificate":{"description":"The Origin CA certificate. Will be newline-encoded.","example":"-----BEGIN CERTIFICATE-----\nMIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV\nBAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln\naUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo\nwp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c\n1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI\nWDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ\nwIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR\nBPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ\nKoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D\nhJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY\nQ4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/\nZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn\n29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2\n97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w=\n-----END CERTIFICATE-----","readOnly":true,"type":"string"},"tls-certificates-and-hostnames_client-certificates_components-schemas-certificate":{"description":"The Client Certificate PEM","example":"-----BEGIN CERTIFICATE-----\\nMIIDmDCCAoC...dhDDE\\n-----END CERTIFICATE-----","readOnly":true,"type":"string"},"tls-certificates-and-hostnames_client-certificates_components-schemas-certificate_authority":{"description":"Certificate Authority used to issue the Client Certificate","properties":{"id":{"example":"568b6b74-7b0c-4755-8840-4e3b8c24adeb","type":"string","x-auditable":true},"name":{"example":"Cloudflare Managed CA for account","type":"string","x-auditable":true}},"type":"object"},"tls-certificates-and-hostnames_client-certificates_components-schemas-status":{"description":"Client Certificates may be active or revoked, and the pending_reactivation or pending_revocation represent in-progress asynchronous transitions","enum":["active","pending_reactivation","pending_revocation","revoked"],"example":"active","type":"string","x-auditable":true},"tls-certificates-and-hostnames_client_certificate":{"properties":{"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_client-certificates_components-schemas-certificate"},"certificate_authority":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_client-certificates_components-schemas-certificate_authority"},"common_name":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_common_name"},"country":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_country"},"csr":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-csr"},"expires_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_expired_on"},"fingerprint_sha256":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_fingerprint_sha256"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"issued_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_issued_on"},"location":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_location"},"organization":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_organization"},"organizational_unit":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_organizational_unit"},"serial_number":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-serial_number"},"signature":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-signature"},"ski":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ski"},"state":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_state"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_client-certificates_components-schemas-status"},"validity_days":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-validity_days"}}},"tls-certificates-and-hostnames_client_certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_client_certificate"},"type":"array"}}}]},"tls-certificates-and-hostnames_client_certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_client_certificate"}}}]},"tls-certificates-and-hostnames_cloudflare_branding":{"description":"Whether or not to add Cloudflare Branding for the order.  This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true.","example":false,"type":"boolean","x-auditable":true},"tls-certificates-and-hostnames_common_name":{"description":"Common Name of the Client Certificate","example":"Cloudflare","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_components-schemas-certificate":{"description":"The zone's SSL certificate or certificate and the intermediate(s).","example":"-----BEGIN CERTIFICATE-----\nMIIDdjCCAl6gAwIBAgIJAPnMg0Fs+/B0MA0GCSqGSIb3DQEBCwUAMFsx...\n-----END CERTIFICATE-----\n","type":"string"},"tls-certificates-and-hostnames_components-schemas-certificateObject":{"properties":{"ca":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ca"},"certificates":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-certificates"},"expires_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-expires_on"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"issuer":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-issuer"},"name":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-name"},"serial_number":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-serial_number"},"signature":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_signature"},"uploaded_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on"}}},"tls-certificates-and-hostnames_components-schemas-certificate_authority":{"description":"The Certificate Authority that Total TLS certificates will be issued through.","enum":["google","lets_encrypt","ssl_com"],"example":"google","type":"string","x-auditable":true},"tls-certificates-and-hostnames_components-schemas-certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull"},"type":"array"}}}]},"tls-certificates-and-hostnames_components-schemas-certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull"}}}]},"tls-certificates-and-hostnames_components-schemas-created_at":{"description":"The time when the certificate was created.","example":"2100-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_components-schemas-enabled":{"description":"If enabled, Total TLS will order a hostname specific TLS certificate for any proxied A, AAAA, or CNAME record in your zone.","example":true,"type":"boolean","x-auditable":true},"tls-certificates-and-hostnames_components-schemas-expires_on":{"description":"When the certificate will expire.","example":"2014-01-01 05:20:00 +0000 UTC","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_components-schemas-hostname":{"description":"The hostname for which the tls settings are set.","example":"app.example.com","type":"string","x-auditable":true},"tls-certificates-and-hostnames_components-schemas-private_key":{"description":"The private key for the certificate. This field is only needed for specific use cases such as using a custom certificate with Zero Trust's block page.","example":"-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDEXDkcICRU3XBv9hiiPnBWIjgTQyowmVFxDr11mONgZB/cMYjE/OvQjvnpwNcOaSK16MOpAjNbELKRx2lZiVJaLRDCccqCxXwP/CrdRChcqGzo7mbNksMlcidrErb0LlEBKLFC2QjRmRKqB+YOs4TD8WsZu2S667A2fZmjRlaqOxFi1h62ee0P+TLU628UC/nl41JifSt5Evt7hMDHakemdwZblNYr2p6T3NQjdhjYXTtP4UmOGJBhJ7i7Kicg3d3CIgdTMbggSeGWqjndr4ldVnD96FN3cVT5uDFsn2CJXTFgdeBWoUnMS4VnUZzPWGf4vSBXC8qV7Ls+w46yT7T1AgMBAAECggEAQZnp/oqCeNPOR6l5S2L+1tfx0gWjZ78hJVteUpZ0iHSK7F6kKeOxyOird7vUXV0kmo+cJq+0hp0Ke4eam640FCpwKfYoSQ4/R3vgujGWJnaihCN5tv5sMet0XeJPuz5qE7ALoKCvwI6aXLHs20aAeZIDTQJ9QbGSGnJVzOWn+JDTidIgZpN57RpXfSAwnJPTQK/PN8i5z108hsaDOdEgGmxYZ7kYqMqzX20KXmth58LDfPixs5JGtS60iiKC/wOcGzkB2/AdTSojR76oEU77cANP/3zO25NG//whUdYlW0t0d7PgXxIeJe+xgYnamDQJx3qonVyt4H77ha0ObRAj9QKBgQDicZr+VTwFMnELP3a+FXGnjehRiuS1i7MXGKxNweCD+dFlML0FplSQS8Ro2n+d8lu8BBXGx0qm6VXu8Rhn7TAUL6q+PCgfarzxfIhacb/TZCqfieIHsMlVBfhV5HCXnk+kis0tuC/PRArcWTwDHJUJXkBhvkUsNswvQzavDPI7KwKBgQDd/WgLkj7A3X5fgIHZH/GbDSBiXwzKb+rF4ZCT2XFgG/OAW7vapfcX/w+v+5lBLyrocmOAS3PGGAhM5T3HLnUCQfnK4qgps1Lqibkc9Tmnsn60LanUjuUMsYv/zSw70tozbzhJ0pioEpWfRxRZBztO2Rr8Ntm7h6Fk701EXGNAXwKBgQCD1xsjy2J3sCerIdcz0u5qXLAPkeuZW+34m4/ucdwTWwc0gEz9lhsULFj9p4G351zLuiEnq+7mAWLcDJlmIO3mQt6JhiLiL9Y0T4pgBmxmWqKKYtAsJB0EmMY+1BNN44mBRqMxZFTJu1cLdhT/xstrOeoIPqytknYNanfTMZlzIwKBgHrLXe5oq0XMP8dcMneEcAUwsaU4pr6kQd3L9EmUkl5zl7J9C+DaxWAEuwzBw/iGutlxzRB+rD/7szu14wJ29EqXbDGKRzMp+se5/yfBjm7xEZ1hVPw7PwBShfqt57X/4Ktq7lwHnmH6RcGhc+P7WBc5iO/S94YAdIp8xOT3pf9JAoGAE0QkqJUY+5Mgr+fBO0VNV72ZoPveGpW+De59uhKAOnu1zljQCUtk59m6+DXfm0tNYKtawa5n8iN71Zh+s62xXSt3pYi1Y5CCCmv8Y4BhwIcPwXKk3zEvLgSHVTpC0bayA9aSO4bbZgVXa5w+Z0w/vvfp9DWo1IS3EnQRrz6WMYA=\n-----END PRIVATE KEY-----","type":"string","x-sensitive":true},"tls-certificates-and-hostnames_components-schemas-serial_number":{"description":"The serial number on the created Client Certificate.","example":"3bb94ff144ac567b9f75ad664b6c55f8d5e48182","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_components-schemas-signature":{"description":"The type of hash used for the Client Certificate..","example":"SHA256WithRSA","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_components-schemas-status":{"description":"Status of the hostname's activation.","enum":["active","pending","active_redeploying","moved","pending_deletion","deleted","pending_blocked","pending_migration","pending_provisioned","test_pending","test_active","test_active_apex","test_blocked","test_failed","provisioned","blocked"],"example":"pending","type":"string","x-auditable":true},"tls-certificates-and-hostnames_components-schemas-updated_at":{"description":"The time when the certificate was updated.","example":"2100-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_components-schemas-uploaded_on":{"description":"The time when the certificate was uploaded.","example":"2019-10-28T18:11:23.37411Z","format":"date-time","type":"string","x-auditable":true},"tls-certificates-and-hostnames_components-schemas-validation_method":{"properties":{"validation_method":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_validation_method_definition"}},"required":["validation_method"],"type":"object"},"tls-certificates-and-hostnames_config":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname_certid_input"},"type":"array"},"tls-certificates-and-hostnames_country":{"description":"Country, provided by the CSR","example":"US","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_created_at":{"description":"This is the time the hostname was created.","example":"2020-02-06T18:11:23.531995Z","format":"date-time","type":"string","x-auditable":true},"tls-certificates-and-hostnames_csr":{"description":"The Certificate Signing Request (CSR). Must be newline-encoded.","example":"-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----","type":"string"},"tls-certificates-and-hostnames_custom-certificate":{"properties":{"bundle_method":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_bundle_method"},"expires_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_expires_on"},"geo_restrictions":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_geo_restrictions"},"hosts":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hosts"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"issuer":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_issuer"},"keyless_server":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless-certificate"},"modified_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_modified_on"},"policy":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_policy"},"priority":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_priority"},"signature":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_signature"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_status"},"uploaded_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_uploaded_on"},"zone_id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},"required":["id","hosts","issuer","signature","status","bundle_method","zone_id","uploaded_on","modified_on","expires_on","priority"],"type":"object"},"tls-certificates-and-hostnames_custom-hostname":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_customhostname"}],"properties":{"hostname":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"ssl":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ssl"}},"required":["id","hostname","ssl"],"type":"object"},"tls-certificates-and-hostnames_custom-hostname-fallback-origin_components-schemas-status":{"description":"Status of the fallback origin's activation.","enum":["initializing","pending_deployment","pending_deletion","active","deployment_timed_out","deletion_timed_out"],"example":"pending_deployment","type":"string","x-auditable":true},"tls-certificates-and-hostnames_custom-trust-store":{"properties":{"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate"},"expires_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-expires_on"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"issuer":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_issuer"},"signature":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_signature"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom-trust-store_components-schemas-status"},"updated_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-updated_at"},"uploaded_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_uploaded_on"}},"required":["id","status","issuer","signature","certificate","expires_on","uploaded_on","updated_at"],"type":"object"},"tls-certificates-and-hostnames_custom-trust-store_components-schemas-status":{"description":"Status of the zone's custom SSL.","enum":["initializing","pending_deployment","active","pending_deletion","deleted","expired"],"example":"active","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_custom_cert_and_key":{"properties":{"custom_certificate":{"description":"If a custom uploaded certificate is used.","example":"-----BEGIN CERTIFICATE-----\nMIIDdjCCAl6gAwIBAgIJAPnMg0Fs+/B0MA0GCSqGSIb3DQEBCwUAMFsx...\n-----END CERTIFICATE-----\n","type":"string"},"custom_key":{"description":"The key for a custom uploaded certificate.","example":"-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC/SCB5...\n-----END PRIVATE KEY-----\n","type":"string","x-sensitive":true}},"required":["custom_certificate","custom_key"],"type":"object"},"tls-certificates-and-hostnames_custom_cert_bundle":{"description":"Array of custom certificate and key pairs (1 or 2 pairs allowed)","items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_cert_and_key"},"maxItems":2,"minItems":1,"type":"array"},"tls-certificates-and-hostnames_custom_hostname_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom-hostname"},"type":"array"}}}]},"tls-certificates-and-hostnames_custom_hostname_response_single":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom-hostname"}],"type":"object"}}}]},"tls-certificates-and-hostnames_custom_metadata":{"additionalProperties":{"type":"string","x-auditable":true},"description":"Unique key/value metadata for this hostname. These are per-hostname (customer) settings.","type":"object"},"tls-certificates-and-hostnames_custom_origin_server":{"description":"a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.","example":"origin2.example.com","type":"string","x-auditable":true},"tls-certificates-and-hostnames_custom_origin_sni":{"description":"A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':request_host_header:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server.","example":"sni.example.com","type":"string","x-auditable":true},"tls-certificates-and-hostnames_custom_trust_store_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom-trust-store"},"type":"array"}}}]},"tls-certificates-and-hostnames_custom_trust_store_response_id_only":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},"type":"object"}}}]},"tls-certificates-and-hostnames_custom_trust_store_response_single":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom-trust-store"}}}]},"tls-certificates-and-hostnames_customhostname":{"properties":{"created_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_created_at"},"custom_metadata":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_metadata"},"custom_origin_server":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_origin_server"},"custom_origin_sni":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_origin_sni"},"hostname":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"ownership_verification":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ownership_verification"},"ownership_verification_http":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ownership_verification_http"},"ssl":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ssl"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-status"},"verification_errors":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_verification_errors"}}},"tls-certificates-and-hostnames_dcv_delegation_response":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_uuidObject"}],"type":"object"}}}]},"tls-certificates-and-hostnames_delete_advanced_certificate_pack_response_single":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},"type":"object"}},"type":"object"}]},"tls-certificates-and-hostnames_enabled":{"description":"Whether or not the Keyless SSL is on or off.","example":false,"readOnly":true,"type":"boolean","x-auditable":true},"tls-certificates-and-hostnames_enabled_response":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"properties":{"enabled":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled"}}}}}]},"tls-certificates-and-hostnames_enabled_write":{"deprecated":true,"description":"Whether or not the Keyless SSL is on or off.","example":false,"type":"boolean","x-auditable":true},"tls-certificates-and-hostnames_errors":{"description":"These are errors that were encountered while trying to activate a fallback origin.","example":["DNS records are not setup correctly. Origin should be a proxied A/AAAA/CNAME dns record"],"items":{"type":"string","x-auditable":true},"type":"array"},"tls-certificates-and-hostnames_expired_on":{"description":"Date that the Client Certificate expires","example":"2033-02-20T23:18:00Z","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_expires_on":{"description":"When the certificate from the authority expires.","example":"2016-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_fallback_origin_response":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_fallbackorigin"}}}]},"tls-certificates-and-hostnames_fallbackorigin":{"properties":{"created_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-created_at"},"errors":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_errors"},"origin":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_origin"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom-hostname-fallback-origin_components-schemas-status"},"updated_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_updated_at"}}},"tls-certificates-and-hostnames_fingerprint_sha256":{"description":"Unique identifier of the Client Certificate","example":"256c24690243359fb8cf139a125bd05ebf1d968b71e4caf330718e9f5c8a89ea","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_geo_restrictions":{"description":"Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.","properties":{"label":{"enum":["us","eu","highest_security"],"example":"us","type":"string","x-auditable":true}},"type":"object"},"tls-certificates-and-hostnames_host":{"description":"The keyless SSL name.","example":"example.com","format":"hostname","maxLength":253,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_hostname":{"description":"The custom hostname that will point to your hostname via CNAME.","example":"app.example.com","maxLength":255,"readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_hostname-authenticated-origin-pull":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname_certid_object"}],"properties":{"cert_id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate"},"enabled":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled"},"hostname":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-hostname"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"private_key":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-private_key"}},"type":"object"},"tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate":{"description":"The hostname certificate.","example":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","type":"string"},"tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull"},"type":"array"}}}]},"tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-certificateObject"}}}]},"tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled":{"description":"Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association.","example":true,"nullable":true,"type":"boolean","x-auditable":true},"tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-expires_on":{"description":"The date when the certificate expires.","example":"2100-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status":{"description":"Status of the certificate or the association.","enum":["initializing","pending_deployment","pending_deletion","active","deleted","deployment_timed_out","deletion_timed_out"],"example":"active","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-created_at":{"description":"This is the time the tls setting was originally created for this hostname.","example":"2023-07-10T20:01:50.219171Z","format":"date-time","type":"string","x-auditable":true},"tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status":{"description":"Deployment status for the given tls setting.","example":"pending_deployment","type":"string","x-auditable":true},"tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-updated_at":{"description":"This is the time the tls setting was updated.","example":"2023-07-10T20:01:50.219171Z","format":"date-time","type":"string","x-auditable":true},"tls-certificates-and-hostnames_hostname_aop_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull"},"type":"array"}}}]},"tls-certificates-and-hostnames_hostname_aop_single_response":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname_certid_object"}}}]},"tls-certificates-and-hostnames_hostname_association":{"properties":{"hostnames":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-hostnames"},"mtls_certificate_id":{"description":"The UUID for a certificate that was uploaded to the mTLS Certificate Management endpoint. If no mtls_certificate_id is given, the hostnames will be associated to your active Cloudflare Managed CA.","maxLength":36,"minLength":36,"type":"string","x-auditable":true}},"type":"object"},"tls-certificates-and-hostnames_hostname_associations_response":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"properties":{"hostnames":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-hostnames"}},"type":"object"}}}]},"tls-certificates-and-hostnames_hostname_certid_input":{"properties":{"cert_id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_cert_id"},"enabled":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled"},"hostname":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-hostname"}},"type":"object"},"tls-certificates-and-hostnames_hostname_certid_object":{"properties":{"cert_id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"cert_status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status"},"cert_updated_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-updated_at"},"cert_uploaded_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-uploaded_on"},"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate"},"created_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-created_at"},"enabled":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled"},"expires_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-expires_on"},"hostname":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-hostname"},"issuer":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_issuer"},"serial_number":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_serial_number"},"signature":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_signature"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status"},"updated_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-updated_at"}}},"tls-certificates-and-hostnames_hostname_post":{"description":"The custom hostname that will point to your hostname via CNAME.","example":"app.example.com","maxLength":255,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_hostnames":{"description":"Array of hostnames or wildcard names (e.g., *.example.com) bound to the certificate.","example":["example.com","*.example.com"],"items":{"type":"string","x-auditable":true},"type":"array"},"tls-certificates-and-hostnames_hosts":{"items":{"description":"The valid hosts for the certificates.","example":"example.com","maxLength":253,"readOnly":true,"type":"string","x-auditable":true},"type":"array"},"tls-certificates-and-hostnames_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_issued_on":{"description":"Date that the Client Certificate was issued by the Certificate Authority","example":"2023-02-23T23:18:00Z","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_issuer":{"description":"The certificate authority that issued the certificate.","example":"GlobalSign","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_keyless-certificate":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_base"}],"type":"object"},"tls-certificates-and-hostnames_keyless_private_ip":{"description":"Private IP of the Key Server Host","example":"10.0.0.1","type":"string","x-auditable":true},"tls-certificates-and-hostnames_keyless_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless-certificate"},"type":"array"}}}]},"tls-certificates-and-hostnames_keyless_response_single":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_base"}],"type":"object"}}}]},"tls-certificates-and-hostnames_keyless_response_single_id":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},"type":"object"}}}]},"tls-certificates-and-hostnames_keyless_tunnel":{"description":"Configuration for using Keyless SSL through a Cloudflare Tunnel","properties":{"private_ip":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_private_ip"},"vnet_id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_vnet_id"}},"required":["private_ip","vnet_id"],"type":"object"},"tls-certificates-and-hostnames_keyless_vnet_id":{"description":"Cloudflare Tunnel Virtual Network ID","example":"7365377a-85a4-4390-9480-531ef7dc7a3c","type":"string","x-auditable":true},"tls-certificates-and-hostnames_location":{"description":"Location, provided by the CSR","example":"Somewhere","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"tls-certificates-and-hostnames_modified_on":{"description":"When the certificate was last modified.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificateObject"},"type":"array"}}},{"properties":{"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":50},"total_count":{"example":1},"total_pages":{"description":"Total pages available of results","example":1,"type":"number"}},"type":"object"}}}]},"tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificateObject"}],"type":"object"}}}]},"tls-certificates-and-hostnames_mtls-management_components-schemas-status":{"description":"Certificate deployment status for the given service.","example":"pending_deployment","type":"string","x-auditable":true},"tls-certificates-and-hostnames_mtls-management_components-schemas-updated_at":{"description":"This is the time the certificate was updated.","example":"2022-11-22T17:32:30.467938Z","format":"date-time","type":"string","x-auditable":true},"tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on":{"description":"This is the time the certificate was uploaded.","example":"2022-11-22T17:32:30.467938Z","format":"date-time","type":"string","x-auditable":true},"tls-certificates-and-hostnames_name":{"description":"The keyless SSL name.","example":"example.com Keyless SSL","maxLength":180,"readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_name_write":{"description":"The keyless SSL name.","example":"example.com Keyless SSL","maxLength":180,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_organization":{"description":"Organization, provided by the CSR","example":"Organization","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_organizational_unit":{"description":"Organizational Unit, provided by the CSR","example":"Organizational Unit","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_origin":{"description":"Your origin hostname that requests to your custom hostnames will be sent to.","example":"fallback.example.com","maxLength":255,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_ownership_verification":{"description":"This is a record which can be placed to activate a hostname.","oneOf":[{"properties":{"name":{"description":"DNS Name for record.","example":"_cf-custom-hostname.app.example.com","type":"string","x-auditable":true},"type":{"description":"DNS Record type.","enum":["txt"],"example":"txt","type":"string","x-auditable":true},"value":{"description":"Content for the record.","example":"5cc07c04-ea62-4a5a-95f0-419334a875a4","type":"string"}},"type":"object"}],"type":"object"},"tls-certificates-and-hostnames_ownership_verification_http":{"description":"This presents the token to be served by the given http url to activate a hostname.","oneOf":[{"properties":{"http_body":{"description":"Token to be served.","example":"5cc07c04-ea62-4a5a-95f0-419334a875a4","type":"string"},"http_url":{"description":"The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.","example":"http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9","type":"string"}},"type":"object"}],"type":"object"},"tls-certificates-and-hostnames_per_hostname_settings_response":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_settingObject"}],"type":"object"}}}]},"tls-certificates-and-hostnames_per_hostname_settings_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-collection"},{"properties":{"result":{"items":{"properties":{"created_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-created_at"},"hostname":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status"},"updated_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-updated_at"},"value":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_value"}}},"type":"array"}}},{"properties":{"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":50},"total_count":{"example":1},"total_pages":{"description":"Total pages available of results","example":1,"type":"number"}},"type":"object"}}}]},"tls-certificates-and-hostnames_per_hostname_settings_response_delete":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_settingObjectDelete"}],"type":"object"}}}]},"tls-certificates-and-hostnames_policy":{"description":"Specify the policy that determines the region where your private key will be held locally. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Any combination of countries, specified by their two letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) can be chosen, such as 'country: IN', as well as 'region: EU' which refers to the EU region. If there are too few data centers satisfying the policy, it will be rejected.","example":"(country: US) or (region: EU)","type":"string","x-auditable":true},"tls-certificates-and-hostnames_port":{"default":24008,"description":"The keyless SSL port used to communicate between Cloudflare and the client's Keyless SSL server.","example":24008,"maxLength":65535,"type":"number","x-auditable":true},"tls-certificates-and-hostnames_primary":{"description":"Identifier of the primary certificate in a pack.","example":"7e7b8deba8538af625850b7b2530034c","type":"string","x-auditable":true},"tls-certificates-and-hostnames_priority":{"default":0,"description":"The order/priority in which the certificate will be used in a request. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.","example":1,"type":"number","x-auditable":true},"tls-certificates-and-hostnames_private_key":{"description":"The zone's private key.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","type":"string","x-sensitive":true},"tls-certificates-and-hostnames_quota":{"properties":{"allocated":{"description":"Quantity Allocated.","type":"integer","x-auditable":true},"used":{"description":"Quantity Used.","type":"integer","x-auditable":true}},"type":"object"},"tls-certificates-and-hostnames_request_type":{"description":"Signature type desired on certificate (\"origin-rsa\" (rsa), \"origin-ecc\" (ecdsa), or \"keyless-certificate\" (for Keyless SSL servers).","enum":["origin-rsa","origin-ecc","keyless-certificate"],"example":"origin-rsa","type":"string","x-auditable":true},"tls-certificates-and-hostnames_requested_validity":{"default":5475,"description":"The number of days for which the certificate should be valid.","enum":[7,30,90,365,730,1095,5475],"example":5475,"type":"number","x-auditable":true},"tls-certificates-and-hostnames_revoked_at":{"description":"When the certificate was revoked.","example":"2024-09-06T18:43:47.928893Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-certificate":{"description":"The zone's SSL certificate or SSL certificate and intermediate(s).","example":"-----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= -----END CERTIFICATE-----","type":"string"},"tls-certificates-and-hostnames_schemas-certificateObject":{"properties":{"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate"},"expires_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-expires_on"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"issuer":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_issuer"},"serial_number":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_serial_number"},"signature":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_signature"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status"},"uploaded_on":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-uploaded_on"}}},"tls-certificates-and-hostnames_schemas-certificate_authority":{"description":"Certificate Authority selected for the order.  For information on any certificate authority specific details or restrictions [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities)","enum":["google","lets_encrypt","ssl_com"],"example":"lets_encrypt","type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificates"},"type":"array"}},"type":"object"}]},"tls-certificates-and-hostnames_schemas-certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificates"}},"type":"object"}]},"tls-certificates-and-hostnames_schemas-certificates":{"description":"The uploaded root CA certificate.","example":"-----BEGIN CERTIFICATE-----\nMIIDmDCCAoCgAwIBAgIUKTOAZNjcXVZRj4oQt0SHsl1c1vMwDQYJKoZIhvcNAQELBQAwUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjAgFw0yMjExMjIxNjU5NDdaGA8yMTIyMTAyOTE2NTk0N1owUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMRcORwgJFTdcG/2GKI+cFYiOBNDKjCZUXEOvXWY42BkH9wxiMT869CO+enA1w5pIrXow6kCM1sQspHHaVmJUlotEMJxyoLFfA/8Kt1EKFyobOjuZs2SwyVyJ2sStvQuUQEosULZCNGZEqoH5g6zhMPxaxm7ZLrrsDZ9maNGVqo7EWLWHrZ57Q/5MtTrbxQL+eXjUmJ9K3kS+3uEwMdqR6Z3BluU1ivanpPc1CN2GNhdO0/hSY4YkGEnuLsqJyDd3cIiB1MxuCBJ4ZaqOd2viV1WcP3oU3dxVPm4MWyfYIldMWB14FahScxLhWdRnM9YZ/i9IFcLypXsuz7DjrJPtPUCAwEAAaNmMGQwHQYDVR0OBBYEFP5JzLUawNF+c3AXsYTEWHh7z2czMB8GA1UdIwQYMBaAFP5JzLUawNF+c3AXsYTEWHh7z2czMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEBMA0GCSqGSIb3DQEBCwUAA4IBAQBc+Be7NDhpE09y7hLPZGRPl1cSKBw4RI0XIv6rlbSTFs5EebpTGjhx/whNxwEZhB9HZ7111Oa1YlT8xkI9DshB78mjAHCKBAJ76moK8tkG0aqdYpJ4ZcJTVBB7l98Rvgc7zfTii7WemTy72deBbSeiEtXavm4EF0mWjHhQ5Nxpnp00Bqn5g1x8CyTDypgmugnep+xG+iFzNmTdsz7WI9T/7kDMXqB7M/FPWBORyS98OJqNDswCLF8bIZYwUBEe+bRHFomoShMzaC3tvim7WCb16noDkSTMlfKO4pnvKhpcVdSgwcruATV7y+W+Lvmz2OT/Gui4JhqeoTewsxndhDDE\n-----END CERTIFICATE-----","type":"string"},"tls-certificates-and-hostnames_schemas-created_at":{"description":"This is the time the fallback origin was created.","example":"2019-10-28T18:11:23.37411Z","format":"date-time","type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-csr":{"description":"The Certificate Signing Request (CSR). Must be newline-encoded.","example":"-----BEGIN CERTIFICATE REQUEST-----\\nMIICY....\\n-----END CERTIFICATE REQUEST-----\\n","type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-enabled":{"description":"Disabling Universal SSL removes any currently active Universal SSL certificates for your zone from the edge and prevents any future Universal SSL certificates from being ordered. If there are no advanced certificates or custom certificates uploaded for the domain, visitors will be unable to access the domain over HTTPS.\n\nBy disabling Universal SSL, you understand that the following Cloudflare settings and preferences will result in visitors being unable to visit your domain unless you have uploaded a custom certificate or purchased an advanced certificate.\n\n* HSTS\n* Always Use HTTPS\n* Opportunistic Encryption\n* Onion Routing\n* Any Page Rules redirecting traffic to HTTPS\n\nSimilarly, any HTTP redirect to HTTPS at the origin while the Cloudflare proxy is enabled will result in users being unable to visit your site without a valid certificate at Cloudflare's edge.\n\nIf you do not have a valid custom or advanced certificate at Cloudflare's edge and are unsure if any of the above Cloudflare settings are enabled, or if any HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for your domain.","example":true,"type":"boolean","x-auditable":true},"tls-certificates-and-hostnames_schemas-expires_on":{"description":"When the certificate expires.","example":"2122-10-29T16:59:47Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-hostname":{"description":"The hostname on the origin for which the client certificate uploaded will be used.","example":"app.example.com","maxLength":255,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-hostnames":{"items":{"example":"api.example.com","type":"string","x-auditable":true},"type":"array"},"tls-certificates-and-hostnames_schemas-hosts":{"description":"Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.","example":["example.com","*.example.com","www.example.com"],"items":{"type":"string","x-auditable":true},"type":"array"},"tls-certificates-and-hostnames_schemas-identifier":{"description":"Keyless certificate identifier tag.","example":"4d2844d2ce78891c34d0b6c0535a291e","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-issuer":{"description":"The certificate authority that issued the certificate.","example":"O=Example Inc.,L=California,ST=San Francisco,C=US","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-name":{"description":"Optional unique name for the certificate. Only used for human readability.","example":"example_ca_cert","type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-private_key":{"description":"The hostname certificate's private key.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","type":"string","x-sensitive":true},"tls-certificates-and-hostnames_schemas-serial_number":{"description":"The certificate serial number.","example":"235217144297995885180570755458463043449861756659","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-signature":{"description":"Certificate's signature algorithm.","enum":["ECDSAWithSHA256","SHA1WithRSA","SHA256WithRSA"],"type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-status":{"description":"Status of the Keyless SSL.","enum":["active","deleted"],"example":"active","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-type":{"description":"Type of certificate pack.","enum":["mh_custom","managed_hostname","sni_custom","universal","advanced","total_tls","keyless","legacy_custom"],"example":"universal","type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-updated_at":{"description":"When the certificate was last modified.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-uploaded_on":{"description":"This is the time the certificate was uploaded.","example":"2019-10-28T18:11:23.37411Z","format":"date-time","type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-validation_method":{"description":"Validation method in use for a certificate pack order.","enum":["http","cname","txt"],"example":"txt","type":"string","x-auditable":true},"tls-certificates-and-hostnames_schemas-validity_days":{"description":"The number of days the Client Certificate will be valid after the issued_on date","example":3650,"type":"integer","x-auditable":true},"tls-certificates-and-hostnames_serial_number":{"description":"The serial number on the uploaded certificate.","example":"6743787633689793699141714808227354901","type":"string","x-auditable":true},"tls-certificates-and-hostnames_service":{"description":"The service using the certificate.","example":"gateway","type":"string","x-auditable":true},"tls-certificates-and-hostnames_settingObject":{"properties":{"created_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-created_at"},"hostname":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status"},"updated_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-updated_at"},"value":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_value"}}},"tls-certificates-and-hostnames_settingObjectDelete":{"properties":{"created_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-created_at"},"hostname":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname"},"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status"},"updated_at":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-updated_at"},"value":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_value"}}},"tls-certificates-and-hostnames_setting_id":{"description":"The TLS Setting name.","enum":["ciphers","min_tls_version","http2"],"type":"string","x-auditable":true},"tls-certificates-and-hostnames_signature":{"description":"The type of hash used for the certificate.","example":"SHA256WithRSA","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_ski":{"description":"Subject Key Identifier","example":"8e375af1389a069a0f921f8cc8e1eb12d784b949","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_ssl":{"description":"SSL properties for the custom hostname.","oneOf":[{"properties":{"bundle_method":{"default":"ubiquitous","description":"A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.","enum":["ubiquitous","optimal","force"],"example":"ubiquitous","type":"string","x-auditable":true},"certificate_authority":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_authority"},"custom_certificate":{"description":"If a custom uploaded certificate is used.","example":"-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n","type":"string"},"custom_csr_id":{"description":"The identifier for the Custom CSR that was used.","example":"7b163417-1d2b-4c84-a38a-2fb7a0cd7752","type":"string","x-auditable":true},"custom_key":{"description":"The key for a custom uploaded certificate.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","type":"string","x-sensitive":true},"expires_on":{"description":"The time the custom certificate expires on.","example":"2021-02-06T18:11:23.531995Z","format":"date-time","type":"string","x-auditable":true},"hosts":{"description":"A list of Hostnames on a custom uploaded certificate.","example":["app.example.com","*.app.example.com"],"items":{"type":"string","x-auditable":true},"type":"array"},"id":{"description":"Custom hostname SSL identifier tag.","example":"0d89c70d-ad9f-4843-b99f-6cc0252067e9","maxLength":36,"minLength":36,"type":"string","x-auditable":true},"issuer":{"description":"The issuer on a custom uploaded certificate.","example":"DigiCertInc","type":"string","x-auditable":true},"method":{"description":"Domain control validation (DCV) method used for this hostname.","enum":["http","txt","email"],"example":"txt","type":"string","x-auditable":true},"serial_number":{"description":"The serial number on a custom uploaded certificate.","example":"6743787633689793699141714808227354901","type":"string","x-auditable":true},"settings":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_sslsettings"},"signature":{"description":"The signature on a custom uploaded certificate.","example":"SHA256WithRSA","type":"string","x-auditable":true},"status":{"description":"Status of the hostname's SSL certificates.","enum":["initializing","pending_validation","deleted","pending_issuance","pending_deployment","pending_deletion","pending_expiration","expired","active","initializing_timed_out","validation_timed_out","issuance_timed_out","deployment_timed_out","deletion_timed_out","pending_cleanup","staging_deployment","staging_active","deactivating","inactive","backup_issued","holding_deployment"],"example":"pending_validation","readOnly":true,"type":"string","x-auditable":true},"type":{"description":"Level of validation to be used for this hostname. Domain validation (dv) must be used.","enum":["dv"],"example":"dv","type":"string","x-auditable":true},"uploaded_on":{"description":"The time the custom certificate was uploaded.","example":"2020-02-06T18:11:23.531995Z","format":"date-time","type":"string","x-auditable":true},"validation_errors":{"description":"Domain validation errors that have been received by the certificate authority (CA).","items":{"properties":{"message":{"description":"A domain validation error.","example":"SERVFAIL looking up CAA for app.example.com","type":"string","x-auditable":true}},"type":"object"},"type":"array"},"validation_records":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_validation_record"},"type":"array"},"wildcard":{"description":"Indicates whether the certificate covers a wildcard.","example":false,"type":"boolean","x-auditable":true}},"type":"object"}],"type":"object"},"tls-certificates-and-hostnames_ssl_universal_settings_response":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_universal"}}}]},"tls-certificates-and-hostnames_ssl_validation_method_response_collection":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"properties":{"status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_validation_method_components-schemas-status"},"validation_method":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_validation_method_definition"}}}}}]},"tls-certificates-and-hostnames_ssl_verification_response_collection":{"allOf":[{"properties":{"result":{"items":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_verification"},"type":"array"}}}]},"tls-certificates-and-hostnames_sslpost":{"description":"SSL properties used when creating the custom hostname.","oneOf":[{"properties":{"bundle_method":{"default":"ubiquitous","description":"A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.","enum":["ubiquitous","optimal","force"],"example":"ubiquitous","type":"string","x-auditable":true},"certificate_authority":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_authority"},"cloudflare_branding":{"description":"Whether or not to add Cloudflare Branding for the order.  This will add a subdomain of sni.cloudflaressl.com as the Common Name if set to true","example":false,"type":"boolean","x-auditable":true},"custom_cert_bundle":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_cert_bundle"},"custom_certificate":{"description":"If a custom uploaded certificate is used.","example":"-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n","type":"string","x-auditable":true},"custom_key":{"description":"The key for a custom uploaded certificate.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","type":"string","x-sensitive":true},"method":{"description":"Domain control validation (DCV) method used for this hostname.","enum":["http","txt","email"],"example":"http","type":"string","x-auditable":true},"settings":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_sslsettings"},"type":{"description":"Level of validation to be used for this hostname. Domain validation (dv) must be used.","enum":["dv"],"example":"dv","type":"string","x-auditable":true},"wildcard":{"description":"Indicates whether the certificate covers a wildcard.","example":false,"type":"boolean","x-auditable":true}},"type":"object"}],"type":"object"},"tls-certificates-and-hostnames_sslsettings":{"description":"SSL specific settings.","properties":{"ciphers":{"description":"An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.","example":["ECDHE-RSA-AES128-GCM-SHA256","AES128-SHA"],"items":{"type":"string","x-auditable":true},"type":"array","uniqueItems":true},"early_hints":{"description":"Whether or not Early Hints is enabled.","enum":["on","off"],"example":"on","type":"string","x-auditable":true},"http2":{"description":"Whether or not HTTP2 is enabled.","enum":["on","off"],"example":"on","type":"string","x-auditable":true},"min_tls_version":{"description":"The minimum TLS version supported.","enum":["1.0","1.1","1.2","1.3"],"example":"1.2","type":"string","x-auditable":true},"tls_1_3":{"description":"Whether or not TLS 1.3 is enabled.","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"type":"object"},"tls-certificates-and-hostnames_state":{"description":"State, provided by the CSR","example":"CA","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_status":{"description":"Status of the zone's custom SSL.","enum":["active","expired","deleted","pending","initializing"],"example":"active","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_total_tls_settings_response":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-single"},{"properties":{"result":{"properties":{"certificate_authority":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_authority"},"enabled":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-enabled"},"validity_period":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_validity_period"}}}}}]},"tls-certificates-and-hostnames_type":{"default":"legacy_custom","description":"The type 'legacy_custom' enables support for legacy clients which do not include SNI in the TLS handshake.","enum":["legacy_custom","sni_custom"],"example":"sni_custom","type":"string","x-auditable":true},"tls-certificates-and-hostnames_universal":{"properties":{"enabled":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-enabled"}},"type":"object"},"tls-certificates-and-hostnames_updated_at":{"description":"This is the time the fallback origin was updated.","example":"2020-03-16T18:11:23.531995Z","format":"date-time","type":"string","x-auditable":true},"tls-certificates-and-hostnames_uploaded_on":{"description":"When the certificate was uploaded to Cloudflare.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_uuid":{"description":"The DCV Delegation unique identifier.","example":"abc123def456ghi7","type":"string","x-auditable":true},"tls-certificates-and-hostnames_uuidObject":{"properties":{"uuid":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_uuid"}}},"tls-certificates-and-hostnames_validation_method":{"description":"Validation Method selected for the order.","enum":["txt","http","email"],"example":"txt","type":"string","x-auditable":true},"tls-certificates-and-hostnames_validation_method_components-schemas-status":{"description":"Result status.","example":"pending_validation","type":"string","x-auditable":true},"tls-certificates-and-hostnames_validation_method_definition":{"description":"Desired validation method.","enum":["http","cname","txt","email"],"example":"txt","type":"string","x-auditable":true},"tls-certificates-and-hostnames_validation_record":{"description":"Certificate's required validation record.","properties":{"emails":{"description":"The set of email addresses that the certificate authority (CA) will use to complete domain validation.","example":["administrator@example.com","webmaster@example.com"],"items":{"type":"string","x-auditable":true},"type":"array"},"http_body":{"description":"The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.","example":"ca3-574923932a82475cb8592200f1a2a23d","type":"string"},"http_url":{"description":"The url that will be checked during domain validation.","example":"http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt","type":"string"},"txt_name":{"description":"The hostname that the certificate authority (CA) will check for a TXT record during domain validation .","example":"_acme-challenge.app.example.com","type":"string","x-auditable":true},"txt_value":{"description":"The TXT record that the certificate authority (CA) will check during domain validation.","example":"810b7d5f01154524b961ba0cd578acc2","type":"string"}},"type":"object"},"tls-certificates-and-hostnames_validity_days":{"description":"Validity Days selected for the order.","enum":[14,30,90,365],"type":"integer","x-auditable":true},"tls-certificates-and-hostnames_validity_period":{"description":"The validity period in days for the certificates ordered via Total TLS.","enum":[90],"type":"integer","x-auditable":true},"tls-certificates-and-hostnames_value":{"description":"The tls setting value.","example":["ECDHE-RSA-AES128-GCM-SHA256","AES128-GCM-SHA256"],"oneOf":[{"type":"number","x-auditable":true},{"type":"string","x-auditable":true},{"items":{"type":"string","x-auditable":true},"type":"array"}]},"tls-certificates-and-hostnames_verification":{"properties":{"brand_check":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_brand_check"},"cert_pack_uuid":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_cert_pack_uuid"},"certificate_status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_status"},"signature":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-signature"},"validation_method":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-validation_method"},"verification_info":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_verification_info"},"verification_status":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_verification_status"},"verification_type":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_verification_type"}},"required":["certificate_status"],"type":"object"},"tls-certificates-and-hostnames_verification_errors":{"description":"These are errors that were encountered while trying to activate a hostname.","example":["None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found."],"items":{"type":"string","x-auditable":true},"type":"array"},"tls-certificates-and-hostnames_verification_info":{"description":"Certificate's required verification information.","properties":{"record_name":{"description":"Name of CNAME record.","enum":["record_name","http_url","cname","txt_name"],"example":"b3b90cfedd89a3e487d3e383c56c4267.example.com","format":"hostname","type":"string","x-auditable":true},"record_target":{"description":"Target of CNAME record.","enum":["record_value","http_body","cname_target","txt_value"],"example":"6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com","format":"hostname","type":"string","x-auditable":true}},"type":"object"},"tls-certificates-and-hostnames_verification_status":{"description":"Status of the required verification information, omitted if verification status is unknown.","example":true,"type":"boolean","x-auditable":true},"tls-certificates-and-hostnames_verification_type":{"description":"Method of verification.","enum":["cname","meta tag"],"example":"cname","type":"string","x-auditable":true},"tls-certificates-and-hostnames_zone-authenticated-origin-pull":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificateObject"}],"properties":{"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate"},"enabled":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"private_key":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_private_key"}},"type":"object"},"tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate":{"description":"The zone's leaf certificate.","example":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","type":"string"},"tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled":{"description":"Indicates whether zone-level authenticated origin pulls is enabled.","example":true,"type":"boolean","x-auditable":true},"tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-expires_on":{"description":"When the certificate from the authority expires.","example":"2100-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-status":{"description":"Status of the certificate activation.","enum":["initializing","pending_deployment","pending_deletion","active","deleted","deployment_timed_out","deletion_timed_out"],"example":"active","type":"string","x-auditable":true},"tunnel_account_id":{"description":"Cloudflare account ID","example":"699d98642c564d2e855e9661899b7252","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"tunnel_address_family":{"description":"IP address family, either `v4` (IPv4) or `v6` (IPv6)","enum":["v4","v6"],"example":"v4","type":"string"},"tunnel_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-common"},{"properties":{"result":{"items":{},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/tunnel_result_info"}}}],"type":"object"},"tunnel_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/tunnel_messages"},"messages":{"$ref":"#/components/schemas/tunnel_messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"tunnel_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/tunnel_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/tunnel_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"tunnel_api-response-single":{"$ref":"#/components/schemas/tunnel_api-response-common"},"tunnel_arch":{"description":"The cloudflared OS architecture used to establish this connection.","example":"linux_amd64","type":"string"},"tunnel_argo-tunnel":{"properties":{"connections":{"description":"The tunnel connections between your origin and Cloudflare's edge.","items":{"$ref":"#/components/schemas/tunnel_connection"},"type":"array"},"created_at":{"$ref":"#/components/schemas/tunnel_created_at"},"deleted_at":{"$ref":"#/components/schemas/tunnel_deleted_at"},"id":{"$ref":"#/components/schemas/tunnel_tunnel_id"},"name":{"$ref":"#/components/schemas/tunnel_tunnel_name"}},"required":["id","name","created_at","connections"],"type":"object"},"tunnel_cfd-tunnel-response-collection":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tunnel_cfd_tunnel"},"type":"array"}},"type":"object"}]},"tunnel_cfd-tunnel-response-single":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/tunnel_cfd_tunnel"}},"type":"object"}]},"tunnel_cfd_tunnel":{"description":"A Cloudflare Tunnel that connects your origin to Cloudflare's edge.","properties":{"account_tag":{"$ref":"#/components/schemas/tunnel_account_id"},"config_src":{"$ref":"#/components/schemas/tunnel_config_src"},"connections":{"$ref":"#/components/schemas/tunnel_connections_deprecated"},"conns_active_at":{"$ref":"#/components/schemas/tunnel_conns_active_at"},"conns_inactive_at":{"$ref":"#/components/schemas/tunnel_conns_inactive_at"},"created_at":{"$ref":"#/components/schemas/tunnel_created_at"},"deleted_at":{"$ref":"#/components/schemas/tunnel_deleted_at"},"id":{"$ref":"#/components/schemas/tunnel_tunnel_id"},"metadata":{"$ref":"#/components/schemas/tunnel_metadata"},"name":{"$ref":"#/components/schemas/tunnel_tunnel_name"},"remote_config":{"$ref":"#/components/schemas/tunnel_remote_config"},"status":{"$ref":"#/components/schemas/tunnel_status"},"tun_type":{"$ref":"#/components/schemas/tunnel_tunnel_type"}},"type":"object"},"tunnel_client_id":{"description":"UUID of the Cloudflare Tunnel connector.","example":"1bedc50d-42b3-473c-b108-ff3d10c0d925","format":"uuid","maxLength":36,"readOnly":true,"type":"string","x-auditable":true},"tunnel_colo_name":{"description":"The Cloudflare data center used for this connection.","example":"DFW","type":"string"},"tunnel_components-schemas-tunnel_id":{"description":"UUID of the tunnel.","example":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","format":"uuid","maxLength":36,"type":"string","x-auditable":true},"tunnel_config":{"description":"The tunnel configuration and ingress rules.","properties":{"ingress":{"description":"List of public hostname definitions. At least one ingress rule needs to be defined for the tunnel.","items":{"$ref":"#/components/schemas/tunnel_ingressRule"},"minItems":1,"type":"array"},"originRequest":{"$ref":"#/components/schemas/tunnel_originRequest"},"warp-routing":{"deprecated":true,"description":"Enable private network access from WARP users to private network routes. This is enabled if the tunnel has an assigned route.","properties":{"enabled":{"type":"boolean"}},"readOnly":true,"type":"object","x-stainless-deprecation-message":"This field is ignored by cloudflared since version 2023.10.0.","x-stainless-skip":true}},"type":"object"},"tunnel_config_src":{"default":"local","description":"Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.","enum":["local","cloudflare"],"example":"cloudflare","type":"string"},"tunnel_config_version":{"description":"The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard.","type":"integer"},"tunnel_configuration":{"description":"Cloudflare Tunnel configuration","properties":{"account_id":{"$ref":"#/components/schemas/tunnel_identifier"},"config":{"$ref":"#/components/schemas/tunnel_config"},"created_at":{"$ref":"#/components/schemas/tunnel_timestamp"},"source":{"$ref":"#/components/schemas/tunnel_schemas-config_src"},"tunnel_id":{"$ref":"#/components/schemas/tunnel_schemas-tunnel_id"},"version":{"$ref":"#/components/schemas/tunnel_schemas-config_version"}},"type":"object"},"tunnel_configuration_response":{"allOf":[{"$ref":"#/components/schemas/tunnel_schemas-api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tunnel_configuration"}}}]},"tunnel_connection":{"properties":{"colo_name":{"$ref":"#/components/schemas/tunnel_colo_name"},"is_pending_reconnect":{"$ref":"#/components/schemas/tunnel_is_pending_reconnect"},"uuid":{"$ref":"#/components/schemas/tunnel_connection_id"}}},"tunnel_connection_id":{"description":"UUID of the Cloudflare Tunnel connection.","example":"1bedc50d-42b3-473c-b108-ff3d10c0d925","format":"uuid","maxLength":36,"readOnly":true,"type":"string","x-auditable":true},"tunnel_connections":{"description":"The Cloudflare Tunnel connections between your origin and Cloudflare's edge.","items":{"$ref":"#/components/schemas/tunnel_schemas-connection"},"type":"array"},"tunnel_connections_deprecated":{"deprecated":true,"description":"The Cloudflare Tunnel connections between your origin and Cloudflare's edge.","items":{"$ref":"#/components/schemas/tunnel_schemas-connection"},"type":"array","x-stainless-deprecation-message":"This field will start returning an empty array. To fetch the connections of a given tunnel, please use the dedicated endpoint `/accounts/{account_id}/{tunnel_type}/{tunnel_id}/connections`"},"tunnel_conns_active_at":{"description":"Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If `null`, the tunnel is inactive.","example":"2009-11-10T23:00:00Z","format":"date-time","type":"string"},"tunnel_conns_inactive_at":{"description":"Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If `null`, the tunnel is active.","example":"2009-11-10T23:00:00Z","format":"date-time","type":"string"},"tunnel_created_at":{"description":"Timestamp of when the resource was created.","example":"2021-01-25T18:22:34.317854Z","format":"date-time","readOnly":true,"type":"string"},"tunnel_deleted_at":{"description":"Timestamp of when the resource was deleted. If `null`, the resource has not been deleted.","example":"2009-11-10T23:00:00.000000Z","format":"date-time","readOnly":true,"type":"string"},"tunnel_empty_response":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-common"},{"properties":{"result":{"enum":[null],"nullable":true,"type":"object"}},"type":"object"}]},"tunnel_existed_at":{"description":"If provided, include only resources that were created (and not deleted) before this time. URL encoded.","example":"2019-10-12T07%3A20%3A50.52Z","format":"url-encoded-date-time","type":"string"},"tunnel_features":{"description":"Features enabled for the Cloudflare Tunnel.","items":{"example":"ha-origin","type":"string"},"type":"array"},"tunnel_hostname":{"description":"The hostname of the route.","example":"office-1.local","type":"string","x-auditable":true},"tunnel_hostname_comment":{"description":"An optional description of the hostname route.","example":"example comment","type":"string","x-auditable":true},"tunnel_hostname_query_comment":{"description":"If set, only list hostname routes with the given comment.","example":"example%20comment","type":"string"},"tunnel_hostname_route":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_hostname_comment"},"created_at":{"$ref":"#/components/schemas/tunnel_created_at"},"deleted_at":{"$ref":"#/components/schemas/tunnel_deleted_at"},"hostname":{"$ref":"#/components/schemas/tunnel_hostname"},"id":{"$ref":"#/components/schemas/tunnel_hostname_route_id"},"tunnel_id":{"$ref":"#/components/schemas/tunnel_components-schemas-tunnel_id"},"tunnel_name":{"$ref":"#/components/schemas/tunnel_schemas-tunnel_name"}},"type":"object"},"tunnel_hostname_route_id":{"description":"The hostname route ID.","example":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","format":"uuid","type":"string","x-auditable":true},"tunnel_hostname_route_response_collection":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tunnel_hostname_route"},"type":"array"}},"type":"object"}]},"tunnel_hostname_route_response_single":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/tunnel_hostname_route"}},"type":"object"}]},"tunnel_icmp_proxy_enabled":{"description":"A flag to enable the ICMP proxy for the account network.","example":true,"type":"boolean","x-auditable":true},"tunnel_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"tunnel_ingressRule":{"description":"Public hostname","properties":{"hostname":{"description":"Public hostname for this service.","example":"tunnel.example.com","type":"string"},"originRequest":{"$ref":"#/components/schemas/tunnel_originRequest"},"path":{"description":"Requests with this path route to this public hostname.","example":"subpath","type":"string"},"service":{"description":"Protocol and address of destination server. Supported protocols: http://, https://, unix://, tcp://, ssh://, rdp://, unix+tls://, smb://. Alternatively can return a HTTP status code http_status:[code] e.g. 'http_status:404'.\n","example":"https://localhost:8001","type":"string"}},"required":["hostname","service"],"type":"object"},"tunnel_ip":{"example":"10.1.0.137","type":"string"},"tunnel_ip_network":{"description":"The private IPv4 or IPv6 range connected by the route, in CIDR notation.","example":"172.16.0.0/16","type":"string","x-auditable":true},"tunnel_ip_network_encoded":{"description":"IP/CIDR range in URL-encoded format","example":"172.16.0.0%2F16","type":"string"},"tunnel_is_default_network":{"description":"If `true`, this virtual network is the default for the account.","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"tunnel_is_default_network_optional":{"default":false,"description":"If `true`, this virtual network is the default for the account.","example":false,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"tunnel_is_pending_reconnect":{"description":"Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting.  If `true`, the connection has disconnected but is still being tracked. If `false`, the connection is actively serving traffic.","example":false,"type":"boolean"},"tunnel_legacy-tunnel-response-collection":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tunnel_argo-tunnel"},"type":"array"}},"type":"object"}]},"tunnel_legacy-tunnel-response-single":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/tunnel_argo-tunnel"}},"type":"object"}]},"tunnel_management-resources":{"description":"Management resources the token will have access to.","enum":["logs"],"example":"logs","type":"string"},"tunnel_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"tunnel_metadata":{"description":"Metadata associated with the tunnel.","example":{},"type":"object"},"tunnel_offramp_warp_enabled":{"description":"A flag to enable WARP to WARP traffic.","example":true,"type":"boolean","x-auditable":true},"tunnel_originRequest":{"description":"Configuration parameters for the public hostname specific connection settings between cloudflared and origin server.","properties":{"access":{"description":"For all L7 requests to this hostname, cloudflared will validate each request's Cf-Access-Jwt-Assertion request header.","properties":{"audTag":{"description":"Access applications that are allowed to reach this hostname for this Tunnel. Audience tags can be identified in the dashboard or via the List Access policies API.","items":{"type":"string"},"type":"array"},"required":{"description":"Deny traffic that has not fulfilled Access authorization.","example":false,"type":"boolean"},"teamName":{"example":"zero-trust-organization-name","type":"string"}},"required":["audTag","teamName"],"type":"object"},"caPool":{"description":"Path to the certificate authority (CA) for the certificate of your origin. This option should be used only if your certificate is not signed by Cloudflare.","type":"string"},"connectTimeout":{"description":"Timeout for establishing a new TCP connection to your origin server. This excludes the time taken to establish TLS, which is controlled by tlsTimeout.","example":10,"type":"integer"},"disableChunkedEncoding":{"description":"Disables chunked transfer encoding. Useful if you are running a WSGI server.","type":"boolean"},"http2Origin":{"description":"Attempt to connect to origin using HTTP2. Origin must be configured as https.","type":"boolean"},"httpHostHeader":{"description":"Sets the HTTP Host header on requests sent to the local service.","type":"string"},"keepAliveConnections":{"description":"Maximum number of idle keepalive connections between Tunnel and your origin. This does not restrict the total number of concurrent connections.","example":100,"type":"integer"},"keepAliveTimeout":{"description":"Timeout after which an idle keepalive connection can be discarded.","example":90,"type":"integer"},"matchSNItoHost":{"description":"Auto configure the Hostname on the origin server certificate.","example":false,"type":"boolean"},"noHappyEyeballs":{"description":"Disable the “happy eyeballs” algorithm for IPv4/IPv6 fallback if your local network has misconfigured one of the protocols.","example":false,"type":"boolean"},"noTLSVerify":{"description":"Disables TLS verification of the certificate presented by your origin. Will allow any certificate from the origin to be accepted.","example":false,"type":"boolean"},"originServerName":{"description":"Hostname that cloudflared should expect from your origin server certificate.","type":"string"},"proxyType":{"description":"cloudflared starts a proxy server to translate HTTP traffic into TCP when proxying, for example, SSH or RDP. This configures what type of proxy will be started. Valid options are: \"\" for the regular proxy and \"socks\" for a SOCKS5 proxy.\n","type":"string"},"tcpKeepAlive":{"description":"The timeout after which a TCP keepalive packet is sent on a connection between Tunnel and the origin server.","example":30,"type":"integer"},"tlsTimeout":{"description":"Timeout for completing a TLS handshake to your origin server, if you have chosen to connect Tunnel to an HTTPS server.","example":10,"type":"integer"}},"type":"object"},"tunnel_page_number":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"},"tunnel_per_page":{"description":"Number of results to display.","maximum":1000,"minimum":1,"type":"number"},"tunnel_remote_config":{"deprecated":true,"description":"If `true`, the tunnel can be configured remotely from the Zero Trust dashboard. If `false`, the tunnel must be configured locally on the origin machine.","example":true,"type":"boolean","x-auditable":true,"x-stainless-deprecation-message":"Use the config_src field instead.","x-stainless-ignore":true},"tunnel_result_info":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters","example":2000,"type":"number"}},"type":"object"},"tunnel_route":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_route_comment"},"created_at":{"$ref":"#/components/schemas/tunnel_created_at"},"deleted_at":{"$ref":"#/components/schemas/tunnel_deleted_at"},"id":{"$ref":"#/components/schemas/tunnel_route_id"},"network":{"$ref":"#/components/schemas/tunnel_ip_network"},"tunnel_id":{"$ref":"#/components/schemas/tunnel_tunnel_id"},"virtual_network_id":{"$ref":"#/components/schemas/tunnel_virtual_network_id"}},"type":"object"},"tunnel_route_comment":{"default":"","description":"Optional remark describing the route.","example":"Example comment for this route.","maxLength":100,"type":"string","x-auditable":true},"tunnel_route_id":{"description":"UUID of the route.","example":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","maxLength":36,"readOnly":true,"type":"string"},"tunnel_route_response_single":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/tunnel_route"}},"type":"object"}]},"tunnel_run_at":{"description":"Timestamp of when the tunnel connection was started.","example":"2009-11-10T23:00:00Z","format":"date-time","type":"string"},"tunnel_schemas-api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/tunnel_schemas-messages"},"messages":{"$ref":"#/components/schemas/tunnel_schemas-messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"tunnel_schemas-api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/tunnel_schemas-messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/tunnel_schemas-messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"tunnel_schemas-api-response-single":{"allOf":[{"$ref":"#/components/schemas/tunnel_schemas-api-response-common"}],"type":"object"},"tunnel_schemas-config_src":{"description":"Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel's configuration on the Zero Trust dashboard.","enum":["local","cloudflare"],"example":"cloudflare","type":"string","x-stainless-terraform-configurability":"computed_optional"},"tunnel_schemas-config_version":{"description":"The version of the Tunnel Configuration.","type":"integer"},"tunnel_schemas-connection":{"properties":{"client_id":{"$ref":"#/components/schemas/tunnel_client_id"},"client_version":{"$ref":"#/components/schemas/tunnel_version"},"colo_name":{"$ref":"#/components/schemas/tunnel_colo_name"},"id":{"$ref":"#/components/schemas/tunnel_connection_id"},"is_pending_reconnect":{"$ref":"#/components/schemas/tunnel_is_pending_reconnect"},"opened_at":{"description":"Timestamp of when the connection was established.","example":"2021-01-25T18:22:34.317854Z","format":"date-time","type":"string"},"origin_ip":{"allOf":[{"$ref":"#/components/schemas/tunnel_ip"}],"description":"The public IP address of the host running cloudflared."},"uuid":{"$ref":"#/components/schemas/tunnel_connection_id"}}},"tunnel_schemas-messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"tunnel_schemas-tunnel_id":{"description":"UUID of the tunnel.","example":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","format":"uuid","maxLength":36,"readOnly":true,"type":"string"},"tunnel_schemas-tunnel_name":{"description":"A user-friendly name for a tunnel.","example":"api-tunnel","type":"string"},"tunnel_status":{"description":"The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).","enum":["inactive","degraded","healthy","down"],"example":"healthy","type":"string"},"tunnel_subnet":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_subnet_comment"},"created_at":{"$ref":"#/components/schemas/tunnel_created_at"},"deleted_at":{"$ref":"#/components/schemas/tunnel_deleted_at"},"id":{"$ref":"#/components/schemas/tunnel_subnet_id"},"is_default_network":{"$ref":"#/components/schemas/tunnel_subnet_is_default_network"},"name":{"$ref":"#/components/schemas/tunnel_subnet_name"},"network":{"$ref":"#/components/schemas/tunnel_subnet_ip_network"},"subnet_type":{"$ref":"#/components/schemas/tunnel_subnet_type"}},"type":"object"},"tunnel_subnet_comment":{"description":"An optional description of the subnet.","example":"example comment","type":"string","x-auditable":true},"tunnel_subnet_id":{"description":"The UUID of the subnet.","example":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","format":"uuid","type":"string","x-auditable":true},"tunnel_subnet_ip_network":{"description":"The private IPv4 or IPv6 range defining the subnet, in CIDR notation.","example":"100.64.0.0/12","type":"string","x-auditable":true},"tunnel_subnet_is_default_network":{"description":"If `true`, this is the default subnet for the account. There can only be one default subnet per account.","type":"boolean","x-auditable":true},"tunnel_subnet_name":{"description":"A user-friendly name for the subnet.","example":"IPv4 Cloudflare Source IPs","type":"string","x-auditable":true},"tunnel_subnet_query_comment":{"description":"If set, only list subnets with the given comment.","example":"example%20comment","type":"string"},"tunnel_subnet_query_name":{"description":"If set, only list subnets with the given name","example":"IPv4%20Cloudflare%20Source%20IPs","type":"string"},"tunnel_subnet_response_collection":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tunnel_subnet"},"type":"array"}},"type":"object"}]},"tunnel_subnet_response_single":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/tunnel_subnet"}},"type":"object"}]},"tunnel_subnet_type":{"description":"The type of subnet.","enum":["cloudflare_source"],"example":"cloudflare_source","type":"string","x-auditable":true},"tunnel_teamnet":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_route_comment"},"created_at":{"$ref":"#/components/schemas/tunnel_created_at"},"deleted_at":{"$ref":"#/components/schemas/tunnel_deleted_at"},"id":{"$ref":"#/components/schemas/tunnel_route_id"},"network":{"$ref":"#/components/schemas/tunnel_ip_network"},"tun_type":{"$ref":"#/components/schemas/tunnel_tunnel_type"},"tunnel_id":{"$ref":"#/components/schemas/tunnel_tunnel_id"},"tunnel_name":{"$ref":"#/components/schemas/tunnel_tunnel_name"},"virtual_network_id":{"$ref":"#/components/schemas/tunnel_virtual_network_id_computed_optional"},"virtual_network_name":{"$ref":"#/components/schemas/tunnel_virtual_network_name"}},"type":"object"},"tunnel_teamnet_response_collection":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tunnel_teamnet"},"type":"array"}},"type":"object"}]},"tunnel_teamnet_response_single":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/tunnel_teamnet"}},"type":"object"}]},"tunnel_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true},"tunnel_tunnel-response-collection":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-collection"},{"properties":{"result":{"items":{"anyOf":[{"$ref":"#/components/schemas/tunnel_cfd_tunnel"},{"$ref":"#/components/schemas/tunnel_warp_connector_tunnel"}]},"type":"array"}},"type":"object"}]},"tunnel_tunnel_client":{"description":"A client (typically cloudflared) that maintains connections to a Cloudflare data center.","properties":{"arch":{"$ref":"#/components/schemas/tunnel_arch"},"config_version":{"$ref":"#/components/schemas/tunnel_config_version"},"conns":{"$ref":"#/components/schemas/tunnel_connections"},"features":{"$ref":"#/components/schemas/tunnel_features"},"id":{"$ref":"#/components/schemas/tunnel_connection_id"},"run_at":{"$ref":"#/components/schemas/tunnel_run_at"},"version":{"$ref":"#/components/schemas/tunnel_version"}},"type":"object"},"tunnel_tunnel_client_response":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/tunnel_tunnel_client"}},"type":"object"}]},"tunnel_tunnel_connections_response":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tunnel_tunnel_client"},"type":"array"}},"type":"object"}]},"tunnel_tunnel_id":{"description":"UUID of the tunnel.","example":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","format":"uuid","maxLength":36,"readOnly":true,"type":"string","x-auditable":true},"tunnel_tunnel_link":{"description":"The id of the tunnel linked and the date that link was created.","properties":{"created_at":{"$ref":"#/components/schemas/tunnel_created_at"},"linked_tunnel_id":{"$ref":"#/components/schemas/tunnel_tunnel_id"}},"type":"object"},"tunnel_tunnel_links_response":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tunnel_tunnel_link"},"type":"array"}},"type":"object"}]},"tunnel_tunnel_name":{"description":"A user-friendly name for a tunnel.","example":"blog","type":"string"},"tunnel_tunnel_response_token":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/tunnel_tunnel_token"}},"type":"object"}]},"tunnel_tunnel_secret":{"description":"Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.","example":"AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=","type":"string","x-sensitive":true},"tunnel_tunnel_token":{"description":"The Tunnel Token is used as a mechanism to authenticate the operation of a tunnel.","example":"eyJhIjoiNWFiNGU5Z...","readOnly":true,"type":"string","x-sensitive":true},"tunnel_tunnel_type":{"description":"The type of tunnel.","enum":["cfd_tunnel","warp_connector","warp","magic","ip_sec","gre","cni"],"example":"cfd_tunnel","type":"string","x-auditable":true},"tunnel_tunnel_types":{"description":"The types of tunnels to filter by, separated by commas.","example":"cfd_tunnel,warp_connector","items":{"$ref":"#/components/schemas/tunnel_tunnel_type"},"type":"array"},"tunnel_version":{"description":"The cloudflared version used to establish this connection.","example":"2022.7.1","type":"string"},"tunnel_virtual-network":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_virtual_network_comment"},"created_at":{"$ref":"#/components/schemas/tunnel_created_at"},"deleted_at":{"$ref":"#/components/schemas/tunnel_deleted_at"},"id":{"$ref":"#/components/schemas/tunnel_virtual_network_id"},"is_default_network":{"$ref":"#/components/schemas/tunnel_is_default_network"},"name":{"$ref":"#/components/schemas/tunnel_virtual_network_name"}},"required":["id","name","is_default_network","comment","created_at"],"type":"object"},"tunnel_virtual_network_comment":{"default":"","description":"Optional remark describing the virtual network.","example":"Staging VPC for data science","maxLength":256,"type":"string","x-auditable":true},"tunnel_virtual_network_id":{"description":"UUID of the virtual network.","example":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","format":"uuid","type":"string","x-auditable":true},"tunnel_virtual_network_id_computed_optional":{"description":"UUID of the virtual network.","example":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","format":"uuid","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"tunnel_virtual_network_name":{"description":"A user-friendly name for the virtual network.","example":"us-east-1-vpc","maxLength":256,"type":"string","x-auditable":true},"tunnel_vnet_response_collection":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tunnel_virtual-network"},"type":"array"}},"type":"object"}]},"tunnel_vnet_response_single":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/tunnel_virtual-network"}},"type":"object"}]},"tunnel_warp-connector-response-collection":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tunnel_warp_connector_tunnel"},"type":"array"}},"type":"object"}]},"tunnel_warp-connector-response-single":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/tunnel_warp_connector_tunnel"}},"type":"object"}]},"tunnel_warp_connector_tunnel":{"description":"A Warp Connector Tunnel that connects your origin to Cloudflare's edge.","properties":{"account_tag":{"$ref":"#/components/schemas/tunnel_account_id"},"connections":{"$ref":"#/components/schemas/tunnel_connections_deprecated"},"conns_active_at":{"$ref":"#/components/schemas/tunnel_conns_active_at"},"conns_inactive_at":{"$ref":"#/components/schemas/tunnel_conns_inactive_at"},"created_at":{"$ref":"#/components/schemas/tunnel_created_at"},"deleted_at":{"$ref":"#/components/schemas/tunnel_deleted_at"},"id":{"$ref":"#/components/schemas/tunnel_tunnel_id"},"metadata":{"$ref":"#/components/schemas/tunnel_metadata"},"name":{"$ref":"#/components/schemas/tunnel_tunnel_name"},"status":{"$ref":"#/components/schemas/tunnel_status"},"tun_type":{"$ref":"#/components/schemas/tunnel_tunnel_type"}},"type":"object"},"tunnel_zero_trust_connectivity_settings_response":{"allOf":[{"$ref":"#/components/schemas/tunnel_api-response-common"},{"properties":{"result":{"properties":{"icmp_proxy_enabled":{"$ref":"#/components/schemas/tunnel_icmp_proxy_enabled"},"offramp_warp_enabled":{"$ref":"#/components/schemas/tunnel_offramp_warp_enabled"}},"type":"object"}},"type":"object"}]},"turnstile_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/turnstile_messages"},"messages":{"$ref":"#/components/schemas/turnstile_messages"},"success":{"description":"Whether the API call was successful","example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"turnstile_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/turnstile_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/turnstile_messages"}],"example":[]},"result":{"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"turnstile_bot_fight_mode":{"description":"If bot_fight_mode is set to `true`, Cloudflare issues computationally\nexpensive challenges in response to malicious bots (ENT only).\n","example":false,"type":"boolean","x-auditable":true},"turnstile_clearance_level":{"description":"If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance,\nthis setting can determine the clearance level to be set\n","enum":["no_clearance","jschallenge","managed","interactive"],"example":"interactive","type":"string","x-auditable":true},"turnstile_created_on":{"description":"When the widget was created.","example":"2014-01-01T05:20:00.123123Z","format":"date-time","readOnly":true,"type":"string"},"turnstile_domains":{"example":["203.0.113.1","cloudflare.com","blog.example.com"],"items":{"description":"Hosts as a hostname or IPv4/IPv6 address represented by strings. The\nwidget will only work on these domains, and their subdomains.\n","example":"203.0.113.1","type":"string","x-auditable":true},"maxLength":10,"type":"array"},"turnstile_ephemeral_id":{"description":"Return the Ephemeral ID in /siteverify (ENT only).\n","example":false,"type":"boolean","x-auditable":true},"turnstile_identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"turnstile_invalidate_immediately":{"default":false,"description":"If `invalidate_immediately` is set to `false`, the previous secret will\nremain valid for two hours. Otherwise, the secret is immediately\ninvalidated, and requests using it will be rejected.\n","type":"boolean","x-auditable":true},"turnstile_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"turnstile_modified_on":{"description":"When the widget was modified.","example":"2014-01-01T05:20:00.123123Z","format":"date-time","readOnly":true,"type":"string"},"turnstile_name":{"description":"Human readable widget name. Not unique. Cloudflare suggests that you\nset this to a meaningful string to make it easier to identify your\nwidget, and where it is used.\n","example":"blog.cloudflare.com login form","maxLength":254,"minLength":1,"type":"string","x-auditable":true},"turnstile_offlabel":{"description":"Do not show any Cloudflare branding on the widget (ENT only).\n","example":false,"type":"boolean","x-auditable":true},"turnstile_region":{"default":"world","description":"Region where this widget can be used. This cannot be changed after creation.\n","enum":["world","china"],"type":"string","x-auditable":true},"turnstile_result_info":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters","example":2000,"type":"number"}},"required":["page","per_page","count","total_count"],"type":"object"},"turnstile_secret":{"description":"Secret key for this widget.","example":"0x4AAF00AAAABn0R22HWm098HVBjhdsYUc","type":"string","x-sensitive":true},"turnstile_sitekey":{"description":"Widget item identifier tag.","example":"0x4AAF00AAAABn0R22HWm-YUc","maxLength":32,"type":"string","x-auditable":true},"turnstile_widget_detail":{"description":"A Turnstile widget's detailed configuration","properties":{"bot_fight_mode":{"$ref":"#/components/schemas/turnstile_bot_fight_mode"},"clearance_level":{"$ref":"#/components/schemas/turnstile_clearance_level"},"created_on":{"$ref":"#/components/schemas/turnstile_created_on"},"domains":{"$ref":"#/components/schemas/turnstile_domains"},"ephemeral_id":{"$ref":"#/components/schemas/turnstile_ephemeral_id"},"mode":{"$ref":"#/components/schemas/turnstile_widget_mode"},"modified_on":{"$ref":"#/components/schemas/turnstile_modified_on"},"name":{"$ref":"#/components/schemas/turnstile_name"},"offlabel":{"$ref":"#/components/schemas/turnstile_offlabel"},"region":{"$ref":"#/components/schemas/turnstile_region"},"secret":{"$ref":"#/components/schemas/turnstile_secret"},"sitekey":{"$ref":"#/components/schemas/turnstile_sitekey"}},"required":["sitekey","secret","created_on","modified_on","name","domains","mode","region","bot_fight_mode","offlabel","clearance_level","ephemeral_id"],"type":"object"},"turnstile_widget_list":{"description":"A Turnstile Widgets configuration as it appears in listings","properties":{"bot_fight_mode":{"$ref":"#/components/schemas/turnstile_bot_fight_mode"},"clearance_level":{"$ref":"#/components/schemas/turnstile_clearance_level"},"created_on":{"$ref":"#/components/schemas/turnstile_created_on"},"domains":{"$ref":"#/components/schemas/turnstile_domains"},"ephemeral_id":{"$ref":"#/components/schemas/turnstile_ephemeral_id"},"mode":{"$ref":"#/components/schemas/turnstile_widget_mode"},"modified_on":{"$ref":"#/components/schemas/turnstile_modified_on"},"name":{"$ref":"#/components/schemas/turnstile_name"},"offlabel":{"$ref":"#/components/schemas/turnstile_offlabel"},"region":{"$ref":"#/components/schemas/turnstile_region"},"sitekey":{"$ref":"#/components/schemas/turnstile_sitekey"}},"required":["sitekey","created_on","modified_on","name","domains","mode","region","bot_fight_mode","offlabel","clearance_level","ephemeral_id"],"type":"object"},"turnstile_widget_mode":{"description":"Widget Mode","enum":["non-interactive","invisible","managed"],"example":"invisible","type":"string","x-auditable":true},"vectorize_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-common"},{"properties":{"result":{"items":{},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/vectorize_result_info"}}}],"type":"object"},"vectorize_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/vectorize_messages"},"messages":{"$ref":"#/components/schemas/vectorize_messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"vectorize_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/vectorize_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/vectorize_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"vectorize_api-response-single":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-common"},{"properties":{"result":{"anyOf":[{"type":"object"},{"type":"string"}],"nullable":true,"type":"object"}}}],"type":"object"},"vectorize_create-index-request":{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/vectorize_index-configuration"}]},"description":{"$ref":"#/components/schemas/vectorize_index-description"},"name":{"$ref":"#/components/schemas/vectorize_index-name"}},"required":["name","config"],"type":"object"},"vectorize_create-index-response":{"properties":{"config":{"$ref":"#/components/schemas/vectorize_index-dimension-configuration"},"created_on":{"description":"Specifies the timestamp the resource was created as an ISO8601 string.","example":"2022-11-15T18:25:44.442097Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"description":{"$ref":"#/components/schemas/vectorize_index-description"},"modified_on":{"description":"Specifies the timestamp the resource was modified as an ISO8601 string.","example":"2022-11-15T18:25:44.442097Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/vectorize_index-name"}},"type":"object"},"vectorize_create-metadata-index-request":{"properties":{"indexType":{"description":"Specifies the type of metadata property to index.","enum":["string","number","boolean"],"type":"string","x-auditable":true},"propertyName":{"description":"Specifies the metadata property to index.","example":"random_metadata_property","type":"string","x-auditable":true}},"required":["propertyName","indexType"],"type":"object"},"vectorize_create-metadata-index-response":{"properties":{"mutationId":{"$ref":"#/components/schemas/vectorize_mutation-uuid"}},"type":"object"},"vectorize_delete-metadata-index-request":{"properties":{"propertyName":{"description":"Specifies the metadata property for which the index must be deleted.","example":"random_metadata_property","type":"string","x-auditable":true}},"required":["propertyName"],"type":"object"},"vectorize_delete-metadata-index-response":{"properties":{"mutationId":{"$ref":"#/components/schemas/vectorize_mutation-uuid"}},"type":"object"},"vectorize_identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"vectorize_index-configuration":{"description":"Specifies the type of configuration to use for the index.","oneOf":[{"$ref":"#/components/schemas/vectorize_index-dimension-configuration"},{"$ref":"#/components/schemas/vectorize_index-preset-configuration"}]},"vectorize_index-delete-vectors-by-id-request":{"properties":{"ids":{"description":"A list of vector identifiers to delete from the index indicated by the path.","example":["5121db81354a40c6aedc3fe1ace51c59","f90eb49c2107486abdfd78c67e853430"],"items":{"$ref":"#/components/schemas/vectorize_vector-identifier"},"type":"array"}},"type":"object"},"vectorize_index-delete-vectors-by-id-response":{"properties":{"count":{"description":"The count of the vectors successfully deleted.","example":42,"type":"integer"},"ids":{"description":"Array of vector identifiers of the vectors that were successfully processed for deletion.","items":{"$ref":"#/components/schemas/vectorize_vector-identifier"},"type":"array"}},"type":"object"},"vectorize_index-delete-vectors-by-id-v2-response":{"properties":{"mutationId":{"$ref":"#/components/schemas/vectorize_mutation-uuid"}},"type":"object"},"vectorize_index-description":{"description":"Specifies the description of the index.","example":"This is my example index.","type":"string","x-auditable":true},"vectorize_index-dimension-configuration":{"properties":{"dimensions":{"$ref":"#/components/schemas/vectorize_index-dimensions"},"metric":{"$ref":"#/components/schemas/vectorize_index-metric"}},"required":["dimensions","metric"],"type":"object"},"vectorize_index-dimensions":{"description":"Specifies the number of dimensions for the index","example":768,"maximum":1536,"minimum":1,"type":"integer","x-auditable":true},"vectorize_index-get-vectors-by-id-request":{"properties":{"ids":{"description":"A list of vector identifiers to retrieve from the index indicated by the path.","example":["5121db81354a40c6aedc3fe1ace51c59","f90eb49c2107486abdfd78c67e853430"],"items":{"$ref":"#/components/schemas/vectorize_vector-identifier"},"type":"array"}},"type":"object"},"vectorize_index-get-vectors-by-id-response":{"description":"Array of vectors with matching ids.","example":[{"id":"some-vector-id","metadata":{"another-key":"another-value","customer-id":442},"values":[0.812,0.621,0.261]},{"id":"other-vector-id","metadata":{"another-key":"with-a-value","customer-id":2151},"namespace":"namespaced","values":[0.961,0.751,0.661]}],"items":{"properties":{"id":{"$ref":"#/components/schemas/vectorize_vector-identifier"},"metadata":{"type":"object"},"namespace":{"nullable":true,"type":"string"},"values":{"items":{"type":"number"},"type":"array"}},"type":"object"},"type":"array"},"vectorize_index-info-response":{"properties":{"dimensions":{"$ref":"#/components/schemas/vectorize_index-dimensions"},"processedUpToDatetime":{"description":"Specifies the timestamp the last mutation batch was processed as an ISO8601 string.","example":"2024-07-22T18:25:44.442097Z","format":"date-time","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"processedUpToMutation":{"$ref":"#/components/schemas/vectorize_mutation-uuid"},"vectorCount":{"description":"Specifies the number of vectors present in the index","example":300000,"type":"integer","x-auditable":true}},"type":"object"},"vectorize_index-insert-response":{"properties":{"count":{"description":"Specifies the count of the vectors successfully inserted.","example":768,"type":"integer","x-auditable":true},"ids":{"description":"Array of vector identifiers of the vectors successfully inserted.","items":{"$ref":"#/components/schemas/vectorize_vector-identifier"},"type":"array"}},"type":"object"},"vectorize_index-insert-v2-response":{"properties":{"mutationId":{"$ref":"#/components/schemas/vectorize_mutation-uuid"}},"type":"object"},"vectorize_index-list-vectors-response":{"properties":{"count":{"description":"Number of vectors returned in this response","example":100,"type":"integer"},"cursorExpirationTimestamp":{"description":"When the cursor expires as an ISO8601 string","example":"2025-08-12T20:32:52.469144957+00:00","format":"date-time","nullable":true,"type":"string"},"isTruncated":{"description":"Whether there are more vectors available beyond this response","example":true,"type":"boolean"},"nextCursor":{"description":"Cursor for the next page of results","example":"suUTaDY5PFUiRweVccnzyt9n75suNPbXHPshvCzue5mHjtj7Letjvzlza9eGj099","nullable":true,"type":"string"},"totalCount":{"description":"Total number of vectors in the index","example":500,"type":"integer"},"vectors":{"description":"Array of vector items","items":{"$ref":"#/components/schemas/vectorize_vector-list-item"},"type":"array"}},"required":["count","totalCount","isTruncated","vectors"],"type":"object"},"vectorize_index-metric":{"description":"Specifies the type of metric to use calculating distance.","enum":["cosine","euclidean","dot-product"],"type":"string","x-auditable":true},"vectorize_index-name":{"example":"example-index","pattern":"^([a-z]+[a-z0-9_-]*[a-z0-9]+)$","type":"string","x-auditable":true},"vectorize_index-preset":{"description":"Specifies the preset to use for the index.","enum":["@cf/baai/bge-small-en-v1.5","@cf/baai/bge-base-en-v1.5","@cf/baai/bge-large-en-v1.5","openai/text-embedding-ada-002","cohere/embed-multilingual-v2.0"],"example":"@cf/baai/bge-small-en-v1.5","type":"string","x-auditable":true},"vectorize_index-preset-configuration":{"properties":{"preset":{"$ref":"#/components/schemas/vectorize_index-preset"}},"required":["preset"],"type":"object"},"vectorize_index-query-request":{"properties":{"filter":{"description":"A metadata filter expression used to limit nearest neighbor results.","example":{"has_viewed":{"$ne":true},"streaming_platform":"netflix"},"type":"object"},"returnMetadata":{"default":false,"description":"Whether to return the metadata associated with the closest vectors.","type":"boolean"},"returnValues":{"default":false,"description":"Whether to return the values associated with the closest vectors.","type":"boolean"},"topK":{"default":5,"description":"The number of nearest neighbors to find.","example":5,"type":"number"},"vector":{"description":"The search vector that will be used to find the nearest neighbors.","example":[0.5,0.5,0.5],"items":{"type":"number"},"type":"array"}},"required":["vector"],"type":"object"},"vectorize_index-query-response":{"properties":{"count":{"description":"Specifies the count of vectors returned by the search","type":"integer"},"matches":{"description":"Array of vectors matched by the search","items":{"properties":{"id":{"$ref":"#/components/schemas/vectorize_vector-identifier"},"metadata":{"nullable":true,"type":"object"},"score":{"description":"The score of the vector according to the index's distance metric","type":"number"},"values":{"items":{"type":"number"},"nullable":true,"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"vectorize_index-query-v2-request":{"properties":{"filter":{"description":"A metadata filter expression used to limit nearest neighbor results.","example":{"has_viewed":{"$ne":true},"streaming_platform":"netflix"},"type":"object"},"returnMetadata":{"default":"none","description":"Whether to return no metadata, indexed metadata or all metadata associated with the closest vectors.","enum":["none","indexed","all"],"type":"string"},"returnValues":{"default":false,"description":"Whether to return the values associated with the closest vectors.","type":"boolean"},"topK":{"default":5,"description":"The number of nearest neighbors to find.","example":5,"type":"number"},"vector":{"description":"The search vector that will be used to find the nearest neighbors.","example":[0.5,0.5,0.5],"items":{"type":"number"},"type":"array"}},"required":["vector"],"type":"object"},"vectorize_index-query-v2-response":{"properties":{"count":{"description":"Specifies the count of vectors returned by the search","type":"integer"},"matches":{"description":"Array of vectors matched by the search","items":{"properties":{"id":{"$ref":"#/components/schemas/vectorize_vector-identifier"},"metadata":{"nullable":true,"type":"object"},"namespace":{"nullable":true,"type":"string"},"score":{"description":"The score of the vector according to the index's distance metric","type":"number"},"values":{"items":{"type":"number"},"nullable":true,"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"vectorize_index-upsert-response":{"properties":{"count":{"description":"Specifies the count of the vectors successfully inserted.","example":768,"type":"integer","x-auditable":true},"ids":{"description":"Array of vector identifiers of the vectors successfully inserted.","items":{"$ref":"#/components/schemas/vectorize_vector-identifier"},"type":"array"}},"type":"object"},"vectorize_index-upsert-v2-response":{"properties":{"mutationId":{"$ref":"#/components/schemas/vectorize_mutation-uuid"}},"type":"object"},"vectorize_list-metadata-index-response":{"example":{"metadataIndexes":[{"indexType":"number","propertyName":"some-num-prop"},{"indexType":"string","propertyName":"some-str-prop"},{"indexType":"boolean","propertyName":"some-bool-prop"}]},"properties":{"metadataIndexes":{"description":"Array of indexed metadata properties.","items":{"properties":{"indexType":{"description":"Specifies the type of indexed metadata property.","enum":["string","number","boolean"],"type":"string","x-auditable":true},"propertyName":{"description":"Specifies the indexed metadata property.","example":"random_metadata_property","type":"string","x-auditable":true}},"type":"object"},"type":"array"}},"type":"object"},"vectorize_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"vectorize_mutation-uuid":{"description":"The unique identifier for the async mutation operation containing the changeset.","example":"0000aaaa-11bb-22cc-33dd-444444eeeeee","maxLength":36,"x-auditable":true},"vectorize_result_info":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters","example":2000,"type":"number"}},"type":"object"},"vectorize_update-index-request":{"properties":{"description":{"$ref":"#/components/schemas/vectorize_index-description"}},"required":["description"],"type":"object"},"vectorize_vector-identifier":{"description":"Identifier for a Vector","example":"some-vector-id-023e105f4ecef8ad9ca31a8372d0c353","maxLength":64,"readOnly":true,"type":"string"},"vectorize_vector-list-item":{"properties":{"id":{"$ref":"#/components/schemas/vectorize_vector-identifier"}},"required":["id"],"type":"object"},"waf-managed-rules_allowed_modes":{"description":"Defines the available states for the rule group.","example":["on","off"],"items":{"$ref":"#/components/schemas/waf-managed-rules_mode"},"readOnly":true,"type":"array"},"waf-managed-rules_allowed_modes_allow_traditional":{"description":"Defines the available modes for the current WAF rule.","example":["on","off"],"items":{"$ref":"#/components/schemas/waf-managed-rules_mode_allow_traditional"},"readOnly":true,"type":"array"},"waf-managed-rules_allowed_modes_anomaly":{"description":"Defines the available modes for the current WAF rule. Applies to anomaly detection WAF rules.","example":["on","off"],"items":{"$ref":"#/components/schemas/waf-managed-rules_mode_anomaly"},"readOnly":true,"type":"array"},"waf-managed-rules_allowed_modes_deny_traditional":{"description":"Defines the list of possible actions of the WAF rule when it is triggered.","example":["default","disable","simulate","block","challenge"],"items":{"$ref":"#/components/schemas/waf-managed-rules_mode_deny_traditional"},"readOnly":true,"type":"array"},"waf-managed-rules_anomaly_rule":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_schemas-base"},{"properties":{"allowed_modes":{"$ref":"#/components/schemas/waf-managed-rules_allowed_modes_anomaly"},"mode":{"$ref":"#/components/schemas/waf-managed-rules_mode_anomaly"}},"type":"object"}],"description":"When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.","required":["id","description","priority","allowed_modes","mode","group","package_id"],"title":"Anomaly detection WAF rule","type":"object"},"waf-managed-rules_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_api-response-common"},{"properties":{"result_info":{"$ref":"#/components/schemas/waf-managed-rules_result_info"}},"type":"object"}],"type":"object"},"waf-managed-rules_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/waf-managed-rules_messages"},"messages":{"$ref":"#/components/schemas/waf-managed-rules_messages"},"success":{"description":"Defines whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"waf-managed-rules_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Defines whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"waf-managed-rules_api-response-single":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_api-response-common"},{"properties":{"result":{"oneOf":[{"nullable":true,"type":"object"},{"nullable":true,"type":"string"}]}},"type":"object"}],"type":"object"},"waf-managed-rules_base":{"properties":{"description":{"$ref":"#/components/schemas/waf-managed-rules_schemas-description"},"group":{"description":"Defines the rule group to which the current WAF rule belongs.","properties":{"id":{"$ref":"#/components/schemas/waf-managed-rules_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/waf-managed-rules_name"}},"readOnly":true,"type":"object"},"id":{"$ref":"#/components/schemas/waf-managed-rules_rule_components-schemas-identifier"},"package_id":{"$ref":"#/components/schemas/waf-managed-rules_identifier"},"priority":{"$ref":"#/components/schemas/waf-managed-rules_priority"}}},"waf-managed-rules_components-schemas-identifier":{"description":"Defines the unique identifier of the rule group.","example":"de677e5818985db1285d0e80225f06e5","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"waf-managed-rules_default_mode":{"description":"Defines the default action/mode of a rule.","enum":["disable","simulate","block","challenge"],"example":"block","readOnly":true},"waf-managed-rules_description":{"description":"Defines an informative summary of what the rule group does.","example":"Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"waf-managed-rules_group":{"properties":{"description":{"$ref":"#/components/schemas/waf-managed-rules_description"},"id":{"$ref":"#/components/schemas/waf-managed-rules_components-schemas-identifier"},"modified_rules_count":{"$ref":"#/components/schemas/waf-managed-rules_modified_rules_count"},"name":{"$ref":"#/components/schemas/waf-managed-rules_name"},"package_id":{"$ref":"#/components/schemas/waf-managed-rules_identifier"},"rules_count":{"$ref":"#/components/schemas/waf-managed-rules_rules_count"}},"type":"object"},"waf-managed-rules_identifier":{"description":"Defines the unique identifier of a WAF package.","example":"a25a9a7e9c00afc1fb2e0245519d725b","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"waf-managed-rules_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"waf-managed-rules_mode":{"default":"on","description":"Defines the state of the rules contained in the rule group. When `on`, the rules in the group are configurable/usable.","enum":["on","off"],"type":"string","x-auditable":true},"waf-managed-rules_mode_allow_traditional":{"description":"When set to `on`, the current rule will be used when evaluating the request. Applies to traditional (allow) WAF rules.","enum":["on","off"],"example":"on","type":"string","x-auditable":true},"waf-managed-rules_mode_anomaly":{"description":"Defines the mode anomaly. When set to `on`, the current WAF rule will be used when evaluating the request. Applies to anomaly detection WAF rules.","enum":["on","off"],"example":"on","type":"string","x-auditable":true},"waf-managed-rules_mode_deny_traditional":{"description":"Defines the action that the current WAF rule will perform when triggered. Applies to traditional (deny) WAF rules.","enum":["default","disable","simulate","block","challenge"],"example":"block","type":"string","x-auditable":true},"waf-managed-rules_modified_rules_count":{"default":0,"description":"Defines the number of rules within the group that have been modified from their default configuration.","example":2,"readOnly":true,"type":"number","x-auditable":true},"waf-managed-rules_name":{"description":"Defines the name of the rule group.","example":"Project Honey Pot","readOnly":true,"type":"string","x-auditable":true},"waf-managed-rules_priority":{"description":"Defines the order in which the individual WAF rule is executed within its rule group.","readOnly":true,"type":"string","x-auditable":true},"waf-managed-rules_result_info":{"properties":{"count":{"description":"Defines the total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Defines the current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Defines the number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Defines the total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"},"waf-managed-rules_rule":{"oneOf":[{"$ref":"#/components/schemas/waf-managed-rules_anomaly_rule"},{"$ref":"#/components/schemas/waf-managed-rules_traditional_deny_rule"},{"$ref":"#/components/schemas/waf-managed-rules_traditional_allow_rule"}]},"waf-managed-rules_rule_components-schemas-identifier":{"description":"Defines the unique identifier of the WAF rule.","example":"f939de3be84e66e757adcdcb87908023","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"waf-managed-rules_rule_group_response_collection":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/waf-managed-rules_schemas-group"},"type":"array"}},"type":"object"}]},"waf-managed-rules_rule_group_response_single":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"waf-managed-rules_rule_response_collection":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/waf-managed-rules_rule"},"type":"array"}},"type":"object"}]},"waf-managed-rules_rule_response_single":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"waf-managed-rules_rules_count":{"default":0,"description":"Defines the number of rules in the current rule group.","example":10,"readOnly":true,"type":"number","x-auditable":true},"waf-managed-rules_schemas-base":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_base"}]},"waf-managed-rules_schemas-description":{"description":"Defines the public description of the WAF rule.","example":"SQL injection prevention for SELECT statements","readOnly":true,"type":"string","x-auditable":true},"waf-managed-rules_schemas-group":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_group"},{"properties":{"allowed_modes":{"$ref":"#/components/schemas/waf-managed-rules_allowed_modes"},"mode":{"$ref":"#/components/schemas/waf-managed-rules_mode"}},"type":"object"}],"required":["id","name","description","mode","rules_count"],"type":"object"},"waf-managed-rules_schemas-identifier":{"description":"Defines an identifier of a schema.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"waf-managed-rules_traditional_allow_rule":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_base"},{"properties":{"allowed_modes":{"$ref":"#/components/schemas/waf-managed-rules_allowed_modes_allow_traditional"},"mode":{"$ref":"#/components/schemas/waf-managed-rules_mode_allow_traditional"}},"type":"object"}],"description":"When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An 'allow' rule will immediately allow the request and no other rules will be processed.","required":["id","description","priority","allowed_modes","default_mode","mode","group","package_id"],"title":"Traditional (allow) WAF rule"},"waf-managed-rules_traditional_deny_rule":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_base"},{"properties":{"allowed_modes":{"$ref":"#/components/schemas/waf-managed-rules_allowed_modes_deny_traditional"},"default_mode":{"$ref":"#/components/schemas/waf-managed-rules_default_mode"},"mode":{"$ref":"#/components/schemas/waf-managed-rules_mode_deny_traditional"}},"type":"object"}],"description":"When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A 'deny' rule will immediately respond to the request based on the configured rule action/mode (for example, 'block') and no other rules will be processed.","required":["id","description","priority","allowed_modes","default_mode","mode","group","package_id"],"title":"Traditional (deny) WAF rule"},"waf-product-api-bundle_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_api-response-common"},{"properties":{"result":{"items":{"type":"object"},"nullable":true,"type":"array"}},"type":"object"}],"type":"object"},"waf-product-api-bundle_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/waf-product-api-bundle_messages"},"messages":{"$ref":"#/components/schemas/waf-product-api-bundle_messages"},"result":{"anyOf":[{"type":"object"},{"items":{"type":"object"},"type":"array"},{"type":"string"}]},"success":{"description":"Defines whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"waf-product-api-bundle_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_messages"}],"example":[{"code":10100,"message":"Unknown error occured, please try again"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Defines whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"waf-product-api-bundle_api-response-single":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_api-response-common"},{"properties":{"result":{"anyOf":[{"nullable":true,"type":"object"},{"nullable":true,"type":"string"}]}},"type":"object"}],"type":"object"},"waf-product-api-bundle_custom-detection":{"description":"Defines a custom set of username/password expressions to match Leaked Credential Checks on.","properties":{"id":{"$ref":"#/components/schemas/waf-product-api-bundle_detection-id"},"password":{"description":"Defines ehe ruleset expression to use in matching the password in a request.","example":"lookup_json_string(http.request.body.raw, \"secret\")","type":"string","x-auditable":true},"username":{"description":"Defines the ruleset expression to use in matching the username in a request.","example":"lookup_json_string(http.request.body.raw, \"user\")","type":"string","x-auditable":true}},"type":"object"},"waf-product-api-bundle_custom-scan":{"description":"Defines a custom scan expression to match Content Scanning on.","properties":{"id":{"$ref":"#/components/schemas/waf-product-api-bundle_custom-scan-id"},"payload":{"$ref":"#/components/schemas/waf-product-api-bundle_custom-scan-payload"}},"type":"object"},"waf-product-api-bundle_custom-scan-id":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}],"description":"defines the unique ID for this custom scan expression.","example":"a350a054caa840c9becd89c3b4f0195b"},"waf-product-api-bundle_custom-scan-payload":{"description":"Defines the ruleset expression to use in matching content objects.","example":"lookup_json_string(http.request.body.raw, \"file\")","type":"string","x-auditable":true},"waf-product-api-bundle_detection-id":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}],"description":"Defines the unique ID for this custom detection.","example":"18a14bafaa8eb1df04ce683ec18c765e","x-auditable":true},"waf-product-api-bundle_identifier":{"description":"Defines an identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"waf-product-api-bundle_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"waf-product-api-bundle_response-custom-detection":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/waf-product-api-bundle_custom-detection"}},"type":"object"}]},"waf-product-api-bundle_response-custom-detection-collection":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/waf-product-api-bundle_custom-detection"},"type":"array"}},"type":"object"}]},"waf-product-api-bundle_response-custom-scan-collection":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/waf-product-api-bundle_custom-scan"},"type":"array"}},"type":"object"}]},"waf-product-api-bundle_response-status":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/waf-product-api-bundle_status"}},"type":"object"}]},"waf-product-api-bundle_schemas-api-response-collection":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-api-response-common"},{"properties":{"result":{"items":{"type":"object"},"nullable":true,"type":"array"}},"type":"object"}],"type":"object"},"waf-product-api-bundle_schemas-api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/waf-product-api-bundle_messages"},"messages":{"$ref":"#/components/schemas/waf-product-api-bundle_messages"},"result":{"anyOf":[{"type":"object"},{"items":{"type":"object"},"type":"array"},{"nullable":true,"type":"string"}]},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"waf-product-api-bundle_schemas-api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_messages"}],"example":[{"code":10000,"message":"Authentication error"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"waf-product-api-bundle_schemas-api-response-single":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-api-response-common"},{"properties":{"result":{"anyOf":[{"nullable":true,"type":"object"},{"nullable":true,"type":"string"}]}},"type":"object"}],"type":"object"},"waf-product-api-bundle_schemas-response-status":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-status"}},"type":"object"}]},"waf-product-api-bundle_schemas-status":{"description":"Defines the status for Content Scanning.","properties":{"modified":{"description":"Defines the last modification date (ISO 8601) of the Content Scanning status.","example":"2024-12-02T09:57:23.150259Z","type":"string","x-auditable":true},"value":{"description":"Defines the status of Content Scanning.","example":"enabled","type":"string","x-auditable":true}},"type":"object"},"waf-product-api-bundle_status":{"description":"Defines the overall status for Leaked Credential Checks.","properties":{"enabled":{"description":"Determines whether or not Leaked Credential Checks are enabled.","example":true,"type":"boolean","x-auditable":true}},"type":"object"},"waitingroom_additional_routes":{"description":"Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms.","items":{"properties":{"host":{"description":"The hostname to which this waiting room will be applied (no wildcards). The hostname must be the primary domain, subdomain, or custom hostname (if using SSL for SaaS) of this zone. Please do not include the scheme (http:// or https://).","example":"shop2.example.com","type":"string","x-auditable":true},"path":{"default":"/","description":"Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.","example":"/shop2/checkout","type":"string","x-auditable":true}},"type":"object"},"type":"array"},"waitingroom_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/waitingroom_schemas-api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"waitingroom_api-response-common":{"required":["success","errors","messages","result"],"type":"object"},"waitingroom_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/waitingroom_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/waitingroom_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"waitingroom_api-response-single":{"allOf":[{"$ref":"#/components/schemas/waitingroom_api-response-common"},{"properties":{"result":{"oneOf":[{"type":"object"},{"type":"string"}],"type":"object"}},"type":"object"}],"type":"object"},"waitingroom_cookie_attributes":{"description":"Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.","properties":{"samesite":{"default":"auto","description":"Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`.","enum":["auto","lax","none","strict"],"example":"auto","type":"string","x-auditable":true},"secure":{"default":"auto","description":"Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled.","enum":["auto","always","never"],"example":"auto","type":"string","x-auditable":true}},"type":"object"},"waitingroom_cookie_suffix":{"description":"Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is \"abcd\", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`.","example":"abcd","type":"string","x-auditable":true},"waitingroom_create_rule":{"properties":{"action":{"$ref":"#/components/schemas/waitingroom_rule_action"},"description":{"$ref":"#/components/schemas/waitingroom_rule_description"},"enabled":{"$ref":"#/components/schemas/waitingroom_rule_enabled"},"expression":{"$ref":"#/components/schemas/waitingroom_rule_expression"}},"required":["action","expression"],"type":"object"},"waitingroom_custom_page_html":{"default":"","description":"Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:\n1. {{`waitTimeKnown`}} Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue_all is **true**.\n2. {{`waitTimeFormatted`}} Estimated wait time for the user. For example, five minutes. Alternatively, you can use:\n3. {{`waitTime`}} Number of minutes of estimated wait for a user.\n4. {{`waitTimeHours`}} Number of hours of estimated wait for a user (`Math.floor(waitTime/60)`).\n5. {{`waitTimeHourMinutes`}} Number of minutes above the `waitTimeHours` value (`waitTime%60`).\n6. {{`queueIsFull`}} Changes to **true** when no more people can be added to the queue.\n\nTo view the full list of variables, look at the `cfWaitingRoom` object described under the `json_response_enabled` property in other Waiting Room API calls.","example":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}","type":"string","x-auditable":true},"waitingroom_default_template_language":{"default":"en-US","description":"The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used.","enum":["en-US","es-ES","de-DE","fr-FR","it-IT","ja-JP","ko-KR","pt-BR","zh-CN","zh-TW","nl-NL","pl-PL","id-ID","tr-TR","ar-EG","ru-RU","fa-IR","bg-BG","hr-HR","cs-CZ","da-DK","fi-FI","lt-LT","ms-MY","nb-NO","ro-RO","el-GR","he-IL","hi-IN","hu-HU","sr-BA","sk-SK","sl-SI","sv-SE","tl-PH","th-TH","uk-UA","vi-VN"],"example":"es-ES","type":"string","x-auditable":true},"waitingroom_description":{"default":"","description":"A note that you can use to add more details about the waiting room.","example":"Production - DO NOT MODIFY","type":"string","x-auditable":true},"waitingroom_disable_session_renewal":{"default":false,"description":"Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request.","example":false,"type":"boolean","x-auditable":true},"waitingroom_enabled_origin_commands":{"default":[],"description":"A list of enabled origin commands.","items":{"enum":["revoke"],"type":"string","uniqueItems":true,"x-auditable":true},"type":"array"},"waitingroom_estimated_queued_users":{"type":"integer","x-auditable":true},"waitingroom_estimated_total_active_users":{"type":"integer","x-auditable":true},"waitingroom_event_custom_page_html":{"description":"If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it.","example":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}","nullable":true,"type":"string","x-auditable":true},"waitingroom_event_description":{"default":"","description":"A note that you can use to add more details about the event.","example":"Production event - DO NOT MODIFY","type":"string","x-auditable":true},"waitingroom_event_details_custom_page_html":{"example":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}","type":"string","x-auditable":true},"waitingroom_event_details_disable_session_renewal":{"example":false,"type":"boolean","x-auditable":true},"waitingroom_event_details_new_users_per_minute":{"type":"integer","x-auditable":true},"waitingroom_event_details_queueing_method":{"example":"random","type":"string","x-auditable":true},"waitingroom_event_details_response":{"allOf":[{"$ref":"#/components/schemas/waitingroom_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/waitingroom_event_details_result"}},"type":"object"}],"type":"object"},"waitingroom_event_details_result":{"properties":{"created_on":{"$ref":"#/components/schemas/waitingroom_timestamp"},"custom_page_html":{"$ref":"#/components/schemas/waitingroom_event_details_custom_page_html"},"description":{"$ref":"#/components/schemas/waitingroom_event_description"},"disable_session_renewal":{"$ref":"#/components/schemas/waitingroom_event_details_disable_session_renewal"},"event_end_time":{"$ref":"#/components/schemas/waitingroom_event_end_time"},"event_start_time":{"$ref":"#/components/schemas/waitingroom_event_start_time"},"id":{"$ref":"#/components/schemas/waitingroom_event_id"},"modified_on":{"$ref":"#/components/schemas/waitingroom_timestamp"},"name":{"$ref":"#/components/schemas/waitingroom_event_name"},"new_users_per_minute":{"$ref":"#/components/schemas/waitingroom_event_details_new_users_per_minute"},"prequeue_start_time":{"$ref":"#/components/schemas/waitingroom_event_prequeue_start_time"},"queueing_method":{"$ref":"#/components/schemas/waitingroom_event_details_queueing_method"},"session_duration":{"$ref":"#/components/schemas/waitingroom_event_details_session_duration"},"shuffle_at_event_start":{"$ref":"#/components/schemas/waitingroom_event_shuffle_at_event_start"},"suspended":{"$ref":"#/components/schemas/waitingroom_event_suspended"},"total_active_users":{"$ref":"#/components/schemas/waitingroom_event_details_total_active_users"}},"type":"object"},"waitingroom_event_details_session_duration":{"type":"integer","x-auditable":true},"waitingroom_event_details_total_active_users":{"type":"integer","x-auditable":true},"waitingroom_event_disable_session_renewal":{"description":"If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it.","nullable":true,"type":"boolean","x-auditable":true},"waitingroom_event_end_time":{"description":"An ISO 8601 timestamp that marks the end of the event.","example":"2021-09-28T17:00:00.000Z","type":"string","x-auditable":true},"waitingroom_event_id":{"example":"25756b2dfe6e378a06b033b670413757","type":"string","x-auditable":true},"waitingroom_event_id_response":{"allOf":[{"$ref":"#/components/schemas/waitingroom_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/waitingroom_event_id"}},"type":"object"}},"type":"object"}],"type":"object"},"waitingroom_event_name":{"description":"A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.","example":"production_webinar_event","type":"string","x-auditable":true},"waitingroom_event_new_users_per_minute":{"description":"If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set.","maximum":2147483647,"minimum":200,"nullable":true,"type":"integer","x-auditable":true},"waitingroom_event_prequeue_start_time":{"description":"An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`.","example":"2021-09-28T15:00:00.000Z","nullable":true,"type":"string","x-auditable":true},"waitingroom_event_queueing_method":{"description":"If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.","example":"random","nullable":true,"type":"string","x-auditable":true},"waitingroom_event_response":{"allOf":[{"$ref":"#/components/schemas/waitingroom_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/waitingroom_event_result"}},"type":"object"}],"type":"object"},"waitingroom_event_response_collection":{"allOf":[{"$ref":"#/components/schemas/waitingroom_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/waitingroom_event_result"},"type":"array"}},"type":"object"}],"type":"object"},"waitingroom_event_result":{"properties":{"created_on":{"$ref":"#/components/schemas/waitingroom_timestamp"},"custom_page_html":{"$ref":"#/components/schemas/waitingroom_event_custom_page_html"},"description":{"$ref":"#/components/schemas/waitingroom_event_description"},"disable_session_renewal":{"$ref":"#/components/schemas/waitingroom_event_disable_session_renewal"},"event_end_time":{"$ref":"#/components/schemas/waitingroom_event_end_time"},"event_start_time":{"$ref":"#/components/schemas/waitingroom_event_start_time"},"id":{"$ref":"#/components/schemas/waitingroom_event_id"},"modified_on":{"$ref":"#/components/schemas/waitingroom_timestamp"},"name":{"$ref":"#/components/schemas/waitingroom_event_name"},"new_users_per_minute":{"$ref":"#/components/schemas/waitingroom_event_new_users_per_minute"},"prequeue_start_time":{"$ref":"#/components/schemas/waitingroom_event_prequeue_start_time"},"queueing_method":{"$ref":"#/components/schemas/waitingroom_event_queueing_method"},"session_duration":{"$ref":"#/components/schemas/waitingroom_event_session_duration"},"shuffle_at_event_start":{"$ref":"#/components/schemas/waitingroom_event_shuffle_at_event_start"},"suspended":{"$ref":"#/components/schemas/waitingroom_event_suspended"},"total_active_users":{"$ref":"#/components/schemas/waitingroom_event_total_active_users"},"turnstile_action":{"$ref":"#/components/schemas/waitingroom_event_turnstile_action"},"turnstile_mode":{"$ref":"#/components/schemas/waitingroom_event_turnstile_mode"}},"type":"object"},"waitingroom_event_session_duration":{"description":"If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.","maximum":30,"minimum":1,"nullable":true,"type":"integer","x-auditable":true},"waitingroom_event_shuffle_at_event_start":{"default":false,"description":"If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary.","type":"boolean","x-auditable":true},"waitingroom_event_start_time":{"description":"An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`.","example":"2021-09-28T15:30:00.000Z","type":"string","x-auditable":true},"waitingroom_event_suspended":{"default":false,"description":"Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration.","type":"boolean","x-auditable":true},"waitingroom_event_total_active_users":{"description":"If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set.","maximum":2147483647,"minimum":200,"nullable":true,"type":"integer","x-auditable":true},"waitingroom_event_turnstile_action":{"description":"If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it.","enum":["log","infinite_queue"],"nullable":true,"type":"string","x-auditable":true},"waitingroom_event_turnstile_mode":{"description":"If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it.","enum":["off","invisible","visible_non_interactive","visible_managed"],"nullable":true,"type":"string","x-auditable":true},"waitingroom_host":{"description":"The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique.","example":"shop.example.com","type":"string","x-auditable":true},"waitingroom_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"waitingroom_json_response_enabled":{"default":false,"description":"Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields:\n1. `inWaitingRoom`: Boolean indicating if the user is in the waiting room (always **true**).\n2. `waitTimeKnown`: Boolean indicating if the current estimated wait times are accurate. If **false**, they are not available.\n3. `waitTime`: Valid only when `waitTimeKnown` is **true**. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When `queueingMethod` is **random**, this is set to `waitTime50Percentile`.\n4. `waitTime25Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile).\n5. `waitTime50Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before `waitTime50Percentile` and half are expected to be let in after it.\n6. `waitTime75Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile).\n7. `waitTimeFormatted`: String displaying the `waitTime` formatted in English for users. If `waitTimeKnown` is **false**, `waitTimeFormatted` will display **unavailable**.\n8. `queueIsFull`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n9. `queueAll`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.\n10. `lastUpdated`: String displaying the timestamp as an ISO 8601 string of the user's last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after `refreshIntervalSeconds` past this time. If the user makes a request too soon, it will be ignored and `lastUpdated` will not change.\n11. `refreshIntervalSeconds`: Integer indicating the number of seconds after `lastUpdated` until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the `queueingMethod` is `reject`, there is no specified refresh time —\\_it will always be **zero**.\n12. `queueingMethod`: The queueing method currently used by the waiting room. It is either **fifo**, **random**, **passthrough**, or **reject**.\n13. `isFIFOQueue`: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.\n14. `isRandomQueue`: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.\n15. `isPassthroughQueue`: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when `queueAll` is **true** or `isEventPrequeueing` is **true** because in all other cases requests will go directly to the origin.\n16. `isRejectQueue`: Boolean indicating if the waiting room uses a reject queue.\n17. `isEventActive`: Boolean indicating if an event is currently occurring. Events are able to change a waiting room's behavior during a specified period of time. For additional information, look at the event properties `prequeue_start_time`, `event_start_time`, and `event_end_time` in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists.\n18. `isEventPrequeueing`: Valid only when `isEventActive` is **true**. Boolean indicating if an event is currently prequeueing users before it starts.\n19. `timeUntilEventStart`: Valid only when `isEventPrequeueing` is **true**. Integer indicating the number of minutes until the event starts.\n20. `timeUntilEventStartFormatted`: String displaying the `timeUntilEventStart` formatted in English for users. If `isEventPrequeueing` is **false**, `timeUntilEventStartFormatted` will display **unavailable**.\n21. `timeUntilEventEnd`: Valid only when `isEventActive` is **true**. Integer indicating the number of minutes until the event ends.\n22. `timeUntilEventEndFormatted`: String displaying the `timeUntilEventEnd` formatted in English for users. If `isEventActive` is **false**, `timeUntilEventEndFormatted` will display **unavailable**.\n23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.\n24. `turnstile`: Empty when turnstile isn't enabled. String displaying an html tag to display the Turnstile widget. Please add the `{{{turnstile}}}` tag to the `custom_html` template to ensure the Turnstile widget appears.\n25. `infiniteQueue`: Boolean indicating whether the response is for a user in the infinite queue.\n\nAn example cURL to a waiting room could be:\n\n\tcurl -X GET \"https://example.com/waitingroom\" \\\n\t\t-H \"Accept: application/json\"\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **fifo** and no event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 0,\n\t\t\t\"waitTime50Percentile\": 0,\n\t\t\t\"waitTime75Percentile\": 0,\n\t\t\t\"waitTimeFormatted\": \"10 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"fifo\",\n\t\t\t\"isFIFOQueue\": true,\n\t\t\t\"isRandomQueue\": false,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": false,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 0,\n\t\t\t\"timeUntilEventEndFormatted\": \"unavailable\",\n\t\t\t\"shuffleAtEventStart\": false\n\t\t}\n\t}\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **random** and an event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 5,\n\t\t\t\"waitTime50Percentile\": 10,\n\t\t\t\"waitTime75Percentile\": 15,\n\t\t\t\"waitTimeFormatted\": \"5 minutes to 15 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"random\",\n\t\t\t\"isFIFOQueue\": false,\n\t\t\t\"isRandomQueue\": true,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": true,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 15,\n\t\t\t\"timeUntilEventEndFormatted\": \"15 minutes\",\n\t\t\t\"shuffleAtEventStart\": true\n\t\t}\n\t}","example":false,"type":"boolean","x-auditable":true},"waitingroom_max_estimated_time_minutes":{"type":"integer","x-auditable":true},"waitingroom_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"waitingroom_name":{"description":"A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed.","example":"production_webinar","type":"string","x-auditable":true},"waitingroom_new_users_per_minute":{"description":"Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world.","maximum":2147483647,"minimum":200,"type":"integer","x-auditable":true},"waitingroom_next_event_prequeue_start_time":{"description":"An ISO 8601 timestamp that marks when the next event will begin queueing.","example":"2021-09-28T15:00:00.000Z","nullable":true,"type":"string","x-auditable":true},"waitingroom_next_event_start_time":{"description":"An ISO 8601 timestamp that marks when the next event will start.","example":"2021-09-28T15:00:00.000Z","nullable":true,"type":"string","x-auditable":true},"waitingroom_patch_rule":{"properties":{"action":{"$ref":"#/components/schemas/waitingroom_rule_action"},"description":{"$ref":"#/components/schemas/waitingroom_rule_description"},"enabled":{"$ref":"#/components/schemas/waitingroom_rule_enabled"},"expression":{"$ref":"#/components/schemas/waitingroom_rule_expression"},"position":{"$ref":"#/components/schemas/waitingroom_rule_position"}},"required":["action","expression"],"type":"object"},"waitingroom_path":{"default":"/","description":"Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.","example":"/shop/checkout","type":"string","x-auditable":true},"waitingroom_preview_response":{"allOf":[{"$ref":"#/components/schemas/waitingroom_api-response-single"},{"properties":{"result":{"properties":{"preview_url":{"$ref":"#/components/schemas/waitingroom_preview_url"}},"type":"object"}},"type":"object"}],"type":"object"},"waitingroom_preview_url":{"description":"URL where the custom waiting room page can temporarily be previewed.","example":"http://waitingrooms.dev/preview/35af8c12-6d68-4608-babb-b53435a5ddfb","type":"string","x-auditable":true},"waitingroom_query_event":{"properties":{"custom_page_html":{"$ref":"#/components/schemas/waitingroom_event_custom_page_html"},"description":{"$ref":"#/components/schemas/waitingroom_event_description"},"disable_session_renewal":{"$ref":"#/components/schemas/waitingroom_event_disable_session_renewal"},"event_end_time":{"$ref":"#/components/schemas/waitingroom_event_end_time"},"event_start_time":{"$ref":"#/components/schemas/waitingroom_event_start_time"},"name":{"$ref":"#/components/schemas/waitingroom_event_name"},"new_users_per_minute":{"$ref":"#/components/schemas/waitingroom_event_new_users_per_minute"},"prequeue_start_time":{"$ref":"#/components/schemas/waitingroom_event_prequeue_start_time"},"queueing_method":{"$ref":"#/components/schemas/waitingroom_event_queueing_method"},"session_duration":{"$ref":"#/components/schemas/waitingroom_event_session_duration"},"shuffle_at_event_start":{"$ref":"#/components/schemas/waitingroom_event_shuffle_at_event_start"},"suspended":{"$ref":"#/components/schemas/waitingroom_event_suspended"},"total_active_users":{"$ref":"#/components/schemas/waitingroom_event_total_active_users"},"turnstile_action":{"$ref":"#/components/schemas/waitingroom_event_turnstile_action"},"turnstile_mode":{"$ref":"#/components/schemas/waitingroom_event_turnstile_mode"}},"required":["name","event_start_time","event_end_time"],"type":"object"},"waitingroom_query_preview":{"properties":{"custom_html":{"$ref":"#/components/schemas/waitingroom_custom_page_html"}},"required":["custom_html"],"type":"object"},"waitingroom_query_waitingroom":{"properties":{"additional_routes":{"$ref":"#/components/schemas/waitingroom_additional_routes"},"cookie_attributes":{"$ref":"#/components/schemas/waitingroom_cookie_attributes"},"cookie_suffix":{"$ref":"#/components/schemas/waitingroom_cookie_suffix"},"custom_page_html":{"$ref":"#/components/schemas/waitingroom_custom_page_html"},"default_template_language":{"$ref":"#/components/schemas/waitingroom_default_template_language"},"description":{"$ref":"#/components/schemas/waitingroom_description"},"disable_session_renewal":{"$ref":"#/components/schemas/waitingroom_disable_session_renewal"},"enabled_origin_commands":{"$ref":"#/components/schemas/waitingroom_enabled_origin_commands"},"host":{"$ref":"#/components/schemas/waitingroom_host"},"json_response_enabled":{"$ref":"#/components/schemas/waitingroom_json_response_enabled"},"name":{"$ref":"#/components/schemas/waitingroom_name"},"new_users_per_minute":{"$ref":"#/components/schemas/waitingroom_new_users_per_minute"},"path":{"$ref":"#/components/schemas/waitingroom_path"},"queue_all":{"$ref":"#/components/schemas/waitingroom_queue_all"},"queueing_method":{"$ref":"#/components/schemas/waitingroom_queueing_method"},"queueing_status_code":{"$ref":"#/components/schemas/waitingroom_queueing_status_code"},"session_duration":{"$ref":"#/components/schemas/waitingroom_session_duration"},"suspended":{"$ref":"#/components/schemas/waitingroom_suspended"},"total_active_users":{"$ref":"#/components/schemas/waitingroom_total_active_users"},"turnstile_action":{"$ref":"#/components/schemas/waitingroom_turnstile_action"},"turnstile_mode":{"$ref":"#/components/schemas/waitingroom_turnstile_mode"}},"required":["name","host","new_users_per_minute","total_active_users"],"type":"object"},"waitingroom_queue_all":{"default":false,"description":"If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.","example":true,"type":"boolean","x-auditable":true},"waitingroom_queueing_method":{"default":"fifo","description":"Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are:\n1. `fifo` **(default)**: First-In-First-Out queue where customers gain access in the order they arrived.\n2. `random`: Random queue where customers gain access randomly, regardless of arrival time.\n3. `passthrough`: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with `suspended`) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa.\n4. `reject`: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses `reject`, and its events override this with `fifo`, `random`, or `passthrough`. When this queueing method is enabled and neither `queueAll` is enabled nor an event is prequeueing, the waiting room page **will not refresh automatically**.","enum":["fifo","random","passthrough","reject"],"example":"fifo","type":"string","x-auditable":true},"waitingroom_queueing_status_code":{"default":200,"description":"HTTP status code returned to a user while in the queue.","enum":[200,202,429],"example":202,"type":"integer","x-auditable":true},"waitingroom_response_collection":{"allOf":[{"$ref":"#/components/schemas/waitingroom_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/waitingroom_waitingroom"},"type":"array"}},"type":"object"}],"type":"object"},"waitingroom_rule_action":{"description":"The action to take when the expression matches.","enum":["bypass_waiting_room"],"example":"bypass_waiting_room","type":"string","x-auditable":true},"waitingroom_rule_description":{"default":"","description":"The description of the rule.","example":"allow all traffic from 10.20.30.40","type":"string","x-auditable":true},"waitingroom_rule_enabled":{"default":true,"description":"When set to true, the rule is enabled.","example":true,"type":"boolean","x-auditable":true},"waitingroom_rule_expression":{"description":"Criteria defining when there is a match for the current rule.","example":"ip.src in {10.20.30.40}","type":"string","x-auditable":true},"waitingroom_rule_id":{"description":"The ID of the rule.","example":"25756b2dfe6e378a06b033b670413757","type":"string","x-auditable":true},"waitingroom_rule_position":{"description":"Reorder the position of a rule","oneOf":[{"properties":{"index":{"description":"Places the rule in the exact position specified by the integer number \u003cPOSITION_NUMBER\u003e. Position numbers start with 1. Existing rules in the ruleset from the specified position number onward are shifted one position (no rule is overwritten).","type":"integer","x-auditable":true}},"type":"object"},{"properties":{"before":{"description":"Places the rule before rule \u003cRULE_ID\u003e. Use this argument with an empty rule ID value (\"\") to set the rule as the first rule in the ruleset.","example":"\u003cRULE_ID\u003e","type":"string","x-auditable":true}},"type":"object"},{"properties":{"after":{"description":"Places the rule after rule \u003cRULE_ID\u003e. Use this argument with an empty rule ID value (\"\") to set the rule as the last rule in the ruleset.","example":"\u003cRULE_ID\u003e","type":"string","x-auditable":true}},"type":"object"}],"type":"object"},"waitingroom_rule_result":{"properties":{"action":{"$ref":"#/components/schemas/waitingroom_rule_action"},"description":{"$ref":"#/components/schemas/waitingroom_rule_description"},"enabled":{"$ref":"#/components/schemas/waitingroom_rule_enabled"},"expression":{"$ref":"#/components/schemas/waitingroom_rule_expression"},"id":{"$ref":"#/components/schemas/waitingroom_rule_id"},"last_updated":{"$ref":"#/components/schemas/waitingroom_timestamp"},"version":{"$ref":"#/components/schemas/waitingroom_rule_version"}},"type":"object"},"waitingroom_rule_version":{"description":"The version of the rule.","example":"1","type":"string","x-auditable":true},"waitingroom_rules_response_collection":{"allOf":[{"$ref":"#/components/schemas/waitingroom_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/waitingroom_rule_result"},"type":"array"}},"type":"object"}],"type":"object"},"waitingroom_schemas-api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/waitingroom_messages"},"messages":{"$ref":"#/components/schemas/waitingroom_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"waitingroom_search_engine_crawler_bypass":{"default":false,"description":"Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone.\nVerified search engine crawlers will not be tracked or counted by the waiting room system,\nand will not appear in waiting room analytics.\n","example":true,"type":"boolean","x-auditable":true},"waitingroom_session_duration":{"default":5,"description":"Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route.","maximum":30,"minimum":1,"type":"integer","x-auditable":true},"waitingroom_single_response":{"allOf":[{"$ref":"#/components/schemas/waitingroom_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/waitingroom_waitingroom"}},"type":"object"}],"type":"object"},"waitingroom_status":{"enum":["event_prequeueing","not_queueing","queueing","suspended"],"example":"queueing","type":"string","x-auditable":true},"waitingroom_status_event_id":{"example":"25756b2dfe6e378a06b033b670413757","type":"string","x-auditable":true},"waitingroom_status_response":{"allOf":[{"$ref":"#/components/schemas/waitingroom_api-response-single"},{"properties":{"result":{"properties":{"estimated_queued_users":{"$ref":"#/components/schemas/waitingroom_estimated_queued_users"},"estimated_total_active_users":{"$ref":"#/components/schemas/waitingroom_estimated_total_active_users"},"event_id":{"$ref":"#/components/schemas/waitingroom_status_event_id"},"max_estimated_time_minutes":{"$ref":"#/components/schemas/waitingroom_max_estimated_time_minutes"},"status":{"$ref":"#/components/schemas/waitingroom_status"}},"type":"object"}},"type":"object"}],"type":"object"},"waitingroom_suspended":{"default":false,"description":"Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room.","type":"boolean","x-auditable":true},"waitingroom_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"waitingroom_total_active_users":{"description":"Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world.","maximum":2147483647,"minimum":200,"type":"integer","x-auditable":true},"waitingroom_turnstile_action":{"default":"log","description":"Which action to take when a bot is detected using Turnstile. `log` will\nhave no impact on queueing behavior, simply keeping track of how many\nbots are detected in Waiting Room Analytics. `infinite_queue` will send\nbots to a false queueing state, where they will never reach your\norigin. `infinite_queue` requires Advanced Waiting Room.\n","enum":["log","infinite_queue"],"type":"string","x-auditable":true},"waitingroom_turnstile_mode":{"default":"invisible","description":"Which Turnstile widget type to use for detecting bot traffic. See\n[the Turnstile documentation](https://developers.cloudflare.com/turnstile/concepts/widget/#widget-types)\nfor the definitions of these widget types. Set to `off` to disable the\nTurnstile integration entirely. Setting this to anything other than\n`off` or `invisible` requires Advanced Waiting Room.\n","enum":["off","invisible","visible_non_interactive","visible_managed"],"type":"string","x-auditable":true},"waitingroom_update_rules":{"items":{"$ref":"#/components/schemas/waitingroom_create_rule"},"type":"array"},"waitingroom_waiting_room_id":{"example":"699d98642c564d2e855e9661899b7252","type":"string","x-auditable":true},"waitingroom_waiting_room_id_response":{"allOf":[{"$ref":"#/components/schemas/waitingroom_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},"type":"object"}},"type":"object"}],"type":"object"},"waitingroom_waitingroom":{"properties":{"additional_routes":{"$ref":"#/components/schemas/waitingroom_additional_routes"},"cookie_attributes":{"$ref":"#/components/schemas/waitingroom_cookie_attributes"},"cookie_suffix":{"$ref":"#/components/schemas/waitingroom_cookie_suffix"},"created_on":{"$ref":"#/components/schemas/waitingroom_timestamp"},"custom_page_html":{"$ref":"#/components/schemas/waitingroom_custom_page_html"},"default_template_language":{"$ref":"#/components/schemas/waitingroom_default_template_language"},"description":{"$ref":"#/components/schemas/waitingroom_description"},"disable_session_renewal":{"$ref":"#/components/schemas/waitingroom_disable_session_renewal"},"enabled_origin_commands":{"$ref":"#/components/schemas/waitingroom_enabled_origin_commands"},"host":{"$ref":"#/components/schemas/waitingroom_host"},"id":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"},"json_response_enabled":{"$ref":"#/components/schemas/waitingroom_json_response_enabled"},"modified_on":{"$ref":"#/components/schemas/waitingroom_timestamp"},"name":{"$ref":"#/components/schemas/waitingroom_name"},"new_users_per_minute":{"$ref":"#/components/schemas/waitingroom_new_users_per_minute"},"next_event_prequeue_start_time":{"$ref":"#/components/schemas/waitingroom_next_event_prequeue_start_time"},"next_event_start_time":{"$ref":"#/components/schemas/waitingroom_next_event_start_time"},"path":{"$ref":"#/components/schemas/waitingroom_path"},"queue_all":{"$ref":"#/components/schemas/waitingroom_queue_all"},"queueing_method":{"$ref":"#/components/schemas/waitingroom_queueing_method"},"queueing_status_code":{"$ref":"#/components/schemas/waitingroom_queueing_status_code"},"session_duration":{"$ref":"#/components/schemas/waitingroom_session_duration"},"suspended":{"$ref":"#/components/schemas/waitingroom_suspended"},"total_active_users":{"$ref":"#/components/schemas/waitingroom_total_active_users"},"turnstile_action":{"$ref":"#/components/schemas/waitingroom_turnstile_action"},"turnstile_mode":{"$ref":"#/components/schemas/waitingroom_turnstile_mode"}},"type":"object"},"waitingroom_zone_settings":{"properties":{"search_engine_crawler_bypass":{"$ref":"#/components/schemas/waitingroom_search_engine_crawler_bypass"}},"type":"object"},"waitingroom_zone_settings_response":{"allOf":[{"$ref":"#/components/schemas/waitingroom_api-response-single"},{"properties":{"result":{"properties":{"search_engine_crawler_bypass":{"$ref":"#/components/schemas/waitingroom_search_engine_crawler_bypass"}},"required":["search_engine_crawler_bypass"],"type":"object"}},"required":["result"],"type":"object"}],"type":"object"},"web3_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/web3_api-response-common"},{"properties":{"result":{"items":{},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/web3_result_info"}}}],"type":"object"},"web3_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/web3_messages"},"messages":{"$ref":"#/components/schemas/web3_messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}],"description":"Provides the API response.","type":"object"},"success":{"description":"Specifies whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"web3_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/web3_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/web3_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Specifies whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"web3_api-response-single":{"allOf":[{"$ref":"#/components/schemas/web3_api-response-common"},{"properties":{"result_info":{"anyOf":[{"nullable":true,"type":"object"},{"nullable":true,"type":"string"}],"description":"Provides the API response.","type":"object"}}}],"type":"object"},"web3_api-response-single-id":{"allOf":[{"$ref":"#/components/schemas/web3_api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/web3_identifier"}},"required":["id"],"type":"object"}}}],"type":"object"},"web3_collection_response":{"allOf":[{"$ref":"#/components/schemas/web3_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/web3_web3-hostname"},"type":"array"}}}]},"web3_content_list_action":{"description":"Behavior of the content list.","enum":["block"],"example":"block","type":"string"},"web3_content_list_details":{"properties":{"action":{"$ref":"#/components/schemas/web3_content_list_action"}},"type":"object"},"web3_content_list_details_response":{"allOf":[{"$ref":"#/components/schemas/web3_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/web3_content_list_details"}}}]},"web3_content_list_entries":{"description":"Provides content list entries.","items":{"$ref":"#/components/schemas/web3_content_list_entry"},"type":"array"},"web3_content_list_entry":{"description":"Specify a content list entry to block.","properties":{"content":{"$ref":"#/components/schemas/web3_content_list_entry_content"},"created_on":{"$ref":"#/components/schemas/web3_timestamp"},"description":{"$ref":"#/components/schemas/web3_content_list_entry_description"},"id":{"$ref":"#/components/schemas/web3_identifier"},"modified_on":{"$ref":"#/components/schemas/web3_timestamp"},"type":{"$ref":"#/components/schemas/web3_content_list_entry_type"}},"type":"object"},"web3_content_list_entry_collection_response":{"allOf":[{"$ref":"#/components/schemas/web3_api-response-collection"},{"properties":{"result":{"properties":{"entries":{"$ref":"#/components/schemas/web3_content_list_entries"}},"type":"object"}}}]},"web3_content_list_entry_content":{"description":"Specify the CID or content path of content to block.","example":"QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB","maxLength":500,"type":"string"},"web3_content_list_entry_create_request":{"properties":{"content":{"$ref":"#/components/schemas/web3_content_list_entry_content"},"description":{"$ref":"#/components/schemas/web3_content_list_entry_description"},"type":{"$ref":"#/components/schemas/web3_content_list_entry_type"}},"required":["type","content"],"type":"object"},"web3_content_list_entry_description":{"description":"Specify an optional description of the content list entry.","example":"this is my content list entry","maxLength":500,"type":"string"},"web3_content_list_entry_single_response":{"allOf":[{"$ref":"#/components/schemas/web3_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/web3_content_list_entry"}}}]},"web3_content_list_entry_type":{"description":"Specify the type of content list entry to block.","enum":["cid","content_path"],"example":"cid","type":"string"},"web3_content_list_update_request":{"properties":{"action":{"$ref":"#/components/schemas/web3_content_list_action"},"entries":{"$ref":"#/components/schemas/web3_content_list_entries"}},"required":["action","entries"],"type":"object"},"web3_create_request":{"properties":{"description":{"$ref":"#/components/schemas/web3_description"},"dnslink":{"$ref":"#/components/schemas/web3_dnslink"},"name":{"$ref":"#/components/schemas/web3_name"},"target":{"$ref":"#/components/schemas/web3_target"}},"required":["name","target"],"type":"object"},"web3_description":{"description":"Specify an optional description of the hostname.","example":"This is my IPFS gateway.","maxLength":500,"type":"string"},"web3_dnslink":{"description":"Specify the DNSLink value used if the target is ipfs.","example":"/ipns/onboarding.ipfs.cloudflare.com","type":"string"},"web3_identifier":{"description":"Specify the identifier of the hostname.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"web3_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"web3_modify_request":{"properties":{"description":{"$ref":"#/components/schemas/web3_description"},"dnslink":{"$ref":"#/components/schemas/web3_dnslink"}},"type":"object"},"web3_name":{"description":"Specify the hostname that points to the target gateway via CNAME.","example":"gateway.example.com","maxLength":255,"type":"string"},"web3_result_info":{"properties":{"count":{"description":"Specifies the total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Specifies the current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Specifies the number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Specifies the total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"},"web3_single_response":{"allOf":[{"$ref":"#/components/schemas/web3_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/web3_web3-hostname"}}}]},"web3_status":{"description":"Specifies the status of the hostname's activation.","enum":["active","pending","deleting","error"],"example":"active","readOnly":true,"type":"string"},"web3_target":{"description":"Specify the target gateway of the hostname.","enum":["ethereum","ipfs","ipfs_universal_path"],"example":"ipfs","type":"string"},"web3_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"web3_web3-hostname":{"properties":{"created_on":{"$ref":"#/components/schemas/web3_timestamp"},"description":{"$ref":"#/components/schemas/web3_description"},"dnslink":{"$ref":"#/components/schemas/web3_dnslink"},"id":{"$ref":"#/components/schemas/web3_identifier"},"modified_on":{"$ref":"#/components/schemas/web3_timestamp"},"name":{"$ref":"#/components/schemas/web3_name"},"status":{"$ref":"#/components/schemas/web3_status"},"target":{"$ref":"#/components/schemas/web3_target"}},"type":"object"},"workers-kv_any":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"additionalProperties":true,"nullable":true,"type":"object"},{"items":{"$ref":"#/components/schemas/workers-kv_any"},"type":"array"}],"x-stainless-override-schema":{"type":"unknown"}},"workers-kv_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common"},{"properties":{"result_info":{"$ref":"#/components/schemas/workers-kv_result_info"}},"type":"object"}],"type":"object"},"workers-kv_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/workers-kv_messages"},"messages":{"$ref":"#/components/schemas/workers-kv_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"workers-kv_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/workers-kv_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/workers-kv_messages"}],"example":[]},"result":{"nullable":true,"type":"object","x-stainless-empty-object":true},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"workers-kv_api-response-common-no-result":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common"},{"properties":{"result":{"nullable":true,"type":"object","x-stainless-empty-object":true}},"type":"object"}]},"workers-kv_bulk-get-result":{"properties":{"values":{"additionalProperties":{"description":"The value associated with the key.","oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"additionalProperties":true,"type":"object"}]},"description":"Requested keys are paired with their values in an object.","example":{"key1":"value1","key2":"value2"},"type":"object"}},"type":"object"},"workers-kv_bulk-get-result-with-metadata":{"properties":{"values":{"additionalProperties":{"nullable":true,"properties":{"expiration":{"$ref":"#/components/schemas/workers-kv_expiration"},"metadata":{"allOf":[{"$ref":"#/components/schemas/workers-kv_any"},{"description":"The metadata associated with the key."}]},"value":{"allOf":[{"$ref":"#/components/schemas/workers-kv_any"},{"description":"The value associated with the key."}]}},"required":["value","metadata"],"type":"object"},"description":"Requested keys are paired with their values and metadata in an object.","example":{"key1":{"expiration":1577836800,"metadata":{"someMetadataKey":"someMetadataValue"},"value":"value1"},"key2":{"metadata":{"anotherKey":"anotherValue"},"value":"value2"}},"type":"object"}},"type":"object"},"workers-kv_bulk-result":{"properties":{"successful_key_count":{"description":"Number of keys successfully updated.","example":100,"type":"number"},"unsuccessful_keys":{"description":"Name of the keys that failed to be fully updated. They should be retried.","items":{"type":"string"},"type":"array"}},"type":"object"},"workers-kv_bulk_delete":{"items":{"$ref":"#/components/schemas/workers-kv_key_name_bulk"},"type":"array"},"workers-kv_bulk_write":{"items":{"properties":{"base64":{"default":false,"description":"Indicates whether or not the server should base64 decode the value before storing it. Useful for writing values that wouldn't otherwise be valid JSON strings, such as images.","type":"boolean"},"expiration":{"$ref":"#/components/schemas/workers-kv_expiration"},"expiration_ttl":{"$ref":"#/components/schemas/workers-kv_expiration_ttl"},"key":{"$ref":"#/components/schemas/workers-kv_key_name_bulk"},"metadata":{"$ref":"#/components/schemas/workers-kv_list_metadata"},"value":{"description":"A UTF-8 encoded string to be stored, up to 25 MiB in length.","example":"Some string","maxLength":26214400,"type":"string"}},"required":["key","value"],"type":"object"},"type":"array"},"workers-kv_create_rename_namespace_body":{"properties":{"title":{"$ref":"#/components/schemas/workers-kv_namespace_title"}},"required":["title"],"type":"object"},"workers-kv_cursor":{"description":"Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure.","example":"6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw","type":"string"},"workers-kv_expiration":{"description":"Expires the key at a certain time, measured in number of seconds since the UNIX epoch.","example":1578435000,"type":"number"},"workers-kv_expiration_ttl":{"description":"Expires the key after a number of seconds. Must be at least 60.","example":300,"minimum":60,"type":"number"},"workers-kv_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"workers-kv_key":{"description":"A name for a value. A value stored under a given key may be retrieved via the same key.","properties":{"expiration":{"description":"The time, measured in number of seconds since the UNIX epoch, at which the key will expire. This property is omitted for keys that will not expire.","example":1577836800,"type":"number"},"metadata":{"$ref":"#/components/schemas/workers-kv_list_metadata"},"name":{"$ref":"#/components/schemas/workers-kv_key_name"}},"required":["name"],"type":"object"},"workers-kv_key_name":{"description":"A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid. Use percent-encoding to define key names as part of a URL.","example":"My-Key","maxLength":512,"type":"string"},"workers-kv_key_name_bulk":{"description":"A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid.","example":"My-Key","maxLength":512,"type":"string"},"workers-kv_list_metadata":{"allOf":[{"$ref":"#/components/schemas/workers-kv_any"},{"description":"Arbitrary JSON that is associated with a key.","example":{"someMetadataKey":"someMetadataValue"}}]},"workers-kv_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array","uniqueItems":true},"workers-kv_metadata":{"allOf":[{"$ref":"#/components/schemas/workers-kv_any"},{"description":"Associates arbitrary JSON data with a key/value pair.","example":{"someMetadataKey":"someMetadataValue"}}]},"workers-kv_namespace":{"properties":{"id":{"$ref":"#/components/schemas/workers-kv_namespace_identifier"},"supports_url_encoding":{"description":"True if keys written on the URL will be URL-decoded before storing. For example, if set to \"true\", a key written on the URL as \"%3F\" will be stored as \"?\".","example":true,"readOnly":true,"type":"boolean","x-auditable":true},"title":{"$ref":"#/components/schemas/workers-kv_namespace_title"}},"required":["id","title"],"type":"object"},"workers-kv_namespace_identifier":{"description":"Namespace identifier tag.","example":"0f2ac74b498b48028cb68387c421e279","maxLength":32,"readOnly":true,"type":"string","x-auditable":true},"workers-kv_namespace_title":{"description":"A human-readable string name for a Namespace.","example":"My Own Namespace","maxLength":512,"type":"string","x-auditable":true},"workers-kv_result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"},"workers-kv_value":{"anyOf":[{"type":"string"},{"format":"binary","type":"string"}],"description":"A byte sequence to be stored, up to 25 MiB in length.","example":"Some Value"},"workers-observability_performance_information":{"description":"The statistics object contains information about query performance from the database, it does not include any network latency","properties":{"abr_level":{"description":"The level of Adaptive Bit Rate (ABR) sampling used for the query. If empty the ABR level is 1","type":"number"},"bytes_read":{"description":"Number of uncompressed bytes read from the table.","type":"number"},"elapsed":{"description":"Time in seconds for the query to run.","type":"number"},"rows_read":{"description":"Number of rows scanned from the table.","type":"number"}},"required":["elapsed","rows_read","bytes_read"],"type":"object"},"workers-observability_query":{"properties":{"created":{"type":"string"},"description":{"example":"Query description","maxLength":1000,"nullable":true,"type":"string"},"environmentId":{"description":"ID of your environment","example":"my-environment","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"generated":{"description":"Flag for alerts automatically created","nullable":true,"type":"boolean"},"id":{"description":"ID of the query","example":"query-1","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"name":{"description":"Query name","nullable":true,"type":"string"},"parameters":{"properties":{"calculations":{"description":"Create Calculations to compute as part of the query.","items":{"properties":{"alias":{"type":"string"},"key":{"type":"string"},"keyType":{"enum":["string","number","boolean"],"type":"string"},"operator":{"enum":["uniq","count","max","min","sum","avg","median","p001","p01","p05","p10","p25","p75","p90","p95","p99","p999","stddev","variance","COUNT_DISTINCT","COUNT","MAX","MIN","SUM","AVG","MEDIAN","P001","P01","P05","P10","P25","P75","P90","P95","P99","P999","STDDEV","VARIANCE"],"type":"string"}},"required":["operator"],"type":"object"},"type":"array"},"datasets":{"description":"Set the Datasets to query. Leave it empty to query all the datasets.","example":[],"items":{"type":"string"},"type":"array"},"filterCombination":{"description":"Set a Flag to describe how to combine the filters on the query.","enum":["and","or","AND","OR"],"type":"string"},"filters":{"description":"Configure the Filters to apply to the query.","items":{"properties":{"key":{"type":"string"},"operation":{"enum":["includes","not_includes","starts_with","regex","exists","is_null","in","not_in","eq","neq","gt","gte","lt","lte","=","!=","\u003e","\u003e=","\u003c","\u003c=","INCLUDES","DOES_NOT_INCLUDE","MATCH_REGEX","EXISTS","DOES_NOT_EXIST","IN","NOT_IN","STARTS_WITH"],"type":"string"},"type":{"enum":["string","number","boolean"],"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","operation","type"],"type":"object"},"type":"array"},"groupBys":{"description":"Define how to group the results of the query.","items":{"properties":{"type":{"enum":["string","number","boolean"],"type":"string"},"value":{"type":"string"}},"required":["type","value"],"type":"object"},"type":"array"},"havings":{"description":"Configure the Having clauses that filter on calculations in the query result.","items":{"properties":{"key":{"type":"string"},"operation":{"enum":["eq","neq","gt","gte","lt","lte"],"type":"string"},"value":{"type":"number"}},"required":["key","operation","value"],"type":"object"},"type":"array"},"limit":{"description":"Set a limit on the number of results / records returned by the query","maximum":2000,"minimum":0,"type":"integer"},"needle":{"description":"Define an expression to search using full-text search.","properties":{"isRegex":{"type":"boolean"},"matchCase":{"type":"boolean"},"value":{"allOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"maxLength":1000,"type":"string"}]}},"required":["value"],"type":"object"},"orderBy":{"description":"Configure the order of the results returned by the query.","properties":{"order":{"description":"Set the order of the results","enum":["asc","desc"],"type":"string"},"value":{"description":"Configure which Calculation to order the results by.","type":"string"}},"required":["value"],"type":"object"}},"type":"object"},"updated":{"type":"string"},"userId":{"example":"JY2UKXLO60AEV94R","type":"string"},"workspaceId":{"description":"ID of your workspace","example":"my-workspace","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}},"required":["id","workspaceId","environmentId","userId","description","name","generated","parameters","created","updated"],"type":"object"},"workers-observability_query_results":{"properties":{"calculations":{"items":{"properties":{"aggregates":{"items":{"properties":{"count":{"type":"number"},"groups":{"items":{"properties":{"key":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","value"],"type":"object"},"type":"array"},"interval":{"type":"number"},"sampleInterval":{"type":"number"},"value":{"type":"number"}},"required":["value","count","interval","sampleInterval"],"type":"object"},"type":"array"},"alias":{"type":"string"},"calculation":{"type":"string"},"series":{"items":{"properties":{"data":{"items":{"properties":{"count":{"type":"number"},"firstSeen":{"type":"string"},"groups":{"items":{"properties":{"key":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","value"],"type":"object"},"type":"array"},"interval":{"type":"number"},"lastSeen":{"type":"string"},"sampleInterval":{"type":"number"},"value":{"type":"number"}},"required":["value","count","interval","sampleInterval","firstSeen","lastSeen"],"type":"object"},"type":"array"},"time":{"type":"string"}},"required":["time","data"],"type":"object"},"type":"array"}},"required":["calculation","aggregates","series"],"type":"object"},"type":"array"},"compare":{"items":{"properties":{"aggregates":{"items":{"properties":{"count":{"type":"number"},"groups":{"items":{"properties":{"key":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","value"],"type":"object"},"type":"array"},"interval":{"type":"number"},"sampleInterval":{"type":"number"},"value":{"type":"number"}},"required":["value","count","interval","sampleInterval"],"type":"object"},"type":"array"},"alias":{"type":"string"},"calculation":{"type":"string"},"series":{"items":{"properties":{"data":{"items":{"properties":{"count":{"type":"number"},"firstSeen":{"type":"string"},"groups":{"items":{"properties":{"key":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","value"],"type":"object"},"type":"array"},"interval":{"type":"number"},"lastSeen":{"type":"string"},"sampleInterval":{"type":"number"},"value":{"type":"number"}},"required":["value","count","interval","sampleInterval","firstSeen","lastSeen"],"type":"object"},"type":"array"},"time":{"type":"string"}},"required":["time","data"],"type":"object"},"type":"array"}},"required":["calculation","aggregates","series"],"type":"object"},"type":"array"},"events":{"properties":{"count":{"type":"number"},"events":{"items":{"$ref":"#/components/schemas/workers-observability_telemetry_event"},"type":"array"},"fields":{"items":{"properties":{"key":{"type":"string"},"type":{"type":"string"}},"required":["key","type"],"type":"object"},"type":"array"},"series":{"items":{"properties":{"data":{"items":{"properties":{"aggregates":{"properties":{"_count":{"deprecated":true,"exclusiveMinimum":true,"minimum":0,"type":"integer"},"_firstSeen":{"deprecated":true,"type":"string"},"_interval":{"deprecated":true,"exclusiveMinimum":true,"minimum":0,"type":"integer"},"_lastSeen":{"deprecated":true,"type":"string"},"bin":{"deprecated":true,"type":"object"}},"required":["_count","_interval","_firstSeen","_lastSeen"],"type":"object"},"count":{"type":"number"},"errors":{"type":"number"},"groups":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"description":"Groups in the query results.","type":"object"},"interval":{"type":"number"},"sampleInterval":{"type":"number"}},"required":["aggregates","count","interval","sampleInterval"],"type":"object"},"type":"array"},"time":{"type":"string"}},"required":["time","data"],"type":"object"},"type":"array"}},"type":"object"},"invocations":{"additionalProperties":{"items":{"$ref":"#/components/schemas/workers-observability_telemetry_event"},"type":"array"},"type":"object"},"patterns":{"items":{"properties":{"count":{"type":"number"},"pattern":{"type":"string"},"series":{"items":{"properties":{"data":{"properties":{"count":{"type":"number"},"groups":{"items":{"properties":{"key":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","value"],"type":"object"},"type":"array"},"interval":{"type":"number"},"sampleInterval":{"type":"number"},"value":{"type":"number"}},"required":["value","count","interval","sampleInterval"],"type":"object"},"time":{"type":"string"}},"required":["time","data"],"type":"object"},"type":"array"},"service":{"type":"string"}},"required":["service","pattern","count","series"],"type":"object"},"type":"array"},"run":{"$ref":"#/components/schemas/workers-observability_query_run"},"statistics":{"$ref":"#/components/schemas/workers-observability_performance_information"},"traces":{"items":{"properties":{"errors":{"items":{"type":"string"},"type":"array"},"rootSpanName":{"type":"string"},"rootTransactionName":{"type":"string"},"service":{"items":{"type":"string"},"type":"array"},"spans":{"type":"number"},"traceDurationMs":{"type":"number"},"traceEndMs":{"type":"number"},"traceId":{"type":"string"},"traceStartMs":{"type":"number"}},"required":["traceId","spans","service","traceStartMs","traceEndMs","traceDurationMs","rootSpanName","rootTransactionName"],"type":"object"},"type":"array"}},"required":["run","statistics"],"type":"object"},"workers-observability_query_run":{"description":"A Workers Observability Query Object","properties":{"accountId":{"type":"string"},"created":{"type":"string"},"dry":{"type":"boolean"},"environmentId":{"deprecated":true,"type":"string"},"granularity":{"type":"number"},"id":{"type":"string"},"query":{"$ref":"#/components/schemas/workers-observability_query"},"statistics":{"properties":{"abr_level":{"description":"The level of Adaptive Bit Rate (ABR) sampling used for the query. If empty the ABR level is 1","type":"number"},"bytes_read":{"description":"Number of uncompressed bytes read from the table.","type":"number"},"elapsed":{"description":"Time in seconds for the query to run.","type":"number"},"rows_read":{"description":"Number of rows scanned from the table.","type":"number"}},"required":["elapsed","rows_read","bytes_read"],"type":"object"},"status":{"enum":["STARTED","COMPLETED"],"type":"string"},"timeframe":{"description":"Time range for the query execution","properties":{"from":{"description":"Start timestamp for the query timeframe (Unix timestamp in milliseconds)","type":"number"},"to":{"description":"End timestamp for the query timeframe (Unix timestamp in milliseconds)","type":"number"}},"required":["to","from"],"type":"object"},"updated":{"type":"string"},"userId":{"type":"string"},"workspaceId":{"deprecated":true,"type":"string"}},"required":["id","query","workspaceId","environmentId","accountId","timeframe","userId","status","granularity","dry"],"type":"object"},"workers-observability_telemetry_event":{"additionalProperties":false,"description":"The data structure of a telemetry event","properties":{"$containers":{"description":"Cloudflare Containers event information enriches your logs so you can easily identify and debug issues.","type":"object"},"$metadata":{"properties":{"account":{"type":"string"},"cloudService":{"type":"string"},"coldStart":{"exclusiveMinimum":true,"minimum":0,"type":"integer"},"cost":{"exclusiveMinimum":true,"minimum":0,"type":"integer"},"duration":{"exclusiveMinimum":true,"minimum":0,"type":"integer"},"endTime":{"minimum":0,"type":"integer"},"error":{"type":"string"},"errorTemplate":{"type":"string"},"fingerprint":{"type":"string"},"id":{"type":"string"},"level":{"type":"string"},"message":{"type":"string"},"messageTemplate":{"type":"string"},"metricName":{"type":"string"},"origin":{"type":"string"},"parentSpanId":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"requestId":{"type":"string"},"service":{"type":"string"},"spanId":{"type":"string"},"spanName":{"type":"string"},"stackId":{"type":"string"},"startTime":{"minimum":0,"type":"integer"},"statusCode":{"exclusiveMinimum":true,"minimum":0,"type":"integer"},"traceDuration":{"exclusiveMinimum":true,"minimum":0,"type":"integer"},"traceId":{"type":"string"},"transactionName":{"type":"string"},"trigger":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"required":["id"],"type":"object"},"$workers":{"anyOf":[{"properties":{"durableObjectId":{"type":"string"},"entrypoint":{"type":"string"},"event":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"additionalProperties":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array"},{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"object"}]},"type":"object"}]},"type":"object"},"eventType":{"enum":["fetch","scheduled","alarm","cron","queue","email","tail","rpc","websocket","unknown"],"type":"string"},"executionModel":{"enum":["durableObject","stateless"],"type":"string"},"outcome":{"type":"string"},"requestId":{"type":"string"},"scriptName":{"type":"string"},"scriptVersion":{"properties":{"id":{"type":"string"},"message":{"type":"string"},"tag":{"type":"string"}},"type":"object"},"truncated":{"type":"boolean"}},"required":["scriptName","eventType","requestId"],"type":"object"},{"properties":{"cpuTimeMs":{"type":"number"},"diagnosticsChannelEvents":{"items":{"properties":{"channel":{"type":"string"},"message":{"type":"string"},"timestamp":{"type":"number"}},"required":["timestamp","channel","message"],"type":"object"},"type":"array"},"dispatchNamespace":{"type":"string"},"durableObjectId":{"type":"string"},"entrypoint":{"type":"string"},"event":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"object"},"eventType":{"enum":["fetch","scheduled","alarm","cron","queue","email","tail","rpc","websocket","unknown"],"type":"string"},"executionModel":{"enum":["durableObject","stateless"],"type":"string"},"outcome":{"type":"string"},"requestId":{"type":"string"},"scriptName":{"type":"string"},"scriptVersion":{"properties":{"id":{"type":"string"},"message":{"type":"string"},"tag":{"type":"string"}},"type":"object"},"truncated":{"type":"boolean"},"wallTimeMs":{"type":"number"}},"required":["scriptName","outcome","eventType","wallTimeMs","cpuTimeMs","requestId"],"type":"object"}],"description":"Cloudflare Workers event information enriches your logs so you can easily identify and debug issues."},"dataset":{"type":"string"},"source":{"anyOf":[{"type":"string"},{"type":"object"}]},"timestamp":{"minimum":0,"type":"integer"}},"required":["dataset","timestamp","source","$metadata"],"type":"object"},"workers_ErrorAuth":{"properties":{"code":{"description":"Code indicating that the user is not authorized to perform this action.","enum":[10023],"type":"integer"},"message":{"description":"Message explaining that the user lacks access to this feature.","type":"string"}},"required":["code","message"],"type":"object"},"workers_ErrorInternalServer":{"properties":{"code":{"description":"Code indicating that an unknown internal server error has occurred.","enum":[10002],"type":"integer"},"message":{"description":"Message explaining that an unknown error occurred and providing guidance for reporting the issue.","type":"string"}},"required":["code","message"],"type":"object"},"workers_ErrorMissingParam":{"properties":{"code":{"description":"Code indicating that a required URL parameter is missing.","enum":[10003],"type":"integer"},"message":{"description":"Message explaining which required parameter is missing and suggesting to check the URL.","type":"string"}},"required":["code","message"],"type":"object"},"workers_ErrorWorkerInvalid":{"properties":{"code":{"description":"Code indicating that the Worker request contains invalid data.","enum":[10021],"type":"integer"},"message":{"description":"Message explaining why the Worker request is invalid, such as malformed JSON.","type":"string"}},"required":["code","message"],"type":"object"},"workers_ErrorWorkerLimit":{"properties":{"code":{"description":"Code indicating that the account has exceeded the maximum number of Workers allowed.","enum":[10037],"type":"integer"},"message":{"description":"Message explaining that the Worker limit has been exceeded and providing guidance.","type":"string"}},"required":["code","message"],"type":"object"},"workers_ErrorWorkerNameConflict":{"properties":{"code":{"description":"Code indicating that a Worker with this name already exists.","enum":[10040],"type":"integer"},"message":{"description":"Message explaining that the Worker name is already in use and suggesting to choose a different name.","type":"string"}},"required":["code","message"],"type":"object"},"workers_ErrorWorkerNameInvalid":{"properties":{"code":{"description":"Code indicating that the Worker name is invalid.","enum":[10016],"type":"integer"},"message":{"description":"Message explaining why the Worker name is invalid.","type":"string"}},"required":["code","message"],"type":"object"},"workers_ErrorWorkerNamePreviewLengthLimit":{"properties":{"code":{"description":"Code indicating that the Worker name is too long to be used with previews enabled.","enum":[100315],"type":"integer"},"message":{"description":"Message explaining that Worker names with previews enabled cannot exceed 54 characters.","type":"string"}},"required":["code","message"],"type":"object"},"workers_ErrorWorkerNameSubdomainLengthLimit":{"properties":{"code":{"description":"Code indicating that the Worker name is too long to be used as a subdomain.","enum":[100132],"type":"integer"},"message":{"description":"Message explaining that the Worker name exceeds the 63 character limit for subdomains.","type":"string"}},"required":["code","message"],"type":"object"},"workers_ErrorWorkerNotFound":{"properties":{"code":{"description":"Code indicating that the Worker does not exist.","enum":[10007],"type":"integer"},"message":{"description":"Message explaining that the Worker was not found.","type":"string"}},"required":["code","message"],"type":"object"},"workers_ErrorWorkerObservabilitySamplingRateInvalid":{"properties":{"code":{"description":"Code indicating that an observability sampling rate is invalid.","enum":[100308],"type":"integer"},"message":{"description":"Message explaining that sampling rates must be between 0 and 1 inclusive.","type":"string"}},"required":["code","message"],"type":"object"},"workers_ErrorWorkerTagInvalid":{"properties":{"code":{"description":"Code indicating that the Worker has a tag containing invalid characters.","enum":[100134],"type":"integer"},"message":{"description":"Message explaining that tags cannot contain certain characters like comma or ampersand.","type":"string"}},"required":["code","message"],"type":"object"},"workers_ErrorWorkerTagLengthLimit":{"properties":{"code":{"description":"Code indicating that the Worker has a tag that exceeds the maximum tag length.","enum":[100102],"type":"integer"},"message":{"description":"Message explaining why the tag is too long, including the maximum tag length.","type":"string"}},"required":["code","message"],"type":"object"},"workers_ErrorWorkerTagLimit":{"properties":{"code":{"description":"Code indicating that the Worker has exceeded the maximum number of tags allowed.","enum":[100103],"type":"integer"},"message":{"description":"Message explaining that the tag limit has been exceeded and suggesting to remove a tag.","type":"string"}},"required":["code","message"],"type":"object"},"workers_Version":{"properties":{"annotations":{"description":"Metadata about the version.","properties":{"workers/message":{"description":"Human-readable message about the version.","example":"Fixed bug.","maxLength":100,"type":"string"},"workers/tag":{"description":"User-provided identifier for the version.","example":"v1.0.1","maxLength":25,"type":"string"},"workers/triggered_by":{"description":"Operation that triggered the creation of the version.","example":"upload","readOnly":true,"type":"string"}},"type":"object"},"assets":{"description":"Configuration for assets within a Worker.\n\n[`_headers`](https://developers.cloudflare.com/workers/static-assets/headers/#custom-headers) and\n[`_redirects`](https://developers.cloudflare.com/workers/static-assets/redirects/) files should be\nincluded as modules named `_headers` and `_redirects` with content type `text/plain`.\n","properties":{"config":{"description":"Configuration for assets within a Worker.","properties":{"html_handling":{"default":"auto-trailing-slash","description":"Determines the redirects and rewrites of requests for HTML content.","enum":["auto-trailing-slash","force-trailing-slash","drop-trailing-slash","none"],"example":"auto-trailing-slash","type":"string"},"not_found_handling":{"default":"none","description":"Determines the response when a request does not match a static asset, and there is no Worker script.","enum":["none","404-page","single-page-application"],"example":"404-page","type":"string"},"run_worker_first":{"default":false,"oneOf":[{"description":"Contains a list path rules to control routing to either the Worker or assets. Glob (*) and negative (!) rules are supported. Rules must start with either '/' or '!/'. At least one non-negative rule must be provided, and negative rules have higher precedence than non-negative rules.","example":"[\"/api/*\", \"/oauth/callback\", \"!/api/assets/*\"]","items":{"type":"string"},"type":"array"},{"description":"Enables routing to always invoke the Worker script ahead of all requests. When true, this is equivalent to `[\"/*\"]` in the string array version of this field.","example":true,"type":"boolean"}]}},"type":"object"},"jwt":{"description":"Token provided upon successful upload of all files from a registered manifest.","type":"string","x-sensitive":true}},"type":"object"},"bindings":{"$ref":"#/components/schemas/workers_bindings"},"compatibility_date":{"$ref":"#/components/schemas/workers_compatibility_date"},"compatibility_flags":{"$ref":"#/components/schemas/workers_compatibility_flags"},"created_on":{"description":"When the version was created.","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"Version identifier.","format":"uuid","readOnly":true,"type":"string"},"limits":{"description":"Resource limits enforced at runtime.","properties":{"cpu_ms":{"description":"CPU time limit in milliseconds.","example":50,"type":"integer"}},"required":["cpu_ms"],"type":"object","x-stainless-terraform-configurability":"computed_optional"},"main_module":{"description":"The name of the main module in the `modules` array (e.g. the name of the module that exports a `fetch` handler).","example":"index.js","type":"string"},"migrations":{"description":"Migrations for Durable Objects associated with the version. Migrations are applied when the version is deployed.","oneOf":[{"$ref":"#/components/schemas/workers_single_step_migrations"},{"$ref":"#/components/schemas/workers_multiple_step_migrations"}]},"modules":{"description":"Code, sourcemaps, and other content used at runtime.\n\nThis includes [`_headers`](https://developers.cloudflare.com/workers/static-assets/headers/#custom-headers) and\n[`_redirects`](https://developers.cloudflare.com/workers/static-assets/redirects/) files used to configure \n[Static Assets](https://developers.cloudflare.com/workers/static-assets/). `_headers` and `_redirects` files should be \nincluded as modules named `_headers` and `_redirects` with content type `text/plain`.\n","items":{"properties":{"content_base64":{"description":"The base64-encoded module content.","example":"ZXhwb3J0IGRlZmF1bHQgewogIGFzeW5jIGZldGNoKHJlcXVlc3QsIGVudiwgY3R4KSB7CiAgICByZXR1cm4gbmV3IFJlc3BvbnNlKCdIZWxsbyBXb3JsZCEnKQogIH0KfQ==","format":"byte","type":"string"},"content_type":{"description":"The content type of the module.","example":"application/javascript+module","type":"string"},"name":{"description":"The name of the module.","example":"index.js","type":"string"}},"required":["name","content_type","content_base64"],"type":"object"},"type":"array","x-stainless-collection-type":"set"},"number":{"description":"The integer version number, starting from one.","readOnly":true,"type":"integer"},"placement":{"description":"Placement settings for the version.","properties":{"mode":{"description":"Placement mode for the version.","enum":["smart"],"example":"smart","type":"string"}},"type":"object"},"source":{"description":"The client used to create the version.","example":"wrangler","readOnly":true,"type":"string"},"usage_model":{"default":"standard","deprecated":true,"description":"Usage model for the version.","enum":["standard","bundled","unbound"],"example":"standard","type":"string"}},"required":["id","number","created_on"],"type":"object"},"workers_Worker":{"properties":{"created_on":{"description":"When the Worker was created.","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"Immutable ID of the Worker.","example":"e8f70fdbc8b1fb0b8ddb1af166186758","readOnly":true,"type":"string"},"logpush":{"default":false,"description":"Whether logpush is enabled for the Worker.","type":"boolean"},"name":{"description":"Name of the Worker.","example":"my-worker","pattern":"^[a-z0-9_][a-z0-9-_]*$","type":"string"},"observability":{"description":"Observability settings for the Worker.","properties":{"enabled":{"default":false,"description":"Whether observability is enabled for the Worker.","type":"boolean"},"head_sampling_rate":{"default":1,"description":"The sampling rate for observability. From 0 to 1 (1 = 100%, 0.1 = 10%).","example":1,"type":"number"},"logs":{"description":"Log settings for the Worker.","properties":{"enabled":{"default":false,"description":"Whether logs are enabled for the Worker.","type":"boolean"},"head_sampling_rate":{"default":1,"description":"The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%).","example":1,"type":"number"},"invocation_logs":{"default":true,"description":"Whether [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs) are enabled for the Worker.","type":"boolean"}},"type":"object"}},"type":"object"},"references":{"description":"Other resources that reference the Worker and depend on it existing.","properties":{"dispatch_namespace_outbounds":{"description":"Other Workers that reference the Worker as an outbound for a dispatch namespace.","items":{"properties":{"namespace_id":{"description":"ID of the dispatch namespace.","example":"e8f70fdbc8b1fb0b8ddb1af166186758","type":"string"},"namespace_name":{"description":"Name of the dispatch namespace.","example":"my-dispatch-namespace","type":"string"},"worker_id":{"description":"ID of the Worker using the dispatch namespace.","example":"e8f70fdbc8b1fb0b8ddb1af166186758","type":"string"},"worker_name":{"description":"Name of the Worker using the dispatch namespace.","example":"my-worker","type":"string"}},"required":["worker_id","worker_name","namespace_id","namespace_name"],"type":"object"},"type":"array"},"domains":{"description":"Custom domains connected to the Worker.","items":{"properties":{"certificate_id":{"description":"ID of the TLS certificate issued for the custom domain.","type":"string"},"hostname":{"description":"Full hostname of the custom domain, including the zone name.","example":"my-worker.example.com","type":"string"},"id":{"description":"ID of the custom domain.","example":"e8f70fdbc8b1fb0b8ddb1af166186758","type":"string"},"zone_id":{"description":"ID of the zone.","example":"e8f70fdbc8b1fb0b8ddb1af166186758","type":"string"},"zone_name":{"description":"Name of the zone.","example":"example.com","type":"string"}},"required":["id","hostname","zone_id","zone_name","certificate_id"],"type":"object"},"type":"array"},"durable_objects":{"description":"Other Workers that reference Durable Object classes implemented by the Worker.","items":{"properties":{"namespace_id":{"description":"ID of the Durable Object namespace being used.","example":"e8f70fdbc8b1fb0b8ddb1af166186758","type":"string"},"namespace_name":{"description":"Name of the Durable Object namespace being used.","example":"my-durable-object-namespace","type":"string"},"worker_id":{"description":"ID of the Worker using the Durable Object implementation.","example":"e8f70fdbc8b1fb0b8ddb1af166186758","type":"string"},"worker_name":{"description":"Name of the Worker using the Durable Object implementation.","example":"my-worker","type":"string"}},"required":["worker_id","worker_name","namespace_id","namespace_name"],"type":"object"},"type":"array"},"queues":{"description":"Queues that send messages to the Worker.","items":{"properties":{"queue_consumer_id":{"description":"ID of the queue consumer configuration.","example":"e8f70fdbc8b1fb0b8ddb1af166186758","type":"string"},"queue_id":{"description":"ID of the queue.","example":"e8f70fdbc8b1fb0b8ddb1af166186758","type":"string"},"queue_name":{"description":"Name of the queue.","example":"my-queue","type":"string"}},"required":["queue_id","queue_name","queue_consumer_id"],"type":"object"},"type":"array"},"workers":{"description":"Other Workers that reference the Worker using [service bindings](https://developers.cloudflare.com/workers/runtime-apis/bindings/service-bindings/).","items":{"properties":{"id":{"description":"ID of the referencing Worker.","example":"e8f70fdbc8b1fb0b8ddb1af166186758","type":"string"},"name":{"description":"Name of the referencing Worker.","example":"my-worker","type":"string"}},"required":["id","name"],"type":"object"},"type":"array"}},"readOnly":true,"required":["workers","domains","dispatch_namespace_outbounds","durable_objects","queues"],"type":"object"},"subdomain":{"description":"Subdomain settings for the Worker.","properties":{"enabled":{"default":false,"description":"Whether the *.workers.dev subdomain is enabled for the Worker.","type":"boolean"},"previews_enabled":{"description":"Whether [preview URLs](https://developers.cloudflare.com/workers/configuration/previews/) are enabled for the Worker.","type":"boolean","x-stainless-terraform-configurability":"computed_optional"}},"type":"object"},"tags":{"default":[],"description":"Tags associated with the Worker.","example":["my-team","my-public-api"],"items":{"maxLength":1024,"pattern":"^[^,\u0026]*$","type":"string"},"maxItems":8,"type":"array","x-stainless-collection-type":"set"},"tail_consumers":{"default":[],"description":"Other Workers that should consume logs from the Worker.","items":{"properties":{"name":{"description":"Name of the consumer Worker.","example":"my-tail-consumer","type":"string"}},"required":["name"],"type":"object"},"type":"array","x-stainless-collection-type":"set"},"updated_on":{"description":"When the Worker was most recently updated.","format":"date-time","readOnly":true,"type":"string"}},"required":["id","name","tags","subdomain","observability","logpush","tail_consumers","created_on","updated_on","references"],"type":"object"},"workers_account-settings":{"properties":{"default_usage_model":{"type":"string","x-auditable":true},"green_compute":{"type":"boolean","x-auditable":true}},"type":"object"},"workers_account_identifier":{"description":"Identifer of the account.","example":"9a7806061c88ada191ed06f989cc3dac","type":"string","x-auditable":true},"workers_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"workers_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/workers_messages"},"messages":{"$ref":"#/components/schemas/workers_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"workers_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/workers_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/workers_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"workers_api-response-null-result":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"enum":[null],"nullable":true,"type":"object"}},"type":"object"}]},"workers_api-response-single":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"}],"type":"object"},"workers_assets":{"description":"Configuration for assets within a Worker.","properties":{"config":{"description":"Configuration for assets within a Worker.","properties":{"_headers":{"description":"The contents of a _headers file (used to attach custom headers on asset responses).","example":"/dashboard/*\nX-Frame-Options: DENY\n\n/static/*\nAccess-Control-Allow-Origin: *","type":"string"},"_redirects":{"description":"The contents of a _redirects file (used to apply redirects or proxy paths ahead of asset serving).","example":"/foo /bar 301\n/news/* /blog/:splat","type":"string"},"html_handling":{"description":"Determines the redirects and rewrites of requests for HTML content.","enum":["auto-trailing-slash","force-trailing-slash","drop-trailing-slash","none"],"example":"auto-trailing-slash","type":"string"},"not_found_handling":{"description":"Determines the response when a request does not match a static asset, and there is no Worker script.","enum":["none","404-page","single-page-application"],"example":"404-page","type":"string"},"run_worker_first":{"oneOf":[{"description":"Contains a list path rules to control routing to either the Worker or assets. Glob (*) and negative (!) rules are supported. Rules must start with either '/' or '!/'. At least one non-negative rule must be provided, and negative rules have higher precedence than non-negative rules.","example":"[\"/api/*\", \"/oauth/callback\", \"!/api/assets/*\"]","items":{"type":"string"},"type":"array"},{"description":"Enables routing to always invoke the Worker script ahead of all requests. When true, this is equivalent to `[\"/*\"]` in the string array version of this field.","example":true,"type":"boolean"}]},"serve_directly":{"deprecated":true,"description":"When true and the incoming request matches an asset, that will be served instead of invoking the Worker script. When false, requests will always invoke the Worker script.","example":true,"type":"boolean"}},"type":"object"},"jwt":{"description":"Token provided upon successful upload of all files from a registered manifest.","type":"string","x-sensitive":true}},"type":"object"},"workers_binding_item":{"description":"A binding to allow the Worker to communicate with resources.","discriminator":{"mapping":{"ai":"#/components/schemas/workers_binding_kind_ai","analytics_engine":"#/components/schemas/workers_binding_kind_analytics_engine","assets":"#/components/schemas/workers_binding_kind_assets","browser":"#/components/schemas/workers_binding_kind_browser","d1":"#/components/schemas/workers_binding_kind_d1","data_blob":"#/components/schemas/workers_binding_kind_data_blob","dispatch_namespace":"#/components/schemas/workers_binding_kind_dispatch_namespace","durable_object_namespace":"#/components/schemas/workers_binding_kind_durable_object_namespace","hyperdrive":"#/components/schemas/workers_binding_kind_hyperdrive","images":"#/components/schemas/workers_binding_kind_images","inherit":"#/components/schemas/workers_binding_kind_inherit","json":"#/components/schemas/workers_binding_kind_json","kv_namespace":"#/components/schemas/workers_binding_kind_kv_namespace","mtls_certificate":"#/components/schemas/workers_binding_kind_mtls_certificate","pipelines":"#/components/schemas/workers_binding_kind_pipelines","plain_text":"#/components/schemas/workers_binding_kind_plain_text","queue":"#/components/schemas/workers_binding_kind_queue","r2_bucket":"#/components/schemas/workers_binding_kind_r2_bucket","secret_key":"#/components/schemas/workers_binding_kind_secret_key","secret_text":"#/components/schemas/workers_binding_kind_secret_text","secrets_store_secret":"#/components/schemas/workers_binding_kind_secrets_store_secret","send_email":"#/components/schemas/workers_binding_kind_send_email","service":"#/components/schemas/workers_binding_kind_service","text_blob":"#/components/schemas/workers_binding_kind_text_blob","vectorize":"#/components/schemas/workers_binding_kind_vectorize","version_metadata":"#/components/schemas/workers_binding_kind_version_metadata","wasm_module":"#/components/schemas/workers_binding_kind_wasm_module","workflow":"#/components/schemas/workers_binding_kind_workflow"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/workers_binding_kind_ai"},{"$ref":"#/components/schemas/workers_binding_kind_analytics_engine"},{"$ref":"#/components/schemas/workers_binding_kind_assets"},{"$ref":"#/components/schemas/workers_binding_kind_browser"},{"$ref":"#/components/schemas/workers_binding_kind_d1"},{"$ref":"#/components/schemas/workers_binding_kind_data_blob"},{"$ref":"#/components/schemas/workers_binding_kind_dispatch_namespace"},{"$ref":"#/components/schemas/workers_binding_kind_durable_object_namespace"},{"$ref":"#/components/schemas/workers_binding_kind_hyperdrive"},{"$ref":"#/components/schemas/workers_binding_kind_inherit"},{"$ref":"#/components/schemas/workers_binding_kind_images"},{"$ref":"#/components/schemas/workers_binding_kind_json"},{"$ref":"#/components/schemas/workers_binding_kind_kv_namespace"},{"$ref":"#/components/schemas/workers_binding_kind_mtls_certificate"},{"$ref":"#/components/schemas/workers_binding_kind_plain_text"},{"$ref":"#/components/schemas/workers_binding_kind_pipelines"},{"$ref":"#/components/schemas/workers_binding_kind_queue"},{"$ref":"#/components/schemas/workers_binding_kind_r2_bucket"},{"$ref":"#/components/schemas/workers_binding_kind_secret_text"},{"$ref":"#/components/schemas/workers_binding_kind_send_email"},{"$ref":"#/components/schemas/workers_binding_kind_service"},{"$ref":"#/components/schemas/workers_binding_kind_text_blob"},{"$ref":"#/components/schemas/workers_binding_kind_vectorize"},{"$ref":"#/components/schemas/workers_binding_kind_version_metadata"},{"$ref":"#/components/schemas/workers_binding_kind_secrets_store_secret"},{"$ref":"#/components/schemas/workers_binding_kind_secret_key"},{"$ref":"#/components/schemas/workers_binding_kind_workflow"},{"$ref":"#/components/schemas/workers_binding_kind_wasm_module"}],"type":"object"},"workers_binding_kind_ai":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["ai"],"type":"string","x-auditable":true}},"required":["name","type"],"type":"object"},"workers_binding_kind_analytics_engine":{"properties":{"dataset":{"description":"The name of the dataset to bind to.","example":"some_dataset","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["analytics_engine"],"type":"string","x-auditable":true}},"required":["name","type","dataset"],"type":"object"},"workers_binding_kind_assets":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["assets"],"type":"string","x-auditable":true}},"required":["name","type"],"type":"object"},"workers_binding_kind_browser":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["browser"],"type":"string","x-auditable":true}},"required":["name","type"],"type":"object"},"workers_binding_kind_d1":{"properties":{"id":{"description":"Identifier of the D1 database to bind to.","example":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["d1"],"type":"string","x-auditable":true}},"required":["name","type","id"],"type":"object"},"workers_binding_kind_data_blob":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"part":{"description":"The name of the file containing the data content. Only accepted for `service worker syntax` Workers.","example":"my-module.bin","type":"string","x-auditable":true},"type":{"deprecated":true,"description":"The kind of resource that the binding provides.","enum":["data_blob"],"type":"string","x-auditable":true}},"required":["name","type","part"],"type":"object"},"workers_binding_kind_dispatch_namespace":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"namespace":{"description":"The name of the dispatch namespace.","example":"my-namespace","type":"string","x-auditable":true},"outbound":{"description":"Outbound worker.","properties":{"params":{"description":"Pass information from the Dispatch Worker to the Outbound Worker through the parameters.","items":{"example":"url","type":"string","x-auditable":true},"type":"array"},"worker":{"description":"Outbound worker.","properties":{"environment":{"description":"Environment of the outbound worker.","type":"string","x-auditable":true},"service":{"description":"Name of the outbound worker.","type":"string","x-auditable":true}},"type":"object"}},"type":"object"},"type":{"description":"The kind of resource that the binding provides.","enum":["dispatch_namespace"],"type":"string","x-auditable":true}},"required":["name","type","namespace"],"type":"object"},"workers_binding_kind_durable_object_namespace":{"properties":{"class_name":{"description":"The exported class name of the Durable Object.","example":"MyDurableObject","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"environment":{"description":"The environment of the script_name to bind to.","example":"production","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/workers_binding_name"},"namespace_id":{"allOf":[{"$ref":"#/components/schemas/workers_namespace_identifier"},{"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"}]},"script_name":{"description":"The script where the Durable Object is defined, if it is external to this Worker.","example":"my-other-worker","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"type":{"description":"The kind of resource that the binding provides.","enum":["durable_object_namespace"],"type":"string","x-auditable":true}},"required":["name","type"],"type":"object"},"workers_binding_kind_hyperdrive":{"properties":{"id":{"description":"Identifier of the Hyperdrive connection to bind to.","example":"57b7076f58be42419276f058a8968187","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["hyperdrive"],"type":"string","x-auditable":true}},"required":["name","type","id"],"type":"object"},"workers_binding_kind_images":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["images"],"type":"string","x-auditable":true}},"required":["name","type"],"type":"object"},"workers_binding_kind_inherit":{"properties":{"name":{"description":"The name of the inherited binding.","example":"MY_BINDING","type":"string","x-auditable":true},"old_name":{"description":"The old name of the inherited binding. If set, the binding will be renamed from `old_name` to `name` in the new version. If not set, the binding will keep the same name between versions.","example":"MY_OLD_BINDING","type":"string","x-auditable":true},"type":{"description":"The kind of resource that the binding provides.","enum":["inherit"],"type":"string","x-auditable":true},"version_id":{"default":"latest","description":"Identifier for the version to inherit the binding from, which can be the version ID or the literal \"latest\" to inherit from the latest version. Defaults to inheriting the binding from the latest version.","example":"8969331f-7192-434c-9938-6aea24ed58bf","type":"string","x-auditable":true}},"required":["name","type"],"type":"object"},"workers_binding_kind_json":{"properties":{"json":{"description":"JSON data to use.","example":"{ \"message\": \"Hello, world!\" }","type":"string"},"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["json"],"type":"string","x-auditable":true}},"required":["name","type","json"],"type":"object"},"workers_binding_kind_kv_namespace":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"namespace_id":{"$ref":"#/components/schemas/workers_namespace_identifier"},"type":{"description":"The kind of resource that the binding provides.","enum":["kv_namespace"],"type":"string","x-auditable":true}},"required":["name","type","namespace_id"],"type":"object"},"workers_binding_kind_mtls_certificate":{"properties":{"certificate_id":{"description":"Identifier of the certificate to bind to.","example":"efwu2n6s-q69d-2kr9-184j-4913e8h391k6","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["mtls_certificate"],"type":"string","x-auditable":true}},"required":["name","type","certificate_id"],"type":"object"},"workers_binding_kind_pipelines":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"pipeline":{"description":"Name of the Pipeline to bind to.","example":"my-pipeline","type":"string","x-auditable":true},"type":{"description":"The kind of resource that the binding provides.","enum":["pipelines"],"type":"string","x-auditable":true}},"required":["name","type","pipeline"],"type":"object"},"workers_binding_kind_plain_text":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"text":{"description":"The text value to use.","example":"Hello, world!","type":"string","x-auditable":true},"type":{"description":"The kind of resource that the binding provides.","enum":["plain_text"],"type":"string","x-auditable":true}},"required":["name","type","text"],"type":"object"},"workers_binding_kind_queue":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"queue_name":{"description":"Name of the Queue to bind to.","example":"my-queue","type":"string"},"type":{"description":"The kind of resource that the binding provides.","enum":["queue"],"type":"string","x-auditable":true}},"required":["name","type","queue_name"],"type":"object"},"workers_binding_kind_r2_bucket":{"properties":{"bucket_name":{"description":"R2 bucket to bind to.","example":"my-r2-bucket","type":"string","x-auditable":true},"jurisdiction":{"description":"The [jurisdiction](https://developers.cloudflare.com/r2/reference/data-location/#jurisdictional-restrictions) of the R2 bucket.","enum":["eu","fedramp"],"example":"eu","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["r2_bucket"],"type":"string","x-auditable":true}},"required":["name","type","bucket_name"],"type":"object"},"workers_binding_kind_secret_key":{"properties":{"algorithm":{"description":"Algorithm-specific key parameters. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).","type":"object","x-auditable":true},"format":{"description":"Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).","enum":["raw","pkcs8","spki","jwk"],"example":"raw","type":"string","x-auditable":true},"key_base64":{"description":"Base64-encoded key data. Required if `format` is \"raw\", \"pkcs8\", or \"spki\".","type":"string","writeOnly":true,"x-sensitive":true},"key_jwk":{"description":"Key data in [JSON Web Key](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#json_web_key) format. Required if `format` is \"jwk\".","type":"object","writeOnly":true,"x-sensitive":true},"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["secret_key"],"type":"string","x-auditable":true},"usages":{"description":"Allowed operations with the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).","example":["encrypt","decrypt"],"items":{"enum":["encrypt","decrypt","sign","verify","deriveKey","deriveBits","wrapKey","unwrapKey"],"type":"string"},"type":"array","x-auditable":true,"x-stainless-collection-type":"set"}},"required":["name","type","format","algorithm","usages"],"type":"object"},"workers_binding_kind_secret_text":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"text":{"description":"The secret value to use.","example":"My secret.","type":"string","writeOnly":true,"x-sensitive":true},"type":{"description":"The kind of resource that the binding provides.","enum":["secret_text"],"type":"string","x-auditable":true}},"required":["name","type","text"],"type":"object"},"workers_binding_kind_secrets_store_secret":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"secret_name":{"description":"Name of the secret in the store.","example":"my_secret","type":"string","x-auditable":true},"store_id":{"description":"ID of the store containing the secret.","example":"8c8b1387108e49be85669169793e7bd2","type":"string","x-auditable":true},"type":{"description":"The kind of resource that the binding provides.","enum":["secrets_store_secret"],"type":"string","x-auditable":true}},"required":["name","type","store_id","secret_name"],"type":"object"},"workers_binding_kind_send_email":{"properties":{"allowed_destination_addresses":{"description":"List of allowed destination addresses.","example":["user1@example.com","user2@example.com"],"items":{"format":"email","type":"string"},"type":"array","x-auditable":true},"allowed_sender_addresses":{"description":"List of allowed sender addresses.","example":["user1@example.com","user2@example.com"],"items":{"format":"email","type":"string"},"type":"array","x-auditable":true},"destination_address":{"description":"Destination address for the email.","example":"user@example.com","format":"email","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["send_email"],"type":"string","x-auditable":true}},"required":["name","type"],"type":"object"},"workers_binding_kind_service":{"properties":{"environment":{"default":"production","description":"Optional environment if the Worker utilizes one.","example":"production","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/workers_binding_name"},"service":{"description":"Name of Worker to bind to.","example":"my-worker","type":"string","x-auditable":true},"type":{"description":"The kind of resource that the binding provides.","enum":["service"],"type":"string","x-auditable":true}},"required":["name","type","service"],"type":"object"},"workers_binding_kind_text_blob":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"part":{"description":"The name of the file containing the text content. Only accepted for `service worker syntax` Workers.","example":"my-module.txt","type":"string","x-auditable":true},"type":{"deprecated":true,"description":"The kind of resource that the binding provides.","enum":["text_blob"],"type":"string","x-auditable":true}},"required":["name","type","part"],"type":"object"},"workers_binding_kind_vectorize":{"properties":{"index_name":{"description":"Name of the Vectorize index to bind to.","example":"my-index-name","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["vectorize"],"type":"string","x-auditable":true}},"required":["name","type","index_name"],"type":"object"},"workers_binding_kind_version_metadata":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"type":{"description":"The kind of resource that the binding provides.","enum":["version_metadata"],"type":"string","x-auditable":true}},"required":["name","type"],"type":"object"},"workers_binding_kind_wasm_module":{"properties":{"name":{"$ref":"#/components/schemas/workers_binding_name"},"part":{"description":"The name of the file containing the WebAssembly module content. Only accepted for `service worker syntax` Workers.","example":"my-module.wasm","type":"string","x-auditable":true},"type":{"deprecated":true,"description":"The kind of resource that the binding provides.","enum":["wasm_module"],"type":"string","x-auditable":true}},"required":["name","type","part"],"type":"object"},"workers_binding_kind_workflow":{"properties":{"class_name":{"description":"Class name of the Workflow. Should only be provided if the Workflow belongs to this script.","example":"my-workflow","type":"string"},"name":{"$ref":"#/components/schemas/workers_binding_name"},"script_name":{"description":"Script name that contains the Workflow. If not provided, defaults to this script name.","example":"my-workflow","type":"string","x-auditable":true},"type":{"description":"The kind of resource that the binding provides.","enum":["workflow"],"type":"string"},"workflow_name":{"description":"Name of the Workflow to bind to.","example":"my-workflow","type":"string"}},"required":["name","type","workflow_name"],"type":"object"},"workers_binding_name":{"description":"A JavaScript variable name for the binding.","example":"myBinding","type":"string","x-auditable":true},"workers_bindings":{"description":"List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.","example":[{"name":"MY_ENV_VAR","text":"my_data","type":"plain_text"}],"items":{"$ref":"#/components/schemas/workers_binding_item"},"type":"array"},"workers_compatibility_date":{"description":"Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.","example":"2021-01-01","type":"string","x-auditable":true},"workers_compatibility_flag":{"description":"Flag that enables or disables a specific feature in the Workers runtime.","example":"nodejs_compat","type":"string","x-auditable":true},"workers_compatibility_flags":{"default":[],"description":"Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a `compatibility_date`.","example":["nodejs_compat"],"items":{"$ref":"#/components/schemas/workers_compatibility_flag"},"type":"array","x-stainless-collection-type":"set"},"workers_completed-upload-assets-response":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"properties":{"jwt":{"description":"A \"completion\" JWT which can be redeemed when creating a Worker version.","type":"string","x-sensitive":true}},"type":"object"}},"type":"object"}]},"workers_create-assets-upload-session-object":{"properties":{"manifest":{"additionalProperties":{"$ref":"#/components/schemas/workers_manifest-value"},"description":"A manifest ([path]: {hash, size}) map of files to upload. As an example, `/blog/hello-world.html` would be a valid path key.","type":"object"}},"required":["manifest"],"type":"object"},"workers_create-assets-upload-session-response":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"properties":{"buckets":{"description":"The requests to make to upload assets.","items":{"description":"The set of assets to include in each request while uploading.","items":{"description":"The file hash to include in this bucket.","type":"string"},"type":"array","x-stainless-collection-type":"set"},"type":"array","x-stainless-collection-type":"set"},"jwt":{"description":"A JWT to use as authentication for uploading assets.","type":"string","x-sensitive":true}},"type":"object"}},"type":"object"}]},"workers_created_on":{"description":"When the script was created.","example":"2017-01-01T00:00:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"workers_cursor":{"description":"Opaque token indicating the position from which to continue when requesting the next set of records. A valid value for the cursor can be obtained from the cursors object in the result_info structure.","example":"AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc","type":"string"},"workers_deployment":{"properties":{"annotations":{"properties":{"workers/message":{"description":"Human-readable message about the deployment. Truncated to 100 bytes.","example":"Deploy bug fix.","maxLength":100,"type":"string","x-auditable":true},"workers/triggered_by":{"description":"Operation that triggered the creation of the deployment.","example":"deployment","readOnly":true,"type":"string"}},"type":"object"},"author_email":{"format":"email","readOnly":true,"type":"string","x-auditable":true},"created_on":{"format":"date-time","readOnly":true,"type":"string","x-auditable":true},"id":{"format":"uuid","readOnly":true,"type":"string","x-auditable":true},"source":{"example":"api","readOnly":true,"type":"string","x-auditable":true},"strategy":{"enum":["percentage"],"type":"string","x-auditable":true},"versions":{"items":{"properties":{"percentage":{"example":100,"maximum":100,"minimum":0.01,"type":"number","x-auditable":true},"version_id":{"format":"uuid","type":"string","x-auditable":true}},"required":["version_id","percentage"],"type":"object"},"type":"array","x-auditable":true}},"required":["id","source","strategy","versions","created_on"],"type":"object"},"workers_dispatch_namespace_name":{"description":"Name of the Workers for Platforms dispatch namespace.","example":"my-dispatch-namespace","pattern":"^.+$","type":"string","x-auditable":true},"workers_domain":{"properties":{"environment":{"$ref":"#/components/schemas/workers_schemas-environment"},"hostname":{"$ref":"#/components/schemas/workers_hostname"},"id":{"$ref":"#/components/schemas/workers_domain_identifier"},"service":{"$ref":"#/components/schemas/workers_schemas-service"},"zone_id":{"$ref":"#/components/schemas/workers_zone_identifier"},"zone_name":{"$ref":"#/components/schemas/workers_zone_name"}},"type":"object"},"workers_domain-response-collection":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers_domain"},"type":"array"}},"type":"object"}]},"workers_domain-response-single":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_domain"}},"type":"object"}]},"workers_domain_identifier":{"description":"Identifer of the Worker Domain.","example":"dbe10b4bc17c295377eabd600e1787fd","type":"string","x-auditable":true},"workers_environment":{"description":"Optional environment if the Worker utilizes one.","example":"production","type":"string","x-auditable":true},"workers_etag":{"description":"Hashed script content, can be used in a If-None-Match header when updating.","example":"ea95132c15732412d22c1476fa83f27a","readOnly":true,"type":"string"},"workers_has_assets":{"description":"Whether a Worker contains assets.","example":false,"type":"boolean","x-auditable":true},"workers_has_modules":{"description":"Whether a Worker contains modules.","example":false,"type":"boolean","x-auditable":true},"workers_hostname":{"description":"Hostname of the Worker Domain.","example":"foo.example.com","type":"string","x-auditable":true},"workers_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"workers_limits":{"description":"Limits to apply for this Worker.","properties":{"cpu_ms":{"description":"The amount of CPU time this Worker can use in milliseconds.","example":50,"type":"integer","x-auditable":true}},"type":"object"},"workers_logpush":{"default":false,"description":"Whether Logpush is turned on for the Worker.","example":false,"type":"boolean","x-auditable":true},"workers_manifest-value":{"properties":{"hash":{"description":"The hash of the file.","type":"string"},"size":{"description":"The size of the file in bytes.","type":"integer"}},"required":["hash","size"],"type":"object"},"workers_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"workers_migration_step":{"properties":{"deleted_classes":{"description":"A list of classes to delete Durable Object namespaces from.","items":{"type":"string","x-auditable":true},"type":"array","writeOnly":true},"new_classes":{"description":"A list of classes to create Durable Object namespaces from.","items":{"type":"string","x-auditable":true},"type":"array","writeOnly":true},"new_sqlite_classes":{"description":"A list of classes to create Durable Object namespaces with SQLite from.","items":{"type":"string","x-auditable":true},"type":"array","writeOnly":true},"renamed_classes":{"description":"A list of classes with Durable Object namespaces that were renamed.","items":{"properties":{"from":{"type":"string","writeOnly":true,"x-auditable":true},"to":{"type":"string","writeOnly":true,"x-auditable":true}},"type":"object"},"type":"array","writeOnly":true},"transferred_classes":{"description":"A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.","items":{"properties":{"from":{"type":"string","writeOnly":true,"x-auditable":true},"from_script":{"type":"string","writeOnly":true,"x-auditable":true},"to":{"type":"string","writeOnly":true,"x-auditable":true}},"type":"object"},"type":"array","writeOnly":true}},"type":"object"},"workers_migration_tag_conditions":{"properties":{"new_tag":{"description":"Tag to set as the latest migration tag.","example":"v2","type":"string","writeOnly":true,"x-auditable":true},"old_tag":{"description":"Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected.","example":"v1","type":"string","writeOnly":true,"x-auditable":true}},"type":"object"},"workers_modified_on":{"description":"When the script was last modified.","example":"2017-01-01T00:00:00Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"workers_multipart-script":{"example":{"files":["export default {\n  async fetch(request, env, ctx) {\n    return new Response(\"Hello, world!\");\n  }\n};"],"metadata":{"compatibility_date":{},"compatibility_flags":["nodejs_compat"],"main_module":"worker.js"}},"properties":{"files":{"description":"An array of modules (often JavaScript files) comprising a Worker script. At least one module must be present and referenced in the metadata as `main_module` or `body_part` by filename.\u003cbr/\u003ePossible Content-Type(s) are: `application/javascript+module`, `text/javascript+module`, `application/javascript`, `text/javascript`, `text/x-python`, `text/x-python-requirement`, `application/wasm`, `text/plain`, `application/octet-stream`, `application/source-map`.","items":{"format":"binary","type":"string"},"type":"array","x-stainless-collection-type":"set"},"metadata":{"description":"JSON-encoded metadata about the uploaded parts and Worker configuration.","properties":{"assets":{"$ref":"#/components/schemas/workers_assets"},"bindings":{"$ref":"#/components/schemas/workers_bindings"},"body_part":{"description":"Name of the uploaded file that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker.","example":"worker.js","type":"string"},"compatibility_date":{"$ref":"#/components/schemas/workers_compatibility_date"},"compatibility_flags":{"$ref":"#/components/schemas/workers_compatibility_flags"},"keep_assets":{"description":"Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token.","example":false,"type":"boolean"},"keep_bindings":{"description":"List of binding types to keep from previous_upload.","items":{"type":"string"},"type":"array","x-stainless-collection-type":"set"},"limits":{"$ref":"#/components/schemas/workers_limits"},"logpush":{"$ref":"#/components/schemas/workers_logpush"},"main_module":{"description":"Name of the uploaded file that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.","example":"worker.js","type":"string"},"migrations":{"description":"Migrations to apply for Durable Objects associated with this Worker.","oneOf":[{"$ref":"#/components/schemas/workers_single_step_migrations"},{"$ref":"#/components/schemas/workers_multiple_step_migrations"}],"writeOnly":true},"observability":{"$ref":"#/components/schemas/workers_observability"},"placement":{"$ref":"#/components/schemas/workers_placement_info"},"tags":{"description":"List of strings to use as tags for this Worker.","items":{"type":"string"},"type":"array","x-stainless-collection-type":"set"},"tail_consumers":{"$ref":"#/components/schemas/workers_tail_consumers"},"usage_model":{"$ref":"#/components/schemas/workers_usage_model"}},"type":"object"}},"required":["metadata"],"type":"object"},"workers_multiple_step_migrations":{"allOf":[{"$ref":"#/components/schemas/workers_migration_tag_conditions"},{"properties":{"steps":{"description":"Migrations to apply in order.","items":{"$ref":"#/components/schemas/workers_migration_step"},"type":"array","writeOnly":true}},"type":"object"}]},"workers_namespace":{"properties":{"class":{"type":"string"},"id":{"readOnly":true,"type":"string"},"name":{"type":"string"},"script":{"type":"string"},"use_sqlite":{"type":"boolean"}},"type":"object"},"workers_namespace-list-response":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers_namespace-response"},"type":"array"}},"type":"object"}]},"workers_namespace-response":{"properties":{"created_by":{"$ref":"#/components/schemas/workers_identifier"},"created_on":{"$ref":"#/components/schemas/workers_created_on"},"modified_by":{"$ref":"#/components/schemas/workers_identifier"},"modified_on":{"$ref":"#/components/schemas/workers_modified_on"},"namespace_id":{"$ref":"#/components/schemas/workers_uuid"},"namespace_name":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"},"script_count":{"$ref":"#/components/schemas/workers_script_count"},"trusted_workers":{"$ref":"#/components/schemas/workers_trusted_workers"}},"type":"object"},"workers_namespace-script-delete-bulk-response":{"description":"Detail about bulk deletion of scripts in a namespace.","properties":{"deleted":{"items":{"properties":{"id":{"$ref":"#/components/schemas/workers_uuid"}},"type":"object"},"type":"array"},"deleted_count":{"example":100,"type":"integer"},"has_more":{"example":false,"type":"boolean"}},"type":"object"},"workers_namespace-script-response":{"description":"Details about a worker uploaded to a Workers for Platforms namespace.","properties":{"created_on":{"$ref":"#/components/schemas/workers_created_on"},"dispatch_namespace":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"},"modified_on":{"$ref":"#/components/schemas/workers_modified_on"},"script":{"$ref":"#/components/schemas/workers_script-response"}},"type":"object"},"workers_namespace-script-response-single":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_namespace-script-response"}},"required":["result"],"type":"object"}]},"workers_namespace-single-response":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_namespace-response"}},"type":"object"}]},"workers_namespace_identifier":{"description":"Namespace identifier tag.","example":"0f2ac74b498b48028cb68387c421e279","maxLength":32,"type":"string","x-auditable":true},"workers_object":{"properties":{"hasStoredData":{"description":"Whether the Durable Object has stored data.","example":true,"readOnly":true,"type":"boolean"},"id":{"description":"ID of the Durable Object.","example":"fe7803fc55b964e09d94666545aab688d360c6bda69ba349ced1e5f28d2fc2c8","readOnly":true,"type":"string"}},"type":"object"},"workers_observability":{"description":"Observability settings for the Worker.","properties":{"enabled":{"description":"Whether observability is enabled for the Worker.","example":true,"type":"boolean","x-auditable":true},"head_sampling_rate":{"description":"The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.","example":0.1,"nullable":true,"type":"number","x-auditable":true},"logs":{"description":"Log settings for the Worker.","nullable":true,"properties":{"destinations":{"description":"A list of destinations where logs will be exported to.","example":["cloudflare"],"items":{"type":"string"},"type":"array","x-auditable":true},"enabled":{"description":"Whether logs are enabled for the Worker.","example":true,"type":"boolean","x-auditable":true},"head_sampling_rate":{"description":"The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.","example":0.1,"nullable":true,"type":"number","x-auditable":true},"invocation_logs":{"description":"Whether [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs) are enabled for the Worker.","example":true,"type":"boolean","x-auditable":true},"persist":{"default":true,"description":"Whether log persistence is enabled for the Worker.","example":true,"type":"boolean","x-auditable":true}},"required":["enabled","invocation_logs"],"type":"object"}},"required":["enabled"],"type":"object"},"workers_placement_info":{"description":"Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).","properties":{"last_analyzed_at":{"description":"The last time the script was analyzed for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).","example":"2025-01-01T00:00:00Z","format":"date-time","readOnly":true,"type":"string"},"mode":{"$ref":"#/components/schemas/workers_placement_mode"},"status":{"$ref":"#/components/schemas/workers_placement_status"}},"type":"object"},"workers_placement_info_no_status":{"description":"Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).","properties":{"mode":{"$ref":"#/components/schemas/workers_placement_mode"}},"type":"object"},"workers_placement_mode":{"description":"Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).","enum":["smart"],"type":"string","x-auditable":true},"workers_placement_status":{"description":"Status of [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).","enum":["SUCCESS","UNSUPPORTED_APPLICATION","INSUFFICIENT_INVOCATIONS"],"readOnly":true,"type":"string","x-auditable":true},"workers_route":{"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/workers_identifier"}],"readOnly":true},"pattern":{"description":"Pattern to match incoming requests against. [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).","example":"example.com/*","type":"string","x-auditable":true},"script":{"description":"Name of the script to run if the route matches.","example":"my-workers-script","type":"string","x-auditable":true}},"required":["id","pattern"],"type":"object"},"workers_schedule":{"properties":{"created_on":{"readOnly":true,"type":"string","x-auditable":true},"cron":{"example":"*/30 * * * *","type":"string","x-auditable":true},"modified_on":{"readOnly":true,"type":"string"}},"required":["cron"],"type":"object"},"workers_schemas-environment":{"deprecated":true,"description":"Worker environment associated with the zone and hostname.","example":"production","type":"string","x-auditable":true},"workers_schemas-id":{"description":"ID of the namespace.","example":"5fd1cafff895419c8bcc647fc64ab8f0","type":"string"},"workers_schemas-script_name":{"description":"Name of the script.","example":"this-is_my_script-01","pattern":"^[a-z0-9_][a-z0-9-_]*$","type":"string"},"workers_schemas-service":{"description":"Worker service associated with the zone and hostname.","example":"foo","type":"string","x-auditable":true},"workers_schemas-subdomain":{"properties":{"subdomain":{"example":"my-subdomain","type":"string"}},"required":["subdomain"],"type":"object"},"workers_script-and-version-settings-item":{"properties":{"bindings":{"allOf":[{"$ref":"#/components/schemas/workers_bindings"},{"default":[],"items":{"$ref":"#/components/schemas/workers_binding_item"},"type":"array"}]},"compatibility_date":{"allOf":[{"$ref":"#/components/schemas/workers_compatibility_date"},{"default":"","type":"string","x-auditable":true}]},"compatibility_flags":{"allOf":[{"$ref":"#/components/schemas/workers_compatibility_flags"},{"default":[],"items":{"type":"string","x-auditable":true},"type":"array","x-stainless-collection-type":"set"}]},"limits":{"$ref":"#/components/schemas/workers_limits"},"logpush":{"$ref":"#/components/schemas/workers_logpush"},"migrations":{"description":"Migrations to apply for Durable Objects associated with this Worker.\n","oneOf":[{"$ref":"#/components/schemas/workers_single_step_migrations"},{"$ref":"#/components/schemas/workers_multiple_step_migrations"}],"writeOnly":true},"observability":{"$ref":"#/components/schemas/workers_observability"},"placement":{"allOf":[{"$ref":"#/components/schemas/workers_placement_info_no_status"},{"default":{},"type":"object"}]},"tags":{"allOf":[{"$ref":"#/components/schemas/workers_tags"},{"default":[],"items":{"type":"string","x-auditable":true},"type":"array","x-stainless-collection-type":"set"}]},"tail_consumers":{"allOf":[{"$ref":"#/components/schemas/workers_tail_consumers"},{"default":[],"items":{"$ref":"#/components/schemas/workers_tail_consumers_script"},"type":"array","x-stainless-collection-type":"set"}]},"usage_model":{"$ref":"#/components/schemas/workers_usage_model"}},"type":"object"},"workers_script-and-version-settings-response":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_script-and-version-settings-item"}},"required":["result"],"type":"object"}]},"workers_script-response":{"properties":{"compatibility_date":{"$ref":"#/components/schemas/workers_compatibility_date"},"compatibility_flags":{"$ref":"#/components/schemas/workers_compatibility_flags"},"created_on":{"$ref":"#/components/schemas/workers_created_on"},"etag":{"$ref":"#/components/schemas/workers_etag"},"handlers":{"description":"The names of handlers exported as part of the default export.","example":["fetch","scheduled"],"items":{"type":"string"},"type":"array"},"has_assets":{"$ref":"#/components/schemas/workers_has_assets"},"has_modules":{"$ref":"#/components/schemas/workers_has_modules"},"id":{"description":"The name used to identify the script.","example":"my-workers-script","readOnly":true,"type":"string","x-auditable":true},"last_deployed_from":{"description":"The client most recently used to deploy this Worker.","example":"wrangler","type":"string"},"logpush":{"$ref":"#/components/schemas/workers_logpush"},"migration_tag":{"description":"The tag of the Durable Object migration that was most recently applied for this Worker.","example":"v1","type":"string"},"modified_on":{"$ref":"#/components/schemas/workers_modified_on"},"named_handlers":{"description":"Named exports, such as Durable Object class implementations and named entrypoints.","items":{"properties":{"handlers":{"description":"The names of handlers exported as part of the named export.","example":["class"],"items":{"type":"string"},"type":"array"},"name":{"description":"The name of the export.","example":"MyDurableObject","type":"string"}},"type":"object"},"type":"array"},"observability":{"$ref":"#/components/schemas/workers_observability"},"placement":{"$ref":"#/components/schemas/workers_placement_info"},"placement_mode":{"allOf":[{"$ref":"#/components/schemas/workers_placement_mode"},{"deprecated":true,"type":"string"}]},"placement_status":{"allOf":[{"$ref":"#/components/schemas/workers_placement_status"},{"deprecated":true,"type":"string"}]},"tag":{"description":"The immutable ID of the script.","example":"e8f70fdbc8b1fb0b8ddb1af166186758","readOnly":true,"type":"string"},"tags":{"$ref":"#/components/schemas/workers_tags"},"tail_consumers":{"$ref":"#/components/schemas/workers_tail_consumers"},"usage_model":{"$ref":"#/components/schemas/workers_usage_model"}}},"workers_script-response-collection":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"items":{"allOf":[{"$ref":"#/components/schemas/workers_script-response"},{"properties":{"routes":{"description":"Routes associated with the Worker.","items":{"$ref":"#/components/schemas/workers_route"},"nullable":true,"type":"array"}},"type":"object"}]},"type":"array"}},"required":["result"],"type":"object"}]},"workers_script-response-single":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/workers_script-response"}},"required":["result"],"type":"object","x-cfLinkErrors":{"10001":"Unsupported or unexpected Content Type","10002":"Unexpected internal server error","10003":"Missing required URL parameter","10004":"Malformed URL parameter","10006":"Unparseable script body","10007":"Resource not found (similar to HTTP 404)","10014":"Internal error while attempting authorization checks","10015":"The current account is not authorized to use workers","10018":"Attempted to update a script where the e-tag does not match","10021":"Script content failed validation checks, but was otherwise parseable","10023":"Unauthorized access attempt","10027":"Script body was too large","10075":"Requires a Workers Paid plan"}}]},"workers_script-response-upload":{"allOf":[{"$ref":"#/components/schemas/workers_script-response"},{"properties":{"entry_point":{"description":"The entry point for the script.","example":"index.js","readOnly":true,"type":"string"},"startup_time_ms":{"example":10,"readOnly":true,"type":"integer","x-auditable":true}},"required":["startup_time_ms"],"type":"object"}]},"workers_script-response-upload-single":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_script-response-upload"}},"required":["result"],"type":"object","x-cfLinkErrors":{"10001":"Unsupported or unexpected Content Type","10002":"Unexpected internal server error","10003":"Missing required URL parameter","10004":"Malformed URL parameter","10006":"Unparseable script body","10007":"Resource not found (similar to HTTP 404)","10014":"Internal error while attempting authorization checks","10015":"The current account is not authorized to use workers","10018":"Attempted to update a script where the e-tag does not match","10021":"Script content failed validation checks, but was otherwise parseable","10023":"Unauthorized access attempt","10027":"Script body was too large","10075":"Requires a Workers Paid plan"}}]},"workers_script-settings-item":{"properties":{"logpush":{"$ref":"#/components/schemas/workers_logpush"},"observability":{"allOf":[{"$ref":"#/components/schemas/workers_observability"},{"nullable":true,"type":"object","x-auditable":true}]},"tags":{"allOf":[{"$ref":"#/components/schemas/workers_tags"},{"items":{"$ref":"#/components/schemas/workers_tag"},"nullable":true,"type":"array","x-auditable":true}]},"tail_consumers":{"description":"List of Workers that will consume logs from the attached Worker.","items":{"$ref":"#/components/schemas/workers_tail_consumers_script"},"nullable":true,"type":"array","x-stainless-collection-type":"set"}},"type":"object"},"workers_script-settings-response":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_script-settings-item"}},"required":["result"],"type":"object"}]},"workers_script_count":{"description":"The current number of scripts in this Dispatch Namespace.","example":800,"type":"integer"},"workers_script_name":{"description":"Name of the script, used in URLs and route configuration.","example":"this-is_my_script-01","pattern":"^[a-z0-9_][a-z0-9-_]*$","type":"string","x-auditable":true},"workers_secret":{"description":"A secret value accessible through a binding.","discriminator":{"mapping":{"secret_key":"#/components/schemas/workers_binding_kind_secret_key","secret_text":"#/components/schemas/workers_binding_kind_secret_text"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/workers_binding_kind_secret_text"},{"$ref":"#/components/schemas/workers_binding_kind_secret_key"}],"type":"object"},"workers_secret_name":{"description":"A JavaScript variable name for the secret binding.","example":"mySecret","readOnly":true,"type":"string","x-auditable":true},"workers_secret_name_url_encoded":{"description":"Flag that indicates whether the secret name is URL encoded.","example":true,"readOnly":true,"type":"boolean","x-auditable":true},"workers_service":{"description":"Name of Worker to bind to.","example":"my-worker","type":"string","x-auditable":true},"workers_single_step_migrations":{"allOf":[{"$ref":"#/components/schemas/workers_migration_tag_conditions"},{"$ref":"#/components/schemas/workers_migration_step"}],"description":"A single set of migrations to apply."},"workers_subdomain":{"properties":{"enabled":{"default":false,"description":"Whether the Worker is available on the workers.dev subdomain.","example":false,"type":"boolean","x-auditable":true},"previews_enabled":{"description":"Whether the Worker's Preview URLs are available on the workers.dev subdomain.","example":false,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"}},"required":["enabled","previews_enabled"],"type":"object"},"workers_tag":{"example":"my-tag","maxLength":1024,"pattern":"^[^,\u0026]*$","type":"string"},"workers_tags":{"description":"Tags associated with the Worker.","example":["my-team","my-public-api"],"items":{"$ref":"#/components/schemas/workers_tag"},"maxItems":10,"nullable":true,"type":"array","x-auditable":true,"x-stainless-collection-type":"set"},"workers_tail":{"properties":{"expires_at":{"readOnly":true,"type":"string"},"id":{"allOf":[{"$ref":"#/components/schemas/workers_identifier"}],"readOnly":true},"url":{"readOnly":true,"type":"string"}},"required":["id","url","expires_at"],"type":"object"},"workers_tail_consumers":{"description":"List of Workers that will consume logs from the attached Worker.","items":{"$ref":"#/components/schemas/workers_tail_consumers_script"},"nullable":true,"type":"array","x-stainless-collection-type":"set"},"workers_tail_consumers_script":{"description":"A reference to a script that will consume logs from the attached Worker.","properties":{"environment":{"description":"Optional environment if the Worker utilizes one.","example":"production","type":"string","x-auditable":true},"namespace":{"description":"Optional dispatch namespace the script belongs to.","example":"my-namespace","type":"string","x-auditable":true},"service":{"description":"Name of Worker that is to be the consumer.","example":"my-log-consumer","type":"string","x-auditable":true}},"required":["service"],"type":"object"},"workers_trusted_workers":{"default":false,"description":"Whether the Workers in the namespace are executed in a \"trusted\" manner. When a Worker is trusted, it has access to the shared caches for the zone in the Cache API, and has access to the `request.cf` object on incoming Requests. When a Worker is untrusted, caches are not shared across the zone, and `request.cf` is undefined. By default, Workers in a namespace are \"untrusted\".","example":false,"type":"boolean","x-auditable":true},"workers_upload-assets-response":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"additionalProperties":false,"maxProperties":0,"type":"object"}},"type":"object"}]},"workers_usage-model-response":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"properties":{"usage_model":{"$ref":"#/components/schemas/workers_usage_model"},"user_limits":{"$ref":"#/components/schemas/workers_user_limits"}},"type":"object"}},"required":["result"],"type":"object"}]},"workers_usage_model":{"default":"standard","description":"Usage model for the Worker invocations.","enum":["standard","bundled","unbound"],"example":"standard","type":"string","x-auditable":true},"workers_user_limits":{"description":"User-defined resource limits for Workers with standard usage model.","nullable":true,"properties":{"cpu_ms":{"description":"The amount of CPU time this Worker can use in milliseconds.","example":50,"nullable":true,"type":"integer"}},"type":"object"},"workers_uuid":{"description":"API Resource UUID tag.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string","x-auditable":true},"workers_version-item-full":{"allOf":[{"$ref":"#/components/schemas/workers_version-item-short"},{"properties":{"resources":{"example":{"bindings":[{"json":"example_binding","name":"JSON_VAR","type":"json"}],"script":{"etag":"13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794","handlers":["fetch"],"last_deployed_from":"api"},"script_runtime":{"usage_model":"standard"}},"properties":{"bindings":{"allOf":[{"$ref":"#/components/schemas/workers_bindings"},{"readOnly":true}]},"script":{"example":{"etag":"13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794","handlers":["fetch"],"last_deployed_from":"api","named_handlers":[{"handlers":["fetch"],"name":"MyClass"}]},"properties":{"etag":{"description":"Hashed script content","example":"13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794","readOnly":true,"type":"string"},"handlers":{"description":"The names of handlers exported as part of the default export.","example":["fetch"],"items":{"example":"fetch","readOnly":true,"type":"string"},"readOnly":true,"type":"array","x-stainless-collection-type":"set"},"last_deployed_from":{"description":"The client most recently used to deploy this Worker.","example":"api","readOnly":true,"type":"string"},"named_handlers":{"description":"Named exports, such as Durable Object class implementations and named entrypoints.","example":[{"handlers":["fetch"],"name":"MyClass"}],"items":{"example":{"handlers":["fetch"],"name":"MyClass"},"properties":{"handlers":{"description":"The names of handlers exported as part of the named export.","example":["fetch"],"items":{"example":"fetch","readOnly":true,"type":"string"},"readOnly":true,"type":"array","x-stainless-collection-type":"set"},"name":{"description":"The name of the exported class or entrypoint.","example":"MyClass","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"readOnly":true,"type":"array","x-stainless-collection-type":"set"}},"readOnly":true,"type":"object"},"script_runtime":{"description":"Runtime configuration for the Worker.","properties":{"compatibility_date":{"description":"Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.","example":"2022-11-08","readOnly":true,"type":"string"},"compatibility_flags":{"description":"Flags that enable or disable certain features in the Workers runtime.","items":{"example":"x","readOnly":true,"type":"string"},"readOnly":true,"type":"array","x-stainless-collection-type":"set"},"limits":{"description":"Resource limits for the Worker.","example":{"cpu_ms":50},"properties":{"cpu_ms":{"description":"The amount of CPU time this Worker can use in milliseconds.","example":50,"readOnly":true,"type":"integer"}},"readOnly":true,"type":"object"},"migration_tag":{"description":"The tag of the Durable Object migration that was most recently applied for this Worker.","example":"v1","readOnly":true,"type":"string"},"usage_model":{"description":"Usage model for the Worker invocations.","enum":["bundled","unbound","standard"],"example":"standard","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"}},"readOnly":true,"type":"object"}},"required":["resources"],"type":"object"}]},"workers_version-item-short":{"properties":{"id":{"description":"Unique identifier for the version.","example":"18f97339-c287-4872-9bdd-e2135c07ec12","readOnly":true,"type":"string"},"metadata":{"example":{"author_email":"user@example.com","author_id":"408cbcdfd4dda4617efef40b04d168a1","created_on":"2022-11-08T17:19:29.176266Z","modified_on":"2022-11-08T17:19:29.176266Z","source":"api"},"properties":{"author_email":{"description":"Email of the user who created the version.","example":"user@example.com","readOnly":true,"type":"string"},"author_id":{"description":"Identifier of the user who created the version.","example":"408cbcdfd4dda4617efef40b04d168a1","readOnly":true,"type":"string"},"created_on":{"description":"When the version was created.","example":"2022-11-08T17:19:29.176266Z","readOnly":true,"type":"string"},"hasPreview":{"description":"Whether the version can be previewed.","readOnly":true,"type":"boolean"},"modified_on":{"description":"When the version was last modified.","example":"2022-11-08T17:19:29.176266Z","readOnly":true,"type":"string"},"source":{"description":"The source of the version upload.","enum":["unknown","api","wrangler","terraform","dash","dash_template","integration","quick_editor","playground","workersci"],"example":"api","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"number":{"description":"Sequential version number.","example":1,"readOnly":true,"type":"number"}},"type":"object"},"workers_version-item-uploaded":{"allOf":[{"$ref":"#/components/schemas/workers_version-item-full"},{"properties":{"startup_time_ms":{"description":"Time in milliseconds spent on [Worker startup](https://developers.cloudflare.com/workers/platform/limits/#worker-startup-time).","example":10,"type":"integer"}},"required":["resources"],"type":"object"}]},"workers_version_identifier":{"example":"bcf48806-b317-4351-9ee7-36e7d557d4de","maxLength":36,"readOnly":true,"type":"string"},"workers_versions-list-response":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"properties":{"items":{"items":{"$ref":"#/components/schemas/workers_version-item-short"},"type":"array"}},"type":"object"}},"required":["result"],"type":"object"}]},"workers_versions-single-response":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_version-item-full"}},"required":["result"],"type":"object"}]},"workers_versions-upload-response":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_version-item-uploaded"}},"required":["result"],"type":"object"}]},"workers_zone_identifier":{"description":"Identifier of the zone.","example":"593c9c94de529bbbfaac7c53ced0447d","type":"string","x-auditable":true},"workers_zone_name":{"description":"Name of the zone.","example":"example.com","type":"string","x-auditable":true},"zaraz_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/zaraz_messages"},"messages":{"$ref":"#/components/schemas/zaraz_messages"},"success":{"description":"Whether the API call was successful","example":true,"type":"boolean","x-auditable":true}},"required":["success","errors","messages","result"],"type":"object"},"zaraz_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/zaraz_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/zaraz_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"zaraz_base-mc":{"allOf":[{"$ref":"#/components/schemas/zaraz_base-tool"},{"properties":{"actions":{"additionalProperties":{"properties":{"actionType":{"description":"Tool event type","type":"string","x-auditable":true},"blockingTriggers":{"description":"List of blocking triggers IDs","items":{"type":"string","x-auditable":true},"type":"array"},"data":{"description":"Event payload","type":"object"},"firingTriggers":{"description":"List of firing triggers IDs","items":{"type":"string","x-auditable":true},"minItems":1,"type":"array"}},"required":["actionType","blockingTriggers","firingTriggers","data"],"type":"object"},"description":"Actions configured on a tool. Either this or neoEvents field is required.","type":"object"},"component":{"description":"Tool's internal name","type":"string","x-auditable":true},"neoEvents":{"description":"DEPRECATED - List of actions configured on a tool. Either this or actions field is required. If both are present, actions field will take precedence.","items":{"properties":{"actionType":{"description":"Tool event type","type":"string","x-auditable":true},"blockingTriggers":{"description":"List of blocking triggers IDs","items":{"type":"string","x-auditable":true},"type":"array"},"data":{"description":"Event payload","type":"object"},"firingTriggers":{"description":"List of firing triggers IDs","items":{"type":"string","x-auditable":true},"minItems":1,"type":"array"}},"required":["actionType","blockingTriggers","firingTriggers","data"],"type":"object"},"type":"array"},"permissions":{"description":"List of permissions granted to the component","items":{"type":"string","x-auditable":true},"type":"array"},"settings":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"boolean"}],"x-auditable":true},"description":"Tool's settings","type":"object"}},"required":["component","settings","permissions"]}]},"zaraz_base-tool":{"properties":{"blockingTriggers":{"description":"List of blocking trigger IDs","items":{"type":"string","x-auditable":true},"type":"array"},"defaultFields":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"boolean"}],"x-auditable":true},"description":"Default fields for tool's actions","type":"object"},"defaultPurpose":{"description":"Default consent purpose ID","type":"string","x-auditable":true},"enabled":{"description":"Whether tool is enabled","type":"boolean","x-auditable":true},"name":{"description":"Tool's name defined by the user","type":"string","x-auditable":true},"vendorName":{"description":"Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned","type":"string","x-auditable":true},"vendorPolicyUrl":{"description":"Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned","type":"string","x-auditable":true}},"required":["enabled","blockingTriggers","name","defaultFields"],"type":"object"},"zaraz_click-listener-rule":{"properties":{"action":{"enum":["clickListener"],"type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"settings":{"properties":{"selector":{"type":"string","x-auditable":true},"type":{"enum":["xpath","css"],"type":"string","x-auditable":true},"waitForTags":{"minimum":0,"type":"integer","x-auditable":true}},"required":["type","selector","waitForTags"],"type":"object"}},"required":["id","action","settings"],"type":"object"},"zaraz_custom-managed-component":{"allOf":[{"$ref":"#/components/schemas/zaraz_base-mc"},{"properties":{"type":{"enum":["custom-mc"],"type":"string"},"worker":{"description":"Cloudflare worker that acts as a managed component","properties":{"escapedWorkerName":{"type":"string","x-auditable":true},"workerTag":{"type":"string","x-auditable":true}},"required":["workerTag","escapedWorkerName"],"type":"object"}},"required":["worker","type"]}]},"zaraz_element-visibility-rule":{"properties":{"action":{"enum":["elementVisibility"],"type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"settings":{"properties":{"selector":{"type":"string","x-auditable":true}},"required":["selector"],"type":"object"}},"required":["id","action","settings"],"type":"object"},"zaraz_form-submission-rule":{"properties":{"action":{"enum":["formSubmission"],"type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"settings":{"properties":{"selector":{"type":"string","x-auditable":true},"validate":{"type":"boolean","x-auditable":true}},"required":["selector","validate"],"type":"object"}},"required":["id","action","settings"],"type":"object"},"zaraz_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"zaraz_load-rule":{"properties":{"id":{"type":"string","x-auditable":true},"match":{"type":"string","x-auditable":true},"op":{"enum":["CONTAINS","EQUALS","STARTS_WITH","ENDS_WITH","MATCH_REGEX","NOT_MATCH_REGEX","GREATER_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL"],"type":"string","x-auditable":true},"value":{"type":"string","x-auditable":true}},"required":["id","match","op","value"],"type":"object"},"zaraz_managed-component":{"allOf":[{"$ref":"#/components/schemas/zaraz_base-mc"},{"properties":{"type":{"enum":["component"],"type":"string"}},"required":["type"]}]},"zaraz_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"zaraz_scroll-depth-rule":{"properties":{"action":{"enum":["scrollDepth"],"type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"settings":{"properties":{"positions":{"type":"string","x-auditable":true}},"required":["positions"],"type":"object"}},"required":["id","action","settings"],"type":"object"},"zaraz_secret_variable":{"properties":{"name":{"type":"string","x-auditable":true},"type":{"enum":["secret"],"type":"string","x-auditable":true},"value":{"type":"string","x-auditable":true,"x-sensitive":true}},"required":["name","type","value"],"type":"object"},"zaraz_string_variable":{"properties":{"name":{"type":"string","x-auditable":true},"type":{"enum":["string"],"type":"string","x-auditable":true},"value":{"type":"string","x-auditable":true}},"required":["name","type","value"],"type":"object"},"zaraz_timer-rule":{"properties":{"action":{"enum":["timer"],"type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"settings":{"properties":{"interval":{"minimum":50,"type":"integer","x-auditable":true},"limit":{"minimum":0,"type":"integer","x-auditable":true}},"required":["interval","limit"],"type":"object"}},"required":["id","action","settings"],"type":"object"},"zaraz_variable-match-rule":{"properties":{"action":{"enum":["variableMatch"],"type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"settings":{"properties":{"match":{"type":"string","x-auditable":true},"variable":{"type":"string","x-auditable":true}},"required":["variable","match"],"type":"object"}},"required":["id","action","settings"],"type":"object"},"zaraz_worker_variable":{"properties":{"name":{"type":"string","x-auditable":true},"type":{"enum":["worker"],"type":"string","x-auditable":true},"value":{"properties":{"escapedWorkerName":{"type":"string","x-auditable":true},"workerTag":{"type":"string","x-auditable":true}},"required":["escapedWorkerName","workerTag"],"type":"object"}},"required":["name","type","value"],"type":"object"},"zaraz_zaraz-config-base":{"description":"Zaraz configuration","example":{"consent":{"cookieName":"zaraz-consent","customIntroDisclaimerDismissed":true,"enabled":false},"dataLayer":true,"debugKey":"my-debug-key","settings":{"autoInjectScript":true,"ecommerce":true,"initPath":"/i"},"tools":{"aJvt":{"actions":{"hrnc":{"actionType":"pageview","blockingTriggers":[],"data":{"__zaraz_setting_name":"Page view","ev":"PageView"},"firingTriggers":["Pageview"]}},"component":"facebook-pixel","defaultFields":{"testKey":"TEST123456"},"enabled":true,"name":"Facebook Pixel","permissions":["access_client_kv"],"settings":{"accessToken":"ABcdEFg","ecommerce":true,"property":"12345"},"type":"component"}},"triggers":{"ktBn":{"Pageview":{"clientRules":[],"description":"All page loads","excludeRules":[],"loadRules":[{"match":"{{ client.__zarazTrack }}","op":"EQUALS","value":"Pageview"}],"name":"Pageview","system":"pageload"}}},"variables":{"Autd":{"name":"ip","type":"string","value":"{{ system.device.ip }}"}},"zarazVersion":43},"properties":{"analytics":{"description":"Cloudflare Monitoring settings.","properties":{"defaultPurpose":{"description":"Consent purpose assigned to Monitoring.","type":"string","x-auditable":true},"enabled":{"description":"Whether Advanced Monitoring reports are enabled.","type":"boolean","x-auditable":true},"sessionExpTime":{"description":"Session expiration time (seconds).","maximum":86400,"minimum":60,"type":"integer","x-auditable":true}},"type":"object"},"consent":{"description":"Consent management configuration.","properties":{"buttonTextTranslations":{"properties":{"accept_all":{"additionalProperties":{"type":"string","x-auditable":true},"description":"Object where keys are language codes","type":"object"},"confirm_my_choices":{"additionalProperties":{"type":"string","x-auditable":true},"description":"Object where keys are language codes","type":"object"},"reject_all":{"additionalProperties":{"type":"string","x-auditable":true},"description":"Object where keys are language codes","type":"object"}},"required":["accept_all","reject_all","confirm_my_choices"],"type":"object"},"companyEmail":{"type":"string","x-auditable":true},"companyName":{"type":"string","x-auditable":true},"companyStreetAddress":{"type":"string","x-auditable":true},"consentModalIntroHTML":{"type":"string","x-auditable":true},"consentModalIntroHTMLWithTranslations":{"additionalProperties":{"type":"string","x-auditable":true},"description":"Object where keys are language codes","type":"object"},"cookieName":{"type":"string","x-auditable":true},"customCSS":{"type":"string","x-auditable":true},"customIntroDisclaimerDismissed":{"type":"boolean","x-auditable":true},"defaultLanguage":{"type":"string","x-auditable":true},"enabled":{"type":"boolean"},"hideModal":{"type":"boolean","x-auditable":true},"purposes":{"additionalProperties":{"properties":{"description":{"type":"string","x-auditable":true},"name":{"type":"string","x-auditable":true}},"required":["name","description"],"type":"object"},"description":"Object where keys are purpose alpha-numeric IDs","type":"object"},"purposesWithTranslations":{"additionalProperties":{"properties":{"description":{"additionalProperties":{"type":"string","x-auditable":true},"description":"Object where keys are language codes","type":"object"},"name":{"additionalProperties":{"type":"string","x-auditable":true},"description":"Object where keys are language codes","type":"object"},"order":{"type":"integer","x-auditable":true}},"required":["name","description","order"],"type":"object"},"description":"Object where keys are purpose alpha-numeric IDs","type":"object"},"tcfCompliant":{"type":"boolean"}},"required":["enabled"],"type":"object"},"dataLayer":{"description":"Data layer compatibility mode enabled.","type":"boolean","x-auditable":true},"debugKey":{"description":"The key for Zaraz debug mode.","type":"string","x-auditable":true},"historyChange":{"description":"Single Page Application support enabled.","type":"boolean","x-auditable":true},"settings":{"description":"General Zaraz settings.","properties":{"autoInjectScript":{"description":"Automatic injection of Zaraz scripts enabled.","type":"boolean","x-auditable":true},"contextEnricher":{"description":"Details of the worker that receives and edits Zaraz Context object.","properties":{"escapedWorkerName":{"type":"string","x-auditable":true},"workerTag":{"type":"string","x-auditable":true}},"required":["escapedWorkerName","workerTag"],"type":"object"},"cookieDomain":{"description":"The domain Zaraz will use for writing and reading its cookies.","type":"string","x-auditable":true},"ecommerce":{"description":"Ecommerce API enabled.","type":"boolean","x-auditable":true},"eventsApiPath":{"description":"Custom endpoint for server-side track events.","type":"string","x-auditable":true},"hideExternalReferer":{"description":"Hiding external referrer URL enabled.","type":"boolean","x-auditable":true},"hideIPAddress":{"description":"Trimming IP address enabled.","type":"boolean","x-auditable":true},"hideQueryParams":{"description":"Removing URL query params enabled.","type":"boolean","x-auditable":true},"hideUserAgent":{"description":"Removing sensitive data from User Aagent string enabled.","type":"boolean"},"initPath":{"description":"Custom endpoint for Zaraz init script.","type":"string","x-auditable":true},"injectIframes":{"description":"Injection of Zaraz scripts into iframes enabled.","type":"boolean","x-auditable":true},"mcRootPath":{"description":"Custom path for Managed Components server functionalities.","type":"string","x-auditable":true},"scriptPath":{"description":"Custom endpoint for Zaraz main script.","type":"string","x-auditable":true},"trackPath":{"description":"Custom endpoint for Zaraz tracking requests.","type":"string","x-auditable":true}},"required":["autoInjectScript"],"type":"object"},"triggers":{"additionalProperties":{"properties":{"description":{"description":"Trigger description.","type":"string","x-auditable":true},"excludeRules":{"description":"Rules defining when the trigger is not fired.","items":{"anyOf":[{"$ref":"#/components/schemas/zaraz_load-rule"},{"$ref":"#/components/schemas/zaraz_click-listener-rule"},{"$ref":"#/components/schemas/zaraz_timer-rule"},{"$ref":"#/components/schemas/zaraz_form-submission-rule"},{"$ref":"#/components/schemas/zaraz_variable-match-rule"},{"$ref":"#/components/schemas/zaraz_scroll-depth-rule"},{"$ref":"#/components/schemas/zaraz_element-visibility-rule"}]},"type":"array"},"loadRules":{"description":"Rules defining when the trigger is fired.","items":{"anyOf":[{"$ref":"#/components/schemas/zaraz_load-rule"},{"$ref":"#/components/schemas/zaraz_click-listener-rule"},{"$ref":"#/components/schemas/zaraz_timer-rule"},{"$ref":"#/components/schemas/zaraz_form-submission-rule"},{"$ref":"#/components/schemas/zaraz_variable-match-rule"},{"$ref":"#/components/schemas/zaraz_scroll-depth-rule"},{"$ref":"#/components/schemas/zaraz_element-visibility-rule"}]},"type":"array"},"name":{"description":"Trigger name.","type":"string","x-auditable":true},"system":{"enum":["pageload"],"type":"string","x-auditable":true}},"required":["name","loadRules","excludeRules"],"type":"object"},"description":"Triggers set up under Zaraz configuration, where key is the trigger alpha-numeric ID and value is the trigger configuration.","type":"object"},"variables":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/zaraz_string_variable"},{"$ref":"#/components/schemas/zaraz_secret_variable"},{"$ref":"#/components/schemas/zaraz_worker_variable"}],"discriminator":{"mapping":{"secret":"#/components/schemas/zaraz_secret_variable","string":"#/components/schemas/zaraz_string_variable","worker":"#/components/schemas/zaraz_worker_variable"},"propertyName":"type"}},"description":"Variables set up under Zaraz configuration, where key is the variable alpha-numeric ID and value is the variable configuration. Values of variables of type secret are not included.","type":"object"},"zarazVersion":{"description":"Zaraz internal version of the config.","type":"integer","x-auditable":true}},"required":["tools","triggers","variables","settings","dataLayer","debugKey","zarazVersion"],"type":"object"},"zaraz_zaraz-config-body":{"allOf":[{"$ref":"#/components/schemas/zaraz_zaraz-config-base"},{"properties":{"tools":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/zaraz_managed-component"},{"$ref":"#/components/schemas/zaraz_custom-managed-component"}]},"description":"Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID and value is the tool configuration object.","type":"object"}}}]},"zaraz_zaraz-config-history-response":{"allOf":[{"$ref":"#/components/schemas/zaraz_api-response-common"},{"properties":{"result":{"additionalProperties":{"allOf":[{"$ref":"#/components/schemas/zaraz_zaraz-config-row-base"},{"description":"Configuration record correspoding to an ID provided in query params","nullable":true,"properties":{"config":{"$ref":"#/components/schemas/zaraz_zaraz-config-return"}},"required":["config"],"type":"object"}]},"description":"Object where keys are numericc onfiguration IDs","example":{"12345":{"config":{"consent":{"cookieName":"zaraz-consent","customIntroDisclaimerDismissed":true,"enabled":false},"dataLayer":true,"debugKey":"my-debug-key","settings":{"autoInjectScript":true},"tools":{"aJvt":{"component":"facebook-pixel","defaultFields":{"testKey":"TEST123456"},"enabled":true,"name":"Facebook Pixel","neoEvents":[{"actionType":"pageview","blockingTriggers":[],"data":{"__zaraz_setting_name":"Page view","ev":"PageView"},"firingTriggers":["Pageview"]}],"permissions":["access_client_kv"],"settings":{"accessToken":"ABcdEFg","ecommerce":true,"property":"12345"},"type":"component"}},"triggers":{"ktBn":{"Pageview":{"clientRules":[],"description":"All page loads","excludeRules":[],"loadRules":[{"match":"{{ client.__zarazTrack }}","op":"EQUALS","value":"Pageview"}],"name":"Pageview","system":"pageload"}}},"variables":{"Autd":{"name":"ip","type":"string","value":"{{ system.device.ip }}"}},"zarazVersion":43},"createdAt":"2023-02-23T05:05:55.155273Z","id":12345,"updatedAt":"2023-02-23T05:05:55.155273Z","userId":"278d0d0g123cd8e49d45ea64f12faa37"},"23456":null},"type":"object"}}}]},"zaraz_zaraz-config-response":{"allOf":[{"$ref":"#/components/schemas/zaraz_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/zaraz_zaraz-config-return"}}}]},"zaraz_zaraz-config-return":{"allOf":[{"$ref":"#/components/schemas/zaraz_zaraz-config-base"},{"properties":{"tools":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/zaraz_managed-component"},{"$ref":"#/components/schemas/zaraz_custom-managed-component"}]},"description":"Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID and value is the tool configuration object.","type":"object"}}}]},"zaraz_zaraz-config-row-base":{"properties":{"createdAt":{"description":"Date and time the configuration was created","format":"date-time","type":"string","x-auditable":true},"id":{"description":"ID of the configuration","type":"integer","x-auditable":true},"updatedAt":{"description":"Date and time the configuration was last updated","format":"date-time","type":"string","x-auditable":true},"userId":{"description":"Alpha-numeric ID of the account user who published the configuration","type":"string","x-auditable":true}},"required":["id","createdAt","updatedAt","userId"]},"zaraz_zaraz-history-response":{"allOf":[{"$ref":"#/components/schemas/zaraz_api-response-common"},{"properties":{"result":{"items":{"allOf":[{"$ref":"#/components/schemas/zaraz_zaraz-config-row-base"},{"example":{"createdAt":"2023-02-23T05:05:55.155273Z","description":"Config with enabled ecommerce tracking","id":12345,"updatedAt":"2023-02-23T05:05:55.155273Z","userId":"278d0d0g123cd8e49d45ea64f12faa37"},"properties":{"description":{"description":"Configuration description provided by the user who published this configuration","type":"string"}},"required":["description"],"type":"object"}]},"type":"array"}}}]},"zaraz_zaraz-workflow":{"description":"Zaraz workflow","enum":["realtime","preview"],"type":"string","x-auditable":true},"zaraz_zaraz-workflow-response":{"allOf":[{"$ref":"#/components/schemas/zaraz_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/zaraz_zaraz-workflow"}}}]},"zaraz_zone-identifier":{"$ref":"#/components/schemas/zaraz_identifier"},"zero-trust-gateway_account-log-options":{"properties":{"log_all":{"default":false,"description":"Specify whether to log all requests to this service.","example":false,"type":"boolean","x-auditable":true},"log_blocks":{"default":false,"description":"Specify whether to log only blocking requests to this service.","example":true,"type":"boolean","x-auditable":true}},"type":"object"},"zero-trust-gateway_action":{"description":"Specify the action to perform when the associated traffic, identity, and device posture expressions either absent or evaluate to `true`.","enum":["on","off","allow","block","scan","noscan","safesearch","ytrestricted","isolate","noisolate","override","l4_override","egress","resolve","quarantine","redirect"],"example":"allow","type":"string","x-auditable":true},"zero-trust-gateway_activity-log-settings":{"description":"Specify activity log settings.","nullable":true,"properties":{"enabled":{"description":"Specify whether to log activity.","example":true,"nullable":true,"type":"boolean","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_anti-virus-settings":{"description":"Specify anti-virus settings.","nullable":true,"properties":{"enabled_download_phase":{"$ref":"#/components/schemas/zero-trust-gateway_enabled_download_phase"},"enabled_upload_phase":{"$ref":"#/components/schemas/zero-trust-gateway_enabled_upload_phase"},"fail_closed":{"$ref":"#/components/schemas/zero-trust-gateway_fail_closed"},"notification_settings":{"$ref":"#/components/schemas/zero-trust-gateway_notification_settings"}},"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_api-response-collection":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common"},{"properties":{"result_info":{"$ref":"#/components/schemas/zero-trust-gateway_result_info"}},"type":"object"}],"type":"object"},"zero-trust-gateway_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/zero-trust-gateway_messages"},"messages":{"$ref":"#/components/schemas/zero-trust-gateway_messages"},"success":{"description":"Indicate whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"zero-trust-gateway_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1,"type":"object"},"messages":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_messages"}],"example":[],"type":"object"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Indicate whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"zero-trust-gateway_api-response-single":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common"}],"type":"object"},"zero-trust-gateway_app-types":{"oneOf":[{"$ref":"#/components/schemas/zero-trust-gateway_application"},{"$ref":"#/components/schemas/zero-trust-gateway_application_type"}],"readOnly":true,"type":"object"},"zero-trust-gateway_app-types_components-schemas-name":{"description":"Specify the name of the application or application type.","example":"Facebook","type":"string","x-auditable":true},"zero-trust-gateway_app-types_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/zero-trust-gateway_app-types"},"type":"array"}},"type":"object"}],"type":"object"},"zero-trust-gateway_app_id":{"description":"Identify this application. Only one application per ID.","type":"integer","x-auditable":true},"zero-trust-gateway_app_type_id":{"description":"Identify the type of this application. Multiple applications can share the same type. Refers to the `id` of a returned application type.","type":"integer","x-auditable":true},"zero-trust-gateway_application":{"properties":{"application_type_id":{"$ref":"#/components/schemas/zero-trust-gateway_app_type_id"},"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_timestamp"},"id":{"$ref":"#/components/schemas/zero-trust-gateway_app_id"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_app-types_components-schemas-name"}},"type":"object"},"zero-trust-gateway_application_type":{"properties":{"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_timestamp"},"description":{"description":"Provide a short summary of applications with this type.","example":"Applications used to communicate or collaborate in a business setting.","type":"string"},"id":{"$ref":"#/components/schemas/zero-trust-gateway_app_type_id"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_app-types_components-schemas-name"}},"type":"object"},"zero-trust-gateway_applications_review_status_response":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zero-trust-gateway_applications_review_status_response_content"}},"type":"object"}],"type":"object","x-auditable":true},"zero-trust-gateway_applications_review_status_response_content":{"properties":{"approved_apps":{"$ref":"#/components/schemas/zero-trust-gateway_approved_apps"},"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"in_review_apps":{"$ref":"#/components/schemas/zero-trust-gateway_in_review_apps"},"unapproved_apps":{"$ref":"#/components/schemas/zero-trust-gateway_unapproved_apps"},"updated_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"}},"type":"object"},"zero-trust-gateway_approved_apps":{"description":"Contains the ids of the approved applications.","items":{"type":"integer"},"type":"array","x-stainless-collection-type":"set"},"zero-trust-gateway_audit_ssh_settings_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zero-trust-gateway_settings"}},"type":"object"}],"type":"object"},"zero-trust-gateway_audit_ssh_settings_components-schemas-uuid":{"description":"Identify the seed ID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string","x-auditable":true},"zero-trust-gateway_beta":{"description":"Indicate whether the category is in beta and subject to change.","example":false,"type":"boolean","x-auditable":true},"zero-trust-gateway_binding_status":{"description":"Indicate the read-only deployment status of the certificate on Cloudflare's edge. Gateway TLS interception can use certificates in the 'available' (previously called 'active') state.","enum":["pending_deployment","available","pending_deletion","inactive"],"readOnly":true,"type":"string","x-auditable":true},"zero-trust-gateway_block-page-settings":{"description":"Specify block page layout settings.","nullable":true,"properties":{"background_color":{"description":"Specify the block page background color in `#rrggbb` format when the mode is customized_block_page.","type":"string","x-auditable":true},"enabled":{"description":"Specify whether to enable the custom block page.","example":true,"nullable":true,"type":"boolean","x-auditable":true},"footer_text":{"description":"Specify the block page footer text when the mode is customized_block_page.","example":"--footer--","type":"string","x-auditable":true},"header_text":{"description":"Specify the block page header text when the mode is customized_block_page.","example":"--header--","type":"string","x-auditable":true},"include_context":{"description":"Specify whether to append context to target_uri as query parameters. This applies only when the mode is redirect_uri.","type":"boolean","x-auditable":true},"logo_path":{"description":"Specify the full URL to the logo file when the mode is customized_block_page.","example":"https://logos.com/a.png","type":"string","x-auditable":true},"mailto_address":{"description":"Specify the admin email for users to contact when the mode is customized_block_page.","example":"admin@example.com","type":"string","x-auditable":true},"mailto_subject":{"description":"Specify the subject line for emails created from the block page when the mode is customized_block_page.","example":"Blocked User Inquiry","type":"string","x-auditable":true},"mode":{"default":"","description":"Specify whether to redirect users to a Cloudflare-hosted block page or a customer-provided URI.","enum":["","customized_block_page","redirect_uri"],"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"optional"},"name":{"description":"Specify the block page title when the mode is customized_block_page.","example":"Cloudflare","type":"string","x-auditable":true},"read_only":{"description":"Indicate that this setting was shared via the Orgs API and read only for the current account.","nullable":true,"readOnly":true,"type":"boolean","x-auditable":true},"source_account":{"description":"Indicate the account tag of the account that shared this setting.","nullable":true,"readOnly":true,"type":"string","x-auditable":true},"suppress_footer":{"description":"Specify whether to suppress detailed information at the bottom of the block page when the mode is customized_block_page.","example":false,"type":"boolean"},"target_uri":{"description":"Specify the URI to redirect users to when the mode is redirect_uri.","format":"uri","type":"string","x-auditable":true},"version":{"description":"Indicate the version number of the setting.","example":1,"nullable":true,"readOnly":true,"type":"integer","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_body-scanning-settings":{"description":"Specify the DLP inspection mode.","nullable":true,"properties":{"inspection_mode":{"description":"Specify the inspection mode as either `deep` or `shallow`.","enum":["deep","shallow"],"example":"deep","type":"string","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_browser-isolation-settings":{"description":"Specify Clientless Browser Isolation settings.","nullable":true,"properties":{"non_identity_enabled":{"description":"Specify whether to enable non-identity onramp support for Browser Isolation.","example":true,"type":"boolean","x-auditable":true},"url_browser_isolation_enabled":{"description":"Specify whether to enable Clientless Browser Isolation.","example":true,"type":"boolean","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_categories":{"properties":{"beta":{"$ref":"#/components/schemas/zero-trust-gateway_beta"},"class":{"$ref":"#/components/schemas/zero-trust-gateway_class"},"description":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-description"},"id":{"$ref":"#/components/schemas/zero-trust-gateway_id"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_categories_components-schemas-name"},"subcategories":{"description":"Provide all subcategories for this category.","items":{"$ref":"#/components/schemas/zero-trust-gateway_subcategory"},"type":"array"}},"readOnly":true,"type":"object"},"zero-trust-gateway_categories_components-schemas-name":{"description":"Specify the category name.","example":"Education","type":"string"},"zero-trust-gateway_categories_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/zero-trust-gateway_categories"},"type":"array"}},"type":"object"}],"type":"object"},"zero-trust-gateway_certificate-settings":{"description":"Specify certificate settings for Gateway TLS interception. If unset, the Cloudflare Root CA handles interception.","nullable":true,"properties":{"id":{"description":"Specify the UUID of the certificate used for interception. Ensure the certificate is available at the edge(previously called 'active'). A nil UUID directs Cloudflare to use the Root CA.","example":"d1b364c5-1311-466e-a194-f0e943e0799f","type":"string","x-auditable":true}},"required":["id"],"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_certificates":{"properties":{"binding_status":{"$ref":"#/components/schemas/zero-trust-gateway_binding_status"},"certificate":{"description":"Provide the CA certificate (read-only).","example":"-----BEGIN CERTIFICATE-----\\nMIIDmDCCAoCgAwIBAgIUKTOAZNjcXVZRj4oQt0SHsl1c1vMwDQYJKoZIhvcNAQELBQAwUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjAgFw0yMjExMjIxNjU5NDdaGA8yMTIyMTAyOTE2NTk0N1owUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMRcORwgJFTdcG/2GKI+cFYiOBNDKjCZUXEOvXWY42BkH9wxiMT869CO+enA1w5pIrXow6kCM1sQspHHaVmJUlotEMJxyoLFfA/8Kt1EKFyobOjuZs2SwyVyJ2sStvQuUQEosULZCNGZEqoH5g6zhMPxaxm7ZLrrsDZ9maNGVqo7EWLWHrZ57Q/5MtTrbxQL+eXjUmJ9K3kS+3uEwMdqR6Z3BluU1ivanpPc1CN2GNhdO0/hSY4YkGEnuLsqJyDd3cIiB1MxuCBJ4ZaqOd2viV1WcP3oU3dxVPm4MWyfYIldMWB14FahScxLhWdRnM9YZ/i9IFcLypXsuz7DjrJPtPUCAwEAAaNmMGQwHQYDVR0OBBYEFP5JzLUawNF+c3AXsYTEWHh7z2czMB8GA1UdIwQYMBaAFP5JzLUawNF+c3AXsYTEWHh7z2czMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEBMA0GCSqGSIb3DQEBCwUAA4IBAQBc+Be7NDhpE09y7hLPZGRPl1cSKBw4RI0XIv6rlbSTFs5EebpTGjhx/whNxwEZhB9HZ7111Oa1YlT8xkI9DshB78mjAHCKBAJ76moK8tkG0aqdYpJ4ZcJTVBB7l98Rvgc7zfTii7WemTy72deBbSeiEtXavm4EF0mWjHhQ5Nxpnp00Bqn5g1x8CyTDypgmugnep+xG+iFzNmTdsz7WI9T/7kDMXqB7M/FPWBORyS98OJqNDswCLF8bIZYwUBEe+bRHFomoShMzaC3tvim7WCb16noDkSTMlfKO4pnvKhpcVdSgwcruATV7y+W+Lvmz2OT/Gui4JhqeoTewsxndhDDE\\n-----END CERTIFICATE-----\\n","readOnly":true,"type":"string"},"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"expires_on":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"fingerprint":{"description":"Provide the SHA256 fingerprint of the certificate (read-only).","example":"E9:19:49:AA:DD:D8:1E:C1:20:2A:D8:22:BF:A5:F8:FC:1A:F7:10:9F:C7:5B:69:AB:0:31:91:8B:61:B4:BF:1C","readOnly":true,"type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/zero-trust-gateway_uuid"},"in_use":{"description":"Indicate whether Gateway TLS interception uses this certificate (read-only). You cannot set this value directly. To configure interception, use the Gateway configuration setting named `certificate` (read-only).","readOnly":true,"type":"boolean","x-stainless-terraform-configurability":"computed"},"issuer_org":{"description":"Indicate the organization that issued the certificate (read-only).","example":"Example Inc.","readOnly":true,"type":"string","x-auditable":true},"issuer_raw":{"description":"Provide the entire issuer field of the certificate (read-only).","example":"O=Example Inc.,L=California,ST=San Francisco,C=US","readOnly":true,"type":"string","x-auditable":true},"type":{"$ref":"#/components/schemas/zero-trust-gateway_type"},"updated_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"uploaded_on":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"}},"type":"object"},"zero-trust-gateway_cf_account_id":{"description":"Specify the Cloudflare account ID.","example":"699d98642c564d2e855e9661899b7252","maxLength":32,"type":"string"},"zero-trust-gateway_class":{"description":"Specify which account types can create policies for this category. `blocked` Blocks unconditionally for all accounts. `removalPending` Allows removal from policies but disables addition. `noBlock` Prevents blocking.","enum":["free","premium","blocked","removalPending","noBlock"],"example":"premium","type":"string","x-auditable":true},"zero-trust-gateway_client-default":{"default":false,"description":"Indicate whether this location is the default location.","example":false,"type":"boolean","x-auditable":true},"zero-trust-gateway_components-schemas-description":{"description":"Provide a short summary of domains in the category.","example":"Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions.","type":"string","x-auditable":true},"zero-trust-gateway_components-schemas-identifier":{"description":"Provide the identifier string.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"zero-trust-gateway_components-schemas-name":{"description":"Specify the rule name.","example":"block bad websites","type":"string","x-auditable":true},"zero-trust-gateway_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/zero-trust-gateway_locations"},"type":"array"}},"type":"object"}],"type":"object"},"zero-trust-gateway_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zero-trust-gateway_rules"}},"type":"object"}],"type":"object"},"zero-trust-gateway_components-schemas-uuid":{"example":"ed35569b41ce4d1facfe683550f54086","type":"string","x-auditable":true},"zero-trust-gateway_contents":{"description":"Actual contents of the PAC file","example":"function FindProxyForURL(url, host) { return \"DIRECT\"; }","type":"string","x-auditable":true},"zero-trust-gateway_count":{"description":"Indicate the number of items in the list.","example":20,"readOnly":true,"type":"number"},"zero-trust-gateway_custom-certificate-settings":{"deprecated":true,"description":"Specify custom certificate settings for BYO-PKI. This field is deprecated; use `certificate` instead.","nullable":true,"properties":{"binding_status":{"description":"Indicate the internal certificate status.","example":"pending_deployment","readOnly":true,"type":"string","x-auditable":true},"enabled":{"description":"Specify whether to enable a custom certificate authority for signing Gateway traffic.","example":true,"nullable":true,"type":"boolean","x-auditable":true},"id":{"description":"Specify the UUID of the certificate (ID from MTLS certificate store).","example":"d1b364c5-1311-466e-a194-f0e943e0799f","type":"string","x-auditable":true},"updated_at":{"format":"date-time","readOnly":true,"type":"string"}},"required":["enabled"],"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_deleted_at":{"description":"Indicate the date of deletion, if any.","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"zero-trust-gateway_description":{"description":"Provide the list description.","example":"The serial numbers for administrators","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_description_item":{"description":"Provide the list item description (optional).","example":"Austin office IP","minimum":0,"type":"string"},"zero-trust-gateway_device_posture":{"default":"","description":"Specify the wirefilter expression used for device posture check. The API automatically formats and sanitizes expressions before storing them. To prevent Terraform state drift, use the formatted expression returned in the API response.","example":"any(device_posture.checks.passed[*] in {\"1308749e-fcfb-4ebc-b051-fe022b632644\"})","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_dns-destination-ips-id-read":{"default":"0e4a32c6-6fb8-4858-9296-98f51631e8e6","description":"Indicate the identifier of the pair of IPv4 addresses assigned to this location.","example":"0e4a32c6-6fb8-4858-9296-98f51631e8e6","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_dns-destination-ips-id-write":{"description":"Specify the identifier of the pair of IPv4 addresses assigned to this location. When creating a location, if this field is absent or set to null, the pair of shared IPv4 addresses (0e4a32c6-6fb8-4858-9296-98f51631e8e6) is auto-assigned. When updating a location, if this field is absent or set to null, the pre-assigned pair remains unchanged.","example":"0e4a32c6-6fb8-4858-9296-98f51631e8e6","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_dns_destination_ipv6_block_id":{"description":"Specify the UUID of the IPv6 block brought to the gateway so that this location's IPv6 address is allocated from the Bring Your Own IPv6 (BYOIPv6) block rather than the standard Cloudflare IPv6 block.","example":"b08f7231-d458-495c-98ef-190604c9ee83","nullable":true,"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_dns_resolver_settings_v4":{"properties":{"ip":{"description":"Specify the IPv4 address of the upstream resolver.","example":"2.2.2.2","type":"string","x-auditable":true},"port":{"description":"Specify a port number to use for the upstream resolver. Defaults to 53 if unspecified.","example":5053,"type":"integer","x-auditable":true},"route_through_private_network":{"description":"Indicate whether to connect to this resolver over a private network. Must set when vnet_id set.","example":true,"type":"boolean","x-auditable":true},"vnet_id":{"description":"Specify an optional virtual network for this resolver. Uses default virtual network id if omitted.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","type":"string","x-auditable":true}},"required":["ip"],"type":"object","x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_dns_resolver_settings_v6":{"properties":{"ip":{"description":"Specify the IPv6 address of the upstream resolver.","example":"2001:DB8::","type":"string","x-auditable":true},"port":{"description":"Specify a port number to use for the upstream resolver. Defaults to 53 if unspecified.","example":5053,"type":"integer","x-auditable":true},"route_through_private_network":{"description":"Indicate whether to connect to this resolver over a private network. Must set when vnet_id set.","example":true,"type":"boolean","x-auditable":true},"vnet_id":{"description":"Specify an optional virtual network for this resolver. Uses default virtual network id if omitted.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","type":"string","x-auditable":true}},"required":["ip"],"type":"object","x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_doh_endpoint":{"properties":{"enabled":{"description":"Indicate whether the DOH endpoint is enabled for this location.","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"networks":{"$ref":"#/components/schemas/zero-trust-gateway_ip_networks"},"require_token":{"description":"Specify whether the DOH endpoint requires user identity authentication.","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"}},"type":"object"},"zero-trust-gateway_dot_endpoint":{"properties":{"enabled":{"description":"Indicate whether the DOT endpoint is enabled for this location.","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"networks":{"$ref":"#/components/schemas/zero-trust-gateway_ip_networks"}},"type":"object"},"zero-trust-gateway_ecs-support":{"default":false,"description":"Indicate whether the location must resolve EDNS queries.","example":false,"type":"boolean","x-auditable":true},"zero-trust-gateway_empty_response":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}],"type":"object"},"zero-trust-gateway_enabled":{"default":false,"description":"Specify whether the rule is enabled.","example":true,"type":"boolean","x-auditable":true},"zero-trust-gateway_enabled_download_phase":{"description":"Specify whether to enable anti-virus scanning on downloads.","example":false,"nullable":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_enabled_upload_phase":{"description":"Specify whether to enable anti-virus scanning on uploads.","example":false,"nullable":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_endpoints":{"description":"Configure the destination endpoints for this location.","nullable":true,"properties":{"doh":{"$ref":"#/components/schemas/zero-trust-gateway_doh_endpoint"},"dot":{"$ref":"#/components/schemas/zero-trust-gateway_dot_endpoint"},"ipv4":{"$ref":"#/components/schemas/zero-trust-gateway_ipv4_endpoint"},"ipv6":{"$ref":"#/components/schemas/zero-trust-gateway_ipv6_endpoint"}},"required":["ipv4","ipv6","doh","dot"],"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_expiration":{"description":"Defines the expiration time stamp and default duration of a DNS policy. Takes precedence over the policy's `schedule` configuration, if any. This  does not apply to HTTP or network policies. Settable only for `dns` rules.","nullable":true,"properties":{"duration":{"description":"Defines the default duration a policy active in minutes. Must set in order to use the `reset_expiration` endpoint on this rule.","example":10,"minimum":5,"type":"integer","x-auditable":true},"expired":{"description":"Indicates whether the policy is expired.","example":false,"readOnly":true,"type":"boolean","x-auditable":true},"expires_at":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_timestamp"},{"description":"Show the timestamp when the policy expires and stops applying.  The value must follow RFC 3339 and include a UTC offset.  The system accepts non-zero offsets but converts them to the equivalent UTC+00:00  value and returns timestamps with a trailing Z. Expiration policies ignore client  timezones and expire globally at the specified expires_at time.","example":"2014-01-01T05:20:20Z","type":"string","x-auditable":true}]}},"required":["expires_at"],"type":"object","x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_extended-email-matching":{"description":"Configures user email settings for firewall policies. When you enable this, the system standardizes email addresses in the identity portion of the rule to match extended email variants in firewall policies. When you disable this setting, the system matches email addresses exactly as you provide them. Enable this setting if your email uses `.` or `+` modifiers.","nullable":true,"properties":{"enabled":{"description":"Specify whether to match all variants of user emails (with + or . modifiers) used as criteria in Firewall policies.","example":true,"nullable":true,"type":"boolean","x-auditable":true},"read_only":{"description":"Indicate that this setting was shared via the Orgs API and read only for the current account.","readOnly":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"optional"},"source_account":{"description":"Indicate the account tag of the account that shared this setting.","readOnly":true,"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"optional"},"version":{"description":"Indicate the version number of the setting.","example":1,"readOnly":true,"type":"integer","x-auditable":true,"x-stainless-terraform-configurability":"optional"}},"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_fail_closed":{"description":"Specify whether to block requests for unscannable files.","example":false,"nullable":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_filters":{"description":"Specify the protocol or layer to evaluate the traffic, identity, and device posture expressions. Can only contain a single value.","example":["http"],"items":{"description":"Specify the protocol or layer to use.","enum":["http","dns","l4","egress","dns_resolver"],"example":"http","type":"string","x-auditable":true},"maxItems":1,"minItems":1,"type":"array"},"zero-trust-gateway_fips-settings":{"description":"Specify FIPS settings.","nullable":true,"properties":{"tls":{"description":"Enforce cipher suites and TLS versions compliant with FIPS 140-2.","example":true,"type":"boolean","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_gateway-account-logging-settings":{"properties":{"redact_pii":{"default":false,"description":"Indicate whether to redact personally identifiable information from activity logging (PII fields include source IP, user email, user ID, device ID, URL, referrer, and user agent).","example":true,"type":"boolean","x-auditable":true},"settings_by_rule_type":{"description":"Configure logging settings for each rule type.","properties":{"dns":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_account-log-options"}],"description":"Configure logging settings for DNS firewall."},"http":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_account-log-options"}],"description":"Configure logging settings for HTTP/HTTPS firewall."},"l4":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_account-log-options"}],"description":"Configure logging settings for Network firewall."}},"type":"object"}},"type":"object"},"zero-trust-gateway_gateway-account-logging-settings-response":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zero-trust-gateway_gateway-account-logging-settings"}},"type":"object"}]},"zero-trust-gateway_gateway-account-settings":{"description":"Specify account settings.","properties":{"settings":{"description":"Specify account settings.","properties":{"activity_log":{"$ref":"#/components/schemas/zero-trust-gateway_activity-log-settings"},"antivirus":{"$ref":"#/components/schemas/zero-trust-gateway_anti-virus-settings"},"block_page":{"$ref":"#/components/schemas/zero-trust-gateway_block-page-settings"},"body_scanning":{"$ref":"#/components/schemas/zero-trust-gateway_body-scanning-settings"},"browser_isolation":{"$ref":"#/components/schemas/zero-trust-gateway_browser-isolation-settings"},"certificate":{"$ref":"#/components/schemas/zero-trust-gateway_certificate-settings"},"custom_certificate":{"$ref":"#/components/schemas/zero-trust-gateway_custom-certificate-settings"},"extended_email_matching":{"$ref":"#/components/schemas/zero-trust-gateway_extended-email-matching"},"fips":{"$ref":"#/components/schemas/zero-trust-gateway_fips-settings"},"host_selector":{"$ref":"#/components/schemas/zero-trust-gateway_host-selector-settings"},"inspection":{"$ref":"#/components/schemas/zero-trust-gateway_inspection-settings"},"protocol_detection":{"$ref":"#/components/schemas/zero-trust-gateway_protocol-detection"},"sandbox":{"$ref":"#/components/schemas/zero-trust-gateway_sandbox"},"tls_decrypt":{"$ref":"#/components/schemas/zero-trust-gateway_tls-settings"}},"type":"object"}}},"zero-trust-gateway_gateway_account":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-single"},{"properties":{"result":{"properties":{"gateway_tag":{"$ref":"#/components/schemas/zero-trust-gateway_gateway_tag"},"id":{"$ref":"#/components/schemas/zero-trust-gateway_cf_account_id"},"provider_name":{"$ref":"#/components/schemas/zero-trust-gateway_provider_name"}},"type":"object"}},"type":"object"}],"type":"object"},"zero-trust-gateway_gateway_account_config":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_gateway-account-settings"},{"properties":{"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"updated_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"}},"type":"object"}],"type":"object"}},"type":"object"}],"type":"object"},"zero-trust-gateway_gateway_tag":{"description":"Specify the gateway internal ID.","example":"f174e90afafe4643bbbc4a0ed4fc8415","maxLength":32,"type":"string"},"zero-trust-gateway_generate-cert-request":{"properties":{"validity_period_days":{"description":"Sets the certificate validity period in days (range: 1-10,950 days / ~30 years). Defaults to 1,825 days (5 years). **Important**: This field is only settable during the certificate creation.  Certificates becomes immutable after creation - use the `/activate` and `/deactivate` endpoints to manage certificate lifecycle.","example":1826,"type":"integer","x-auditable":true}},"type":"object"},"zero-trust-gateway_host-selector-settings":{"description":"Enable host selection in egress policies.","nullable":true,"properties":{"enabled":{"description":"Specify whether to enable filtering via hosts for egress policies.","example":false,"nullable":true,"type":"boolean","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_id":{"description":"Identify this category. Only one category per ID.","type":"integer","x-auditable":true},"zero-trust-gateway_identifier":{"example":"699d98642c564d2e855e9661899b7252","type":"string"},"zero-trust-gateway_identity":{"default":"","description":"Specify the wirefilter expression used for identity matching. The API automatically formats and sanitizes expressions before storing them. To prevent Terraform state drift, use the formatted expression returned in the API response.","example":"any(identity.groups.name[*] in {\"finance\"})","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_in_review_apps":{"description":"Contains the ids of the applications in review.","items":{"type":"integer"},"type":"array","x-stainless-collection-type":"set"},"zero-trust-gateway_inspection-settings":{"description":"Define the proxy inspection mode.","nullable":true,"properties":{"mode":{"description":"Define the proxy inspection mode.   1. static: Gateway applies static inspection to HTTP on TCP(80). With TLS decryption on, Gateway inspects HTTPS traffic on TCP(443) and UDP(443).   2. dynamic: Gateway applies protocol detection to inspect HTTP and HTTPS traffic on any port. TLS decryption must remain on to inspect HTTPS traffic.","enum":["static","dynamic"],"example":"static","type":"string","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_ip":{"description":"Defines the automatically generated IPv6 destination IP assigned to this location. Gateway counts all DNS requests sent to this IP as requests under this location.","example":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","readOnly":true,"type":"string","x-auditable":true},"zero-trust-gateway_ip_network":{"properties":{"network":{"description":"Specify the IP address or IP CIDR.","example":"2001:85a3::/64","type":"string","x-auditable":true}},"required":["network"],"type":"object"},"zero-trust-gateway_ip_networks":{"description":"Specify the list of allowed source IP network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.","items":{"$ref":"#/components/schemas/zero-trust-gateway_ip_network"},"nullable":true,"type":"array","x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_ips":{"description":"Specify the list of CIDRs to restrict ingress connections.","items":{"description":"Specify an IPv4 or IPv6 CIDR. Limit IPv6 to a maximum of /109 and IPv4 to a maximum of /25.","example":"192.0.2.1/32","type":"string","x-auditable":true},"type":"array"},"zero-trust-gateway_ipv4_endpoint":{"properties":{"enabled":{"description":"Indicate whether the IPv4 endpoint is enabled for this location.","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"}},"type":"object"},"zero-trust-gateway_ipv4_network":{"properties":{"network":{"description":"Specify the IPv4 address or IPv4 CIDR. Limit IPv4 CIDRs to a maximum of /24.","example":"192.0.2.1/32","type":"string","x-auditable":true}},"required":["network"],"type":"object"},"zero-trust-gateway_ipv4_networks":{"description":"Specify the list of network ranges from which requests at this location originate. The list takes effect only if it is non-empty and the IPv4 endpoint is enabled for this location.","items":{"$ref":"#/components/schemas/zero-trust-gateway_ipv4_network"},"nullable":true,"type":"array","x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_ipv6_endpoint":{"properties":{"enabled":{"description":"Indicate whether the IPV6 endpoint is enabled for this location.","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"networks":{"$ref":"#/components/schemas/zero-trust-gateway_ipv6_networks"}},"type":"object"},"zero-trust-gateway_ipv6_network":{"properties":{"network":{"description":"Specify the IPv6 address or IPv6 CIDR.","example":"2001:85a3::/64","type":"string","x-auditable":true}},"required":["network"],"type":"object"},"zero-trust-gateway_ipv6_networks":{"description":"Specify the list of allowed source IPv6 network ranges for this endpoint. When the list is empty, the endpoint allows all source IPs. The list takes effect only if the endpoint is enabled for this location.","items":{"$ref":"#/components/schemas/zero-trust-gateway_ipv6_network"},"nullable":true,"type":"array","x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_items":{"description":"Provide the list items.","items":{"properties":{"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"description":{"$ref":"#/components/schemas/zero-trust-gateway_description_item"},"value":{"$ref":"#/components/schemas/zero-trust-gateway_value"}},"type":"object"},"type":"array","x-stainless-collection-type":"set"},"zero-trust-gateway_items-input":{"description":"Add items to the list.","items":{"properties":{"description":{"$ref":"#/components/schemas/zero-trust-gateway_description_item"},"value":{"$ref":"#/components/schemas/zero-trust-gateway_value"}},"type":"object"},"type":"array","x-stainless-collection-type":"set"},"zero-trust-gateway_list_item_response_collection":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/zero-trust-gateway_items"},"type":"array"}},"type":"object"},{"properties":{"result_info":{"properties":{"count":{"description":"Shows the total results returned based on your search parameters.","example":1,"type":"number"},"page":{"description":"Show the current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Show the number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Show the total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"},"zero-trust-gateway_list_single_response":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zero-trust-gateway_lists"}},"type":"object"}],"type":"object","x-auditable":true},"zero-trust-gateway_lists":{"properties":{"count":{"$ref":"#/components/schemas/zero-trust-gateway_count"},"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"description":{"$ref":"#/components/schemas/zero-trust-gateway_description"},"id":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-uuid"},"items":{"$ref":"#/components/schemas/zero-trust-gateway_items"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_name"},"type":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-type"},"updated_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"}},"type":"object"},"zero-trust-gateway_locations":{"properties":{"client_default":{"$ref":"#/components/schemas/zero-trust-gateway_client-default"},"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"dns_destination_ips_id":{"$ref":"#/components/schemas/zero-trust-gateway_dns-destination-ips-id-read"},"dns_destination_ipv6_block_id":{"$ref":"#/components/schemas/zero-trust-gateway_dns_destination_ipv6_block_id"},"doh_subdomain":{"$ref":"#/components/schemas/zero-trust-gateway_subdomain"},"ecs_support":{"$ref":"#/components/schemas/zero-trust-gateway_ecs-support"},"endpoints":{"$ref":"#/components/schemas/zero-trust-gateway_endpoints"},"id":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-uuid"},"ip":{"$ref":"#/components/schemas/zero-trust-gateway_ip"},"ipv4_destination":{"description":"Show the primary destination IPv4 address from the pair identified dns_destination_ips_id. This field read-only.","example":"172.64.36.1","readOnly":true,"type":"string"},"ipv4_destination_backup":{"description":"Show the backup destination IPv4 address from the pair identified dns_destination_ips_id. This field read-only.","example":"172.64.36.2","readOnly":true,"type":"string"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-name"},"networks":{"$ref":"#/components/schemas/zero-trust-gateway_ipv4_networks"},"updated_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"}},"type":"object"},"zero-trust-gateway_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"zero-trust-gateway_name":{"description":"Specify the list name.","example":"Admin Serial Numbers","type":"string","x-auditable":true},"zero-trust-gateway_notification_settings":{"description":"Configure the message the user's device shows during an antivirus scan.","nullable":true,"properties":{"enabled":{"description":"Specify whether to enable notifications.","type":"boolean","x-auditable":true},"include_context":{"description":"Specify whether to include context information as query parameters.","type":"boolean","x-auditable":true},"msg":{"description":"Specify the message to show in the notification.","type":"string","x-auditable":true},"support_url":{"description":"Specify a URL that directs users to more information. If unset, the notification opens a block page.","type":"string","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_pacfile":{"properties":{"contents":{"$ref":"#/components/schemas/zero-trust-gateway_contents"},"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"description":{"$ref":"#/components/schemas/zero-trust-gateway_pacfiles_components-schemas-description"},"id":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-uuid"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_pacfiles_components-schemas-name"},"slug":{"$ref":"#/components/schemas/zero-trust-gateway_slug"},"updated_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"url":{"$ref":"#/components/schemas/zero-trust-gateway_url"}},"type":"object"},"zero-trust-gateway_pacfiles_components-schemas-description":{"description":"Detailed description of the PAC file.","example":"PAC file for Devops team","type":"string","x-auditable":true},"zero-trust-gateway_pacfiles_components-schemas-name":{"description":"Name of the PAC file.","example":"Devops team","type":"string","x-auditable":true},"zero-trust-gateway_pacfiles_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-collection"},{"properties":{"result":{"items":{"properties":{"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"description":{"$ref":"#/components/schemas/zero-trust-gateway_pacfiles_components-schemas-description"},"id":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-uuid"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_pacfiles_components-schemas-name"},"slug":{"$ref":"#/components/schemas/zero-trust-gateway_slug"},"updated_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"url":{"$ref":"#/components/schemas/zero-trust-gateway_url"}},"type":"object"},"type":"array"}},"type":"object"}],"type":"object"},"zero-trust-gateway_pacfiles_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zero-trust-gateway_pacfile"}},"type":"object"}],"type":"object"},"zero-trust-gateway_precedence":{"description":"Set the order of your rules. Lower values indicate higher precedence. At each processing phase, evaluate applicable rules in ascending order of this value. Refer to [Order of enforcement](http://developers.cloudflare.com/learning-paths/secure-internet-traffic/understand-policies/order-of-enforcement/#manage-precedence-with-terraform) to manage precedence via Terraform.","type":"integer","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_protocol-detection":{"description":"Specify whether to detect protocols from the initial bytes of client traffic.","nullable":true,"properties":{"enabled":{"description":"Specify whether to detect protocols from the initial bytes of client traffic.","example":true,"nullable":true,"type":"boolean","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_provider_name":{"description":"Specify the provider name (usually Cloudflare).","example":"Cloudflare","type":"string"},"zero-trust-gateway_proxy-endpoint-identity":{"properties":{"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"id":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-uuid"},"kind":{"description":"The proxy endpoint kind","enum":["identity"],"example":"identity","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name"},"subdomain":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-subdomain"},"updated_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"}},"required":["kind","name"],"type":"object"},"zero-trust-gateway_proxy-endpoint-identity-create":{"properties":{"kind":{"description":"The proxy endpoint kind","enum":["identity"],"example":"identity","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name"}},"required":["kind","name"],"type":"object"},"zero-trust-gateway_proxy-endpoint-ip":{"properties":{"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"id":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-uuid"},"ips":{"$ref":"#/components/schemas/zero-trust-gateway_ips"},"kind":{"description":"The proxy endpoint kind","enum":["ip"],"example":"ip","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name"},"subdomain":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-subdomain"},"updated_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"}},"required":["name","ips"],"type":"object"},"zero-trust-gateway_proxy-endpoint-ip-create":{"properties":{"kind":{"description":"The proxy endpoint kind","enum":["ip"],"example":"ip","type":"string","x-auditable":true},"name":{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name"}},"required":["name","ips"],"type":"object"},"zero-trust-gateway_proxy-endpoints":{"discriminator":{"mapping":{"identity":"#/components/schemas/zero-trust-gateway_proxy-endpoint-identity","ip":"#/components/schemas/zero-trust-gateway_proxy-endpoint-ip"},"propertyName":"kind"},"oneOf":[{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoint-ip"},{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoint-identity"}]},"zero-trust-gateway_proxy-endpoints_components-schemas-name":{"description":"Specify the name of the proxy endpoint.","example":"Devops team","type":"string","x-auditable":true},"zero-trust-gateway_proxy-endpoints_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints"},"type":"array"}},"type":"object"}],"type":"object"},"zero-trust-gateway_proxy-endpoints_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints"}},"type":"object"}],"type":"object"},"zero-trust-gateway_public_key":{"description":"Provide the Base64-encoded HPKE public key that encrypts SSH session logs. See https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access/#enable-ssh-command-logging.","example":"1pyl6I1tL7xfJuFYVzXlUW8uXXlpxegHXBzGCBKaSFA=","type":"string","x-auditable":true},"zero-trust-gateway_read_only":{"description":"Indicate that this rule is shared via the Orgs API and read only.","readOnly":true,"type":"boolean","x-auditable":true},"zero-trust-gateway_read_only_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"zero-trust-gateway_response_collection":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/zero-trust-gateway_certificates"},"type":"array"}},"type":"object"}],"type":"object"},"zero-trust-gateway_result_info":{"properties":{"count":{"description":"Indicate the total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Indicate the current page within a paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Indicate the number of results per page.","example":20,"type":"number"},"total_count":{"description":"Indicate the total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"},"zero-trust-gateway_rule-settings":{"description":"Defines settings for this rule. Settings apply only to specific rule types and must use compatible selectors. If Terraform detects drift, confirm the setting supports your rule type and check whether the API modifies the value. Use API-returned values in your configuration to prevent drift.","properties":{"add_headers":{"additionalProperties":{"items":{"type":"string"},"type":"array","x-auditable":true},"description":"Add custom headers to allowed requests as key-value pairs. Use header names as keys that map to arrays of header values. Settable only for `http` rules with the action set to `allow`.","example":{"My-Next-Header":["foo","bar"],"X-Custom-Header-Name":["somecustomvalue"]},"nullable":true,"type":"object","x-stainless-terraform-configurability":"optional"},"allow_child_bypass":{"description":"Set to enable MSP children to bypass this rule. Only parent MSP accounts can set this. this rule. Settable for all types of rules.","example":false,"nullable":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"audit_ssh":{"description":"Define the settings for the Audit SSH action. Settable only for `l4` rules with `audit_ssh` action.","nullable":true,"properties":{"command_logging":{"description":"Enable SSH command logging.","example":false,"type":"boolean","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"biso_admin_controls":{"description":"Configure browser isolation behavior. Settable only for `http` rules with the action set to `isolate`.","properties":{"copy":{"description":"Configure copy behavior. If set to remote_only, users cannot copy isolated content from the remote browser to the local clipboard. If this field is absent, copying remains enabled. Applies only when version == \"v2\".","enum":["enabled","disabled","remote_only"],"example":"remote_only","type":"string","x-auditable":true},"dcp":{"description":"Set to false to enable copy-pasting. Only applies when `version == \"v1\"`.","type":"boolean","x-auditable":true},"dd":{"description":"Set to false to enable downloading. Only applies when `version == \"v1\"`.","type":"boolean","x-auditable":true},"dk":{"description":"Set to false to enable keyboard usage. Only applies when `version == \"v1\"`.","type":"boolean","x-auditable":true},"download":{"description":"Configure download behavior. When set to remote_only, users can view downloads but cannot save them. Applies only when version == \"v2\".","enum":["enabled","disabled","remote_only"],"example":"enabled","type":"string","x-auditable":true},"dp":{"description":"Set to false to enable printing. Only applies when `version == \"v1\"`.","example":false,"type":"boolean","x-auditable":true},"du":{"description":"Set to false to enable uploading. Only applies when `version == \"v1\"`.","type":"boolean","x-auditable":true},"keyboard":{"description":"Configure keyboard usage behavior. If this field is absent, keyboard usage remains enabled. Applies only when version == \"v2\".","enum":["enabled","disabled"],"example":"enabled","type":"string","x-auditable":true},"paste":{"description":"Configure paste behavior. If set to remote_only, users cannot paste content from the local clipboard into isolated pages. If this field is absent, pasting remains enabled. Applies only when version == \"v2\".","enum":["enabled","disabled","remote_only"],"example":"enabled","type":"string","x-auditable":true},"printing":{"description":"Configure print behavior. Default, Printing is enabled. Applies only when version == \"v2\".","enum":["enabled","disabled"],"example":"enabled","type":"string","x-auditable":true},"upload":{"description":"Configure upload behavior. If this field is absent, uploading remains enabled. Applies only when version == \"v2\".","enum":["enabled","disabled"],"example":"enabled","type":"string","x-auditable":true},"version":{"default":"v1","description":"Indicate which version of the browser isolation controls should apply.","enum":["v1","v2"],"type":"string","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"block_page":{"description":"Configure custom block page settings. If missing or null, use the account settings. Settable only for `http` rules with the action set to `block`.","nullable":true,"properties":{"include_context":{"description":"Specify whether to pass the context information as query parameters.","type":"boolean","x-auditable":true},"target_uri":{"description":"Specify the URI to which the user is redirected.","format":"uri","type":"string","x-auditable":true}},"required":["target_uri"],"type":"object","x-stainless-terraform-configurability":"optional"},"block_page_enabled":{"description":"Enable the custom block page. Settable only for `dns` rules with action `block`.","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"block_reason":{"description":"Explain why the rule blocks the request. The custom block page shows this text (if enabled). Settable only for `dns`, `l4`, and `http` rules when the action set to `block`.","example":"This website is a security risk","nullable":true,"type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"bypass_parent_rule":{"description":"Set to enable MSP accounts to bypass their parent's rules. Only MSP child accounts can set this. Settable for all types of rules.","example":false,"nullable":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"optional"},"check_session":{"description":"Configure session check behavior. Settable only for `l4` and `http` rules with the action set to `allow`.","nullable":true,"properties":{"duration":{"description":"Sets the required session freshness threshold. The API returns a normalized version of this value.","example":"300s","type":"string","x-auditable":true},"enforce":{"description":"Enable session enforcement.","example":true,"type":"boolean","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"dns_resolvers":{"description":"Configure custom resolvers to route queries that match the resolver policy. Unused with 'resolve_dns_through_cloudflare' or 'resolve_dns_internally' settings. DNS queries get routed to the address closest to their origin. Only valid when a rule's action set to 'resolve'. Settable only for `dns_resolver` rules.","nullable":true,"properties":{"ipv4":{"items":{"$ref":"#/components/schemas/zero-trust-gateway_dns_resolver_settings_v4"},"type":"array"},"ipv6":{"items":{"$ref":"#/components/schemas/zero-trust-gateway_dns_resolver_settings_v6"},"type":"array"}},"type":"object","x-stainless-terraform-configurability":"optional"},"egress":{"description":"Configure how Gateway Proxy traffic egresses. You can enable this setting for rules with Egress actions and filters, or omit it to indicate local egress via WARP IPs. Settable only for `egress` rules.","nullable":true,"properties":{"ipv4":{"description":"Specify the IPv4 address to use for egress.","example":"192.0.2.2","type":"string","x-auditable":true},"ipv4_fallback":{"description":"Specify the fallback IPv4 address to use for egress when the primary IPv4 fails. Set '0.0.0.0' to indicate local egress via WARP IPs.","example":"192.0.2.3","type":"string","x-auditable":true},"ipv6":{"description":"Specify the IPv6 range to use for egress.","example":"2001:DB8::/64","type":"string","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"ignore_cname_category_matches":{"description":"Ignore category matches at CNAME domains in a response. When off, evaluate categories in this rule against all CNAME domain categories in the response. Settable only for `dns` and `dns_resolver` rules.","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"insecure_disable_dnssec_validation":{"description":"Specify whether to disable DNSSEC validation (for Allow actions) [INSECURE]. Settable only for `dns` rules.","example":false,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"ip_categories":{"description":"Enable IPs in DNS resolver category blocks. The system blocks only domain name categories unless you enable this setting. Settable only for `dns` and `dns_resolver` rules.","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"ip_indicator_feeds":{"description":"Indicates whether to include IPs in DNS resolver indicator feed blocks. Default, indicator feeds block only domain names. Settable only for `dns` and `dns_resolver` rules.","example":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"l4override":{"description":"Send matching traffic to the supplied destination IP address and port. Settable only for `l4` rules with the action set to `l4_override`.","nullable":true,"properties":{"ip":{"description":"Defines the IPv4 or IPv6 address.","example":"1.1.1.1","type":"string","x-auditable":true},"port":{"description":"Defines a port number to use for TCP/UDP overrides.","type":"integer","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"notification_settings":{"description":"Configure a notification to display on the user's device when this rule matched. Settable for all types of rules with the action set to `block`.","nullable":true,"properties":{"enabled":{"description":"Enable notification.","type":"boolean","x-auditable":true},"include_context":{"description":"Indicates whether to pass the context information as query parameters.","type":"boolean","x-auditable":true},"msg":{"description":"Customize the message shown in the notification.","type":"string","x-auditable":true},"support_url":{"description":"Defines an optional URL to direct users to additional information. If unset, the notification opens a block page.","type":"string","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"override_host":{"description":"Defines a hostname for override, for the matching DNS queries. Settable only for `dns` rules with the action set to `override`.","example":"example.com","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"override_ips":{"description":"Defines a an IP or set of IPs for overriding matched DNS queries. Settable only for `dns` rules with the action set to `override`.","example":["1.1.1.1","2.2.2.2"],"items":{"description":"Defines the IPv4 or IPv6 address.","example":"1.1.1.1","type":"string","x-auditable":true},"nullable":true,"type":"array","x-stainless-terraform-configurability":"computed_optional"},"payload_log":{"description":"Configure DLP payload logging. Settable only for `http` rules.","nullable":true,"properties":{"enabled":{"description":"Enable DLP payload logging for this rule.","example":true,"type":"boolean","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"quarantine":{"description":"Configure settings that apply to quarantine rules. Settable only for `http` rules.","nullable":true,"properties":{"file_types":{"description":"Specify the types of files to sandbox.","items":{"enum":["exe","pdf","doc","docm","docx","rtf","ppt","pptx","xls","xlsm","xlsx","zip","rar"],"type":"string","x-auditable":true},"type":"array"}},"type":"object","x-stainless-terraform-configurability":"optional"},"redirect":{"description":"Apply settings to redirect rules. Settable only for `http` rules with the action set to `redirect`.","nullable":true,"properties":{"include_context":{"description":"Specify whether to pass the context information as query parameters.","type":"boolean","x-auditable":true},"preserve_path_and_query":{"description":"Specify whether to append the path and query parameters from the original request to target_uri.","type":"boolean","x-auditable":true},"target_uri":{"description":"Specify the URI to which the user is redirected.","format":"uri","type":"string","x-auditable":true}},"required":["target_uri"],"type":"object","x-stainless-terraform-configurability":"optional"},"resolve_dns_internally":{"description":"Configure to forward the query to the internal DNS service, passing the specified 'view_id' as input. Not used when 'dns_resolvers' is specified or 'resolve_dns_through_cloudflare' is set. Only valid when a rule's action set to 'resolve'. Settable only for `dns_resolver` rules.","nullable":true,"properties":{"fallback":{"description":"Specify the fallback behavior to apply when the internal DNS response code differs from 'NOERROR' or when the response data contains only CNAME records for 'A' or 'AAAA' queries.","enum":["none","public_dns"],"type":"string","x-auditable":true},"view_id":{"description":"Specify the internal DNS view identifier to pass to the internal DNS service.","type":"string","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"resolve_dns_through_cloudflare":{"description":"Enable to send queries that match the policy to Cloudflare's default 1.1.1.1 DNS resolver. Cannot set when 'dns_resolvers' specified or 'resolve_dns_internally' is set. Only valid when a rule's action set to 'resolve'. Settable only for `dns_resolver` rules.","example":true,"nullable":true,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"untrusted_cert":{"description":"Configure behavior when an upstream certificate is invalid or an SSL error occurs. Settable only for `http` rules with the action set to `allow`.","nullable":true,"properties":{"action":{"description":"Defines the action performed when an untrusted certificate seen. The default action an error with HTTP code 526.","enum":["pass_through","block","error"],"example":"error","type":"string","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"}},"type":"object","x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_rules":{"properties":{"action":{"$ref":"#/components/schemas/zero-trust-gateway_action"},"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"deleted_at":{"$ref":"#/components/schemas/zero-trust-gateway_deleted_at"},"description":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-description"},"device_posture":{"$ref":"#/components/schemas/zero-trust-gateway_device_posture"},"enabled":{"$ref":"#/components/schemas/zero-trust-gateway_enabled"},"expiration":{"$ref":"#/components/schemas/zero-trust-gateway_expiration"},"filters":{"$ref":"#/components/schemas/zero-trust-gateway_filters"},"id":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-uuid"},"identity":{"$ref":"#/components/schemas/zero-trust-gateway_identity"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/zero-trust-gateway_precedence"},"read_only":{"$ref":"#/components/schemas/zero-trust-gateway_read_only"},"rule_settings":{"$ref":"#/components/schemas/zero-trust-gateway_rule-settings"},"schedule":{"$ref":"#/components/schemas/zero-trust-gateway_schedule"},"sharable":{"$ref":"#/components/schemas/zero-trust-gateway_sharable"},"source_account":{"$ref":"#/components/schemas/zero-trust-gateway_source_account"},"traffic":{"$ref":"#/components/schemas/zero-trust-gateway_traffic"},"updated_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"version":{"$ref":"#/components/schemas/zero-trust-gateway_version"},"warning_status":{"$ref":"#/components/schemas/zero-trust-gateway_warning_status"}},"required":["name","precedence","enabled","action","traffic","filters"],"type":"object"},"zero-trust-gateway_rules_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/zero-trust-gateway_rules"},"type":"array"}},"type":"object"}],"type":"object"},"zero-trust-gateway_sandbox":{"description":"Specify whether to enable the sandbox.","nullable":true,"properties":{"enabled":{"description":"Specify whether to enable the sandbox.","example":true,"nullable":true,"type":"boolean","x-auditable":true},"fallback_action":{"description":"Specify the action to take when the system cannot scan the file.","enum":["allow","block"],"type":"string","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_schedule":{"description":"Defines the schedule for activating DNS policies. Settable only for `dns` and `dns_resolver` rules.","nullable":true,"properties":{"fri":{"description":"Specify the time intervals when the rule is active on Fridays, in the increasing order from 00:00-24:00.  If this parameter omitted, the rule is deactivated on Fridays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used.","example":"08:00-12:30,13:30-17:00","type":"string","x-auditable":true},"mon":{"description":"Specify the time intervals when the rule is active on Mondays, in the increasing order from 00:00-24:00(capped at maximum of 6 time splits). If this parameter omitted, the rule is deactivated on Mondays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used.","example":"08:00-12:30,13:30-17:00","type":"string","x-auditable":true},"sat":{"description":"Specify the time intervals when the rule is active on Saturdays, in the increasing order from 00:00-24:00.  If this parameter omitted, the rule is deactivated on Saturdays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used.","example":"08:00-12:30,13:30-17:00","type":"string","x-auditable":true},"sun":{"description":"Specify the time intervals when the rule is active on Sundays, in the increasing order from 00:00-24:00. If this parameter omitted, the rule is deactivated on Sundays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used.","example":"08:00-12:30,13:30-17:00","type":"string","x-auditable":true},"thu":{"description":"Specify the time intervals when the rule is active on Thursdays, in the increasing order from 00:00-24:00. If this parameter omitted, the rule is deactivated on Thursdays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used.","example":"08:00-12:30,13:30-17:00","type":"string","x-auditable":true},"time_zone":{"description":"Specify the time zone for rule evaluation. When a [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) is provided, Gateway always uses the current time for that time zone. When this parameter is omitted, Gateway uses the time zone determined from the user's IP address. Colo time zone is used when the user's IP address does not resolve to a location.","example":"America/New York","type":"string","x-auditable":true},"tue":{"description":"Specify the time intervals when the rule is active on Tuesdays, in the increasing order from 00:00-24:00. If this parameter omitted, the rule is deactivated on Tuesdays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used.","example":"08:00-12:30,13:30-17:00","type":"string","x-auditable":true},"wed":{"description":"Specify the time intervals when the rule is active on Wednesdays, in the increasing order from 00:00-24:00. If this parameter omitted, the rule is deactivated on Wednesdays. API returns a formatted version of this string, which may cause Terraform drift if a unformatted value is used.","example":"08:00-12:30,13:30-17:00","type":"string","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_schemas-description":{"description":"Specify the rule description.","example":"Block bad websites based on their host name.","type":"string","x-auditable":true},"zero-trust-gateway_schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252","type":"string","x-auditable":true},"zero-trust-gateway_schemas-name":{"description":"Specify the location name.","example":"Austin Office Location","type":"string","x-auditable":true},"zero-trust-gateway_schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/zero-trust-gateway_lists"},"type":"array"}},"type":"object"}],"type":"object"},"zero-trust-gateway_schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zero-trust-gateway_locations"}},"type":"object"}],"type":"object"},"zero-trust-gateway_schemas-subdomain":{"description":"Specify the subdomain to use as the destination in the proxy client.","example":"oli3n9zkz5.proxy.cloudflare-gateway.com","readOnly":true,"type":"string","x-auditable":true},"zero-trust-gateway_schemas-type":{"description":"Specify the list type.","enum":["SERIAL","URL","DOMAIN","EMAIL","IP"],"example":"SERIAL","type":"string","x-auditable":true},"zero-trust-gateway_schemas-uuid":{"description":"Identify the API resource with a UUID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string","x-auditable":true},"zero-trust-gateway_settings":{"properties":{"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"public_key":{"$ref":"#/components/schemas/zero-trust-gateway_public_key"},"seed_id":{"$ref":"#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-uuid"},"updated_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"}},"type":"object"},"zero-trust-gateway_sharable":{"description":"Indicate that this rule is sharable via the Orgs API.","readOnly":true,"type":"boolean","x-auditable":true},"zero-trust-gateway_single_response":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zero-trust-gateway_certificates"}},"type":"object"}],"type":"object"},"zero-trust-gateway_single_response_with_list_items":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_api-response-single"},{"properties":{"result":{"properties":{"created_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"},"description":{"$ref":"#/components/schemas/zero-trust-gateway_description"},"id":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-uuid"},"items":{"$ref":"#/components/schemas/zero-trust-gateway_items"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_name"},"type":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-type"},"updated_at":{"$ref":"#/components/schemas/zero-trust-gateway_read_only_timestamp"}},"type":"object"}},"type":"object"}],"type":"object"},"zero-trust-gateway_slug":{"description":"URL-friendly version of the PAC file name.","example":"pac_devops","type":"string","x-auditable":true},"zero-trust-gateway_source_account":{"description":"Provide the account tag of the account that created the rule.","readOnly":true,"type":"string","x-auditable":true},"zero-trust-gateway_subcategory":{"properties":{"beta":{"$ref":"#/components/schemas/zero-trust-gateway_beta"},"class":{"$ref":"#/components/schemas/zero-trust-gateway_class"},"description":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-description"},"id":{"$ref":"#/components/schemas/zero-trust-gateway_id"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_categories_components-schemas-name"}},"type":"object"},"zero-trust-gateway_subdomain":{"description":"Specify the DNS over HTTPS domain that receives DNS requests. Gateway automatically generates this value.","example":"oli3n9zkz5","readOnly":true,"type":"string","x-auditable":true},"zero-trust-gateway_timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string"},"zero-trust-gateway_tls-settings":{"description":"Specify whether to inspect encrypted HTTP traffic.","nullable":true,"properties":{"enabled":{"description":"Specify whether to inspect encrypted HTTP traffic.","example":true,"type":"boolean","x-auditable":true}},"type":"object","x-stainless-terraform-configurability":"optional"},"zero-trust-gateway_traffic":{"default":"","description":"Specify the wirefilter expression used for traffic matching. The API automatically formats and sanitizes expressions before storing them. To prevent Terraform state drift, use the formatted expression returned in the API response.","example":"http.request.uri matches \".*a/partial/uri.*\" and http.request.host in $01302951-49f9-47c9-a400-0297e60b6a10","type":"string","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"},"zero-trust-gateway_type":{"description":"Indicate the read-only certificate type, BYO-PKI (custom) or Gateway-managed.","enum":["custom","gateway_managed"],"example":"gateway_managed","readOnly":true,"type":"string","x-auditable":true},"zero-trust-gateway_unapproved_apps":{"description":"Contains the ids of the unapproved applications.","items":{"type":"integer"},"type":"array","x-stainless-collection-type":"set"},"zero-trust-gateway_url":{"description":"Unique URL to download the PAC file.","example":"https://pac.cloudflare-gateway.com/699d98642c564d2e855e9661899b7252/pac_devops","readOnly":true,"type":"string","x-auditable":true},"zero-trust-gateway_uuid":{"description":"Identify the certificate with a UUID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string","x-auditable":true},"zero-trust-gateway_value":{"description":"Specify the item value.","example":"8GE8721REF","type":"string","x-auditable":true},"zero-trust-gateway_version":{"description":"Indicate the version number of the rule(read-only).","example":1,"readOnly":true,"type":"integer","x-auditable":true},"zero-trust-gateway_warning_status":{"description":"Indicate a warning for a misconfigured rule, if any.","nullable":true,"readOnly":true,"type":"string"},"zone-activation_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/zone-activation_messages"},"messages":{"$ref":"#/components/schemas/zone-activation_messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"zone-activation_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/zone-activation_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/zone-activation_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"zone-activation_api-response-single":{"allOf":[{"$ref":"#/components/schemas/zone-activation_api-response-common"}],"type":"object"},"zone-activation_identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"zone-activation_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"zone-analytics-api_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/zone-analytics-api_messages"},"messages":{"$ref":"#/components/schemas/zone-analytics-api_messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"zone-analytics-api_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/zone-analytics-api_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/zone-analytics-api_messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"zone-analytics-api_api-response-single":{"allOf":[{"$ref":"#/components/schemas/zone-analytics-api_api-response-common"},{"properties":{"result":{"anyOf":[{"nullable":true,"type":"object"},{"nullable":true,"type":"string"}]}}}],"type":"object"},"zone-analytics-api_bandwidth":{"description":"Breakdown of totals for bandwidth in the form of bytes.","properties":{"all":{"description":"The total number of bytes served within the time frame.","type":"integer"},"cached":{"description":"The number of bytes that were cached (and served) by Cloudflare.","type":"integer"},"content_type":{"description":"A variable list of key/value pairs where the key represents the type of content served, and the value is the number in bytes served.","example":{"css":237421,"gif":1234242,"html":1231290,"javascript":123245,"jpeg":784278},"type":"object"},"country":{"description":"A variable list of key/value pairs where the key is a two-digit country code and the value is the number of bytes served to that country.","example":{"AG":2342483,"GI":984753,"US":123145433},"type":"object"},"ssl":{"description":"A break down of bytes served over HTTPS.","properties":{"encrypted":{"description":"The number of bytes served over HTTPS.","type":"integer"},"unencrypted":{"description":"The number of bytes served over HTTP.","type":"integer"}},"type":"object"},"ssl_protocols":{"description":"A breakdown of requests by their SSL protocol.","properties":{"TLSv1":{"description":"The number of requests served over TLS v1.0.","type":"integer"},"TLSv1.1":{"description":"The number of requests served over TLS v1.1.","type":"integer"},"TLSv1.2":{"description":"The number of requests served over TLS v1.2.","type":"integer"},"TLSv1.3":{"description":"The number of requests served over TLS v1.3.","type":"integer"},"none":{"description":"The number of requests served over HTTP.","type":"integer"}},"type":"object"},"uncached":{"description":"The number of bytes that were fetched and served from the origin server.","type":"integer"}},"type":"object"},"zone-analytics-api_bandwidth_by_colo":{"description":"Breakdown of totals for bandwidth in the form of bytes.","properties":{"all":{"description":"The total number of bytes served within the time frame.","type":"integer"},"cached":{"description":"The number of bytes that were cached (and served) by Cloudflare.","type":"integer"},"uncached":{"description":"The number of bytes that were fetched and served from the origin server.","type":"integer"}},"type":"object"},"zone-analytics-api_colo_response":{"allOf":[{"$ref":"#/components/schemas/zone-analytics-api_api-response-single"},{"properties":{"query":{"$ref":"#/components/schemas/zone-analytics-api_query_response"},"result":{"$ref":"#/components/schemas/zone-analytics-api_datacenters"}}}]},"zone-analytics-api_dashboard":{"description":"Totals and timeseries data.","properties":{"timeseries":{"$ref":"#/components/schemas/zone-analytics-api_timeseries"},"totals":{"$ref":"#/components/schemas/zone-analytics-api_totals"}},"title":"Dashboard response","type":"object"},"zone-analytics-api_dashboard_response":{"allOf":[{"$ref":"#/components/schemas/zone-analytics-api_api-response-single"},{"properties":{"query":{"$ref":"#/components/schemas/zone-analytics-api_query_response"},"result":{"$ref":"#/components/schemas/zone-analytics-api_dashboard"}}}]},"zone-analytics-api_datacenters":{"description":"A breakdown of all dashboard analytics data by co-locations. This is limited to Enterprise zones only.","items":{"properties":{"colo_id":{"description":"The airport code identifer for the co-location.","example":"SFO","type":"string"},"timeseries":{"$ref":"#/components/schemas/zone-analytics-api_timeseries_by_colo"},"totals":{"$ref":"#/components/schemas/zone-analytics-api_totals_by_colo"}},"type":"object"},"title":"Analytics data by datacenter","type":"array"},"zone-analytics-api_identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"zone-analytics-api_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"zone-analytics-api_pageviews":{"description":"Breakdown of totals for pageviews.","properties":{"all":{"description":"The total number of pageviews served within the time range.","type":"integer"},"search_engine":{"description":"A variable list of key/value pairs representing the search engine and number of hits.","example":{"baidubot":1345,"bingbot":5372,"googlebot":35272,"pingdom":13435},"type":"object"}},"type":"object"},"zone-analytics-api_query_response":{"description":"The exact parameters/timestamps the analytics service used to return data.","properties":{"since":{"$ref":"#/components/schemas/zone-analytics-api_since"},"time_delta":{"description":"The amount of time (in minutes) that each data point in the timeseries represents. The granularity of the time-series returned (e.g. each bucket in the time series representing 1-minute vs 1-day) is calculated by the API based on the time-range provided to the API.","type":"integer"},"until":{"$ref":"#/components/schemas/zone-analytics-api_until"}},"readOnly":true,"type":"object"},"zone-analytics-api_requests":{"description":"Breakdown of totals for requests.","properties":{"all":{"description":"Total number of requests served.","type":"integer"},"cached":{"description":"Total number of cached requests served.","type":"integer"},"content_type":{"description":"A variable list of key/value pairs where the key represents the type of content served, and the value is the number of requests.","example":{"css":15343,"gif":23178,"html":1234213,"javascript":318236,"jpeg":1982048},"type":"object"},"country":{"description":"A variable list of key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country.","example":{"AG":37298,"GI":293846,"US":4181364},"type":"object"},"http_status":{"additionalProperties":true,"description":"Key/value pairs where the key is a HTTP status code and the value is the number of requests served with that code.","example":{"200":13496983,"301":283,"400":187936,"402":1828,"404":1293},"type":"object"},"ssl":{"description":"A break down of requests served over HTTPS.","properties":{"encrypted":{"description":"The number of requests served over HTTPS.","type":"integer"},"unencrypted":{"description":"The number of requests served over HTTP.","type":"integer"}},"type":"object"},"ssl_protocols":{"description":"A breakdown of requests by their SSL protocol.","properties":{"TLSv1":{"description":"The number of requests served over TLS v1.0.","type":"integer"},"TLSv1.1":{"description":"The number of requests served over TLS v1.1.","type":"integer"},"TLSv1.2":{"description":"The number of requests served over TLS v1.2.","type":"integer"},"TLSv1.3":{"description":"The number of requests served over TLS v1.3.","type":"integer"},"none":{"description":"The number of requests served over HTTP.","type":"integer"}},"type":"object"},"uncached":{"description":"Total number of requests served from the origin.","type":"integer"}},"type":"object"},"zone-analytics-api_requests_by_colo":{"description":"Breakdown of totals for requests.","properties":{"all":{"description":"Total number of requests served.","type":"integer"},"cached":{"description":"Total number of cached requests served.","type":"integer"},"country":{"additionalProperties":true,"description":"Key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country.","example":{"AG":37298,"GI":293846,"US":4181364},"type":"object"},"http_status":{"description":"A variable list of key/value pairs where the key is a HTTP status code and the value is the number of requests with that code served.","example":{"200":13496983,"301":283,"400":187936,"402":1828,"404":1293},"type":"object"},"uncached":{"description":"Total number of requests served from the origin.","type":"integer"}},"type":"object"},"zone-analytics-api_since":{"anyOf":[{"type":"string"},{"type":"integer"}],"default":-10080,"description":"The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.\n\nRanges that the Cloudflare web application provides will provide the following period length for each point:\n- Last 60 minutes (from -59 to -1): 1 minute resolution\n- Last 7 hours (from -419 to -60): 15 minutes resolution\n- Last 15 hours (from -899 to -420): 30 minutes resolution\n- Last 72 hours (from -4320 to -900): 1 hour resolution\n- Older than 3 days (-525600 to -4320): 1 day resolution.","example":"2015-01-01T12:23:00Z"},"zone-analytics-api_threats":{"description":"Breakdown of totals for threats.","properties":{"all":{"description":"The total number of identifiable threats received over the time frame.","type":"integer"},"country":{"description":"A list of key/value pairs where the key is a two-digit country code and the value is the number of malicious requests received from that country.","example":{"AU":91,"CN":523423,"US":123},"type":"object"},"type":{"description":"The list of key/value pairs where the key is a threat category and the value is the number of requests.","example":{"hot.ban.unknown":5324,"macro.chl.captchaErr":1341,"macro.chl.jschlErr":5323,"user.ban.ip":123},"type":"object"}},"type":"object"},"zone-analytics-api_timeseries":{"description":"Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters.","items":{"properties":{"bandwidth":{"$ref":"#/components/schemas/zone-analytics-api_bandwidth"},"pageviews":{"$ref":"#/components/schemas/zone-analytics-api_pageviews"},"requests":{"$ref":"#/components/schemas/zone-analytics-api_requests"},"since":{"$ref":"#/components/schemas/zone-analytics-api_since"},"threats":{"$ref":"#/components/schemas/zone-analytics-api_threats"},"uniques":{"$ref":"#/components/schemas/zone-analytics-api_uniques"},"until":{"$ref":"#/components/schemas/zone-analytics-api_until"}},"type":"object"},"type":"array"},"zone-analytics-api_timeseries_by_colo":{"description":"Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters.","items":{"properties":{"bandwidth":{"$ref":"#/components/schemas/zone-analytics-api_bandwidth_by_colo"},"requests":{"$ref":"#/components/schemas/zone-analytics-api_requests_by_colo"},"since":{"$ref":"#/components/schemas/zone-analytics-api_since"},"threats":{"$ref":"#/components/schemas/zone-analytics-api_threats"},"until":{"$ref":"#/components/schemas/zone-analytics-api_until"}},"type":"object"},"type":"array"},"zone-analytics-api_totals":{"description":"Breakdown of totals by data type.","properties":{"bandwidth":{"$ref":"#/components/schemas/zone-analytics-api_bandwidth"},"pageviews":{"$ref":"#/components/schemas/zone-analytics-api_pageviews"},"requests":{"$ref":"#/components/schemas/zone-analytics-api_requests"},"since":{"$ref":"#/components/schemas/zone-analytics-api_since"},"threats":{"$ref":"#/components/schemas/zone-analytics-api_threats"},"uniques":{"$ref":"#/components/schemas/zone-analytics-api_uniques"},"until":{"$ref":"#/components/schemas/zone-analytics-api_until"}},"type":"object"},"zone-analytics-api_totals_by_colo":{"description":"Breakdown of totals by data type.","properties":{"bandwidth":{"$ref":"#/components/schemas/zone-analytics-api_bandwidth_by_colo"},"requests":{"$ref":"#/components/schemas/zone-analytics-api_requests_by_colo"},"since":{"$ref":"#/components/schemas/zone-analytics-api_since"},"threats":{"$ref":"#/components/schemas/zone-analytics-api_threats"},"until":{"$ref":"#/components/schemas/zone-analytics-api_until"}},"type":"object"},"zone-analytics-api_uniques":{"properties":{"all":{"description":"Total number of unique IP addresses within the time range.","type":"integer"}},"type":"object"},"zone-analytics-api_until":{"anyOf":[{"type":"string"},{"type":"integer"}],"default":0,"description":"The (exclusive) end of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. If omitted, the time of the request is used.","example":"2015-01-02T12:23:00Z"},"zones_0rtt":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["0rtt"],"example":"0rtt"},"value":{"$ref":"#/components/schemas/zones_0rtt_value"}}}],"description":"0-RTT session resumption enabled for this zone.","title":"0-RTT Value"},"zones_0rtt_value":{"default":"off","description":"Value of the 0-RTT setting.","enum":["on","off"],"type":"string"},"zones_actions":{"description":"The set of actions to perform if the targets of this rule match the\nrequest. Actions can redirect to another URL or override settings, but\nnot both.\n","example":[{"id":"browser_check","value":"on"}],"items":{"discriminator":{"propertyName":"id"},"oneOf":[{"$ref":"#/components/schemas/zones_always_use_https"},{"$ref":"#/components/schemas/zones_automatic_https_rewrites"},{"$ref":"#/components/schemas/zones_browser_cache_ttl"},{"$ref":"#/components/schemas/zones_browser_check"},{"$ref":"#/components/schemas/zones_bypass_cache_on_cookie"},{"$ref":"#/components/schemas/zones_cache_by_device_type"},{"$ref":"#/components/schemas/zones_cache_deception_armor"},{"$ref":"#/components/schemas/zones_cache_key_fields"},{"$ref":"#/components/schemas/zones_cache_level"},{"$ref":"#/components/schemas/zones_cache_on_cookie"},{"$ref":"#/components/schemas/zones_cache_ttl_by_status"},{"$ref":"#/components/schemas/zones_disable_apps"},{"$ref":"#/components/schemas/zones_disable_performance"},{"$ref":"#/components/schemas/zones_disable_security"},{"$ref":"#/components/schemas/zones_disable_zaraz"},{"$ref":"#/components/schemas/zones_edge_cache_ttl"},{"$ref":"#/components/schemas/zones_email_obfuscation"},{"$ref":"#/components/schemas/zones_explicit_cache_control"},{"$ref":"#/components/schemas/zones_forwarding_url"},{"$ref":"#/components/schemas/zones_host_header_override"},{"$ref":"#/components/schemas/zones_ip_geolocation"},{"$ref":"#/components/schemas/zones_mirage"},{"$ref":"#/components/schemas/zones_opportunistic_encryption"},{"$ref":"#/components/schemas/zones_origin_error_page_pass_thru"},{"$ref":"#/components/schemas/zones_polish"},{"$ref":"#/components/schemas/zones_resolve_override"},{"$ref":"#/components/schemas/zones_respect_strong_etag"},{"$ref":"#/components/schemas/zones_response_buffering"},{"$ref":"#/components/schemas/zones_rocket_loader"},{"$ref":"#/components/schemas/zones_security_level"},{"$ref":"#/components/schemas/zones_sort_query_string_for_cache"},{"$ref":"#/components/schemas/zones_ssl"},{"$ref":"#/components/schemas/zones_true_client_ip_header"},{"$ref":"#/components/schemas/zones_waf"}]},"type":"array","x-stainless-skip":["terraform"]},"zones_advanced_ddos":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["advanced_ddos"],"example":"advanced_ddos"},"value":{"$ref":"#/components/schemas/zones_advanced_ddos_value"}}}],"description":"Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones.","title":"Advanced DDoS Protection"},"zones_advanced_ddos_value":{"default":"off","description":"Value of the zone setting.\nNotes: Defaults to on for Business+ plans","enum":["on","off"],"type":"string"},"zones_always_online":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["always_online"],"example":"always_online"},"value":{"$ref":"#/components/schemas/zones_always_online_value"}}}],"description":"When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.","title":"Always Online Mode"},"zones_always_online_value":{"default":"on","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_always_use_https":{"properties":{"id":{"description":"If enabled, any `http://`` URL is converted to `https://` through a\n301 redirect.\n","enum":["always_use_https"],"type":"string","x-auditable":true}},"title":"Always Use HTTPS","type":"object","x-stainless-skip":["terraform"]},"zones_always_use_https_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/zones_messages"},"messages":{"$ref":"#/components/schemas/zones_messages"},"success":{"description":"Whether the API call was successful.","example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"zones_api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/zones_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/zones_messages"}],"example":[]},"result":{"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"zones_api-response-single":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-api-response-common"}],"type":"object"},"zones_api-response-single-id":{"allOf":[{"$ref":"#/components/schemas/zones_api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/zones_identifier"}},"required":["id"],"type":"object"}}}],"type":"object"},"zones_automatic_https_rewrites":{"properties":{"id":{"description":"Turn on or off Automatic HTTPS Rewrites.","enum":["automatic_https_rewrites"],"type":"string","x-auditable":true},"value":{"description":"The status of Automatic HTTPS Rewrites.\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"Automatic HTTPS Rewrites","type":"object","x-stainless-skip":["terraform"]},"zones_automatic_https_rewrites_value":{"default":"on","description":"Value of the zone setting.\nNotes: Default value depends on the zone's plan level.","enum":["on","off"],"type":"string"},"zones_automatic_platform_optimization":{"properties":{"cache_by_device_type":{"description":"Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled.","example":false,"type":"boolean"},"cf":{"default":false,"description":"Indicates whether or not Cloudflare proxy is enabled.","example":true,"type":"boolean"},"enabled":{"default":false,"description":"Indicates whether or not Automatic Platform Optimization is enabled.","example":true,"type":"boolean"},"hostnames":{"description":"An array of hostnames where Automatic Platform Optimization for WordPress is activated.","example":["www.example.com","example.com","shop.example.com"],"items":{"format":"hostname","type":"string"},"type":"array"},"wordpress":{"default":false,"description":"Indicates whether or not site is powered by WordPress.","example":true,"type":"boolean"},"wp_plugin":{"default":false,"description":"Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed.","example":true,"type":"boolean"}},"required":["enabled","cf","wordpress","wp_plugin","hostnames","cache_by_device_type"],"type":"object"},"zones_base":{"properties":{"editable":{"default":true,"description":"Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).","enum":[true,false],"readOnly":true,"type":"boolean"},"id":{"description":"Identifier of the zone setting.","example":"development_mode","type":"string"},"modified_on":{"description":"last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"value":{"description":"Current value of the zone setting.","example":"on"}},"required":["id","value"]},"zones_brotli":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["brotli"],"example":"brotli"},"value":{"$ref":"#/components/schemas/zones_brotli_value"}}}],"description":"When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.","title":"Brotli Compression"},"zones_brotli_value":{"default":"off","description":"Value of the zone setting.","enum":["off","on"],"type":"string"},"zones_browser_cache_ttl":{"properties":{"id":{"description":"Control how long resources cached by client browsers remain valid.\n","enum":["browser_cache_ttl"],"type":"string","x-auditable":true},"value":{"description":"The number of seconds to cache resources for.\nSetting this to 0 enables \"Respect Existing Headers\".\n","example":3600,"maximum":31536000,"minimum":0,"type":"integer","x-auditable":true}},"title":"Browser Cache TTL","type":"object","x-stainless-skip":["terraform"]},"zones_browser_cache_ttl_value":{"default":14400,"description":"Value of the zone setting in seconds.\nMinimum values by plan:\n- Free: 1 second\n- Pro: 1 second\n- Business: 1 second\n- Enterprise: 1 second\nSetting a TTL of 0 is equivalent to selecting `Respect Existing Headers` and is allowed for all plans.","maximum":31536000,"minimum":0,"type":"integer"},"zones_browser_check":{"properties":{"id":{"description":"Inspect the visitor's browser for headers commonly associated with\nspammers and certain bots.\n","enum":["browser_check"],"type":"string","x-auditable":true},"value":{"description":"The status of Browser Integrity Check.\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"Browser Integrity Check","type":"object","x-stainless-skip":["terraform"]},"zones_browser_check_value":{"default":"on","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_bypass_cache_on_cookie":{"properties":{"id":{"description":"Bypass cache and fetch resources from the origin server if a regular\nexpression matches against a cookie name present in the request.\n","enum":["bypass_cache_on_cookie"],"type":"string","x-auditable":true},"value":{"description":"The regular expression to use for matching cookie names in the\nrequest. Refer to [Bypass Cache on Cookie\nsetting](https://developers.cloudflare.com/rules/page-rules/reference/additional-reference/#bypass-cache-on-cookie-setting)\nto learn about limited regular expression support.\n","example":"bypass=.*|PHPSESSID=.*","maxLength":150,"minLength":1,"type":"string","x-auditable":true}},"title":"Bypass Cache on Cookie","type":"object","x-stainless-skip":["terraform"]},"zones_cache-rules_aegis":{"allOf":[{"$ref":"#/components/schemas/zones_cache-rules_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["aegis"],"example":"aegis","type":"string","x-auditable":true},"value":{"$ref":"#/components/schemas/zones_cache-rules_aegis_value"}},"type":"object"}],"description":"Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses.","title":"Aegis","type":"object"},"zones_cache-rules_aegis_value":{"description":"Value of the zone setting.","properties":{"enabled":{"description":"Whether the feature is enabled or not.","type":"boolean","x-auditable":true},"pool_id":{"description":"Egress pool id which refers to a grouping of dedicated egress IPs through which Cloudflare will connect to origin.","example":"pool-id","type":"string","x-auditable":true}},"type":"object"},"zones_cache-rules_base":{"properties":{"id":{"description":"Identifier of the zone setting.","type":"string","x-auditable":true},"modified_on":{"description":"Last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string","x-auditable":true}},"required":["id"],"type":"object"},"zones_cache-rules_origin_h2_max_streams":{"allOf":[{"$ref":"#/components/schemas/zones_cache-rules_base"},{"properties":{"id":{"description":"Value of the zone setting.","enum":["origin_h2_max_streams"],"example":"origin_h2_max_streams","type":"string","x-auditable":true},"value":{"$ref":"#/components/schemas/zones_cache-rules_origin_h2_max_streams_value"}},"type":"object"}],"description":"Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled.","title":"Origin H2 Max Streams","type":"object"},"zones_cache-rules_origin_h2_max_streams_value":{"description":"Value of the Origin H2 Max Streams Setting.","example":50,"maximum":1000,"minimum":1,"type":"integer","x-auditable":true},"zones_cache-rules_origin_max_http_version":{"allOf":[{"$ref":"#/components/schemas/zones_cache-rules_base"},{"properties":{"id":{"description":"Value of the zone setting.","enum":["origin_max_http_version"],"example":"origin_max_http_version","type":"string","x-auditable":true},"value":{"$ref":"#/components/schemas/zones_cache-rules_origin_max_http_version_value"}},"type":"object"}],"description":"Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is \"2\" for all plan types except Enterprise where it is \"1\".","title":"Origin Max HTTP Version","type":"object"},"zones_cache-rules_origin_max_http_version_value":{"description":"Value of the Origin Max HTTP Version Setting.","enum":["2","1"],"type":"string","x-auditable":true},"zones_cache_by_device_type":{"properties":{"id":{"description":"Separate cached content based on the visitor's device type.\n","enum":["cache_by_device_type"],"type":"string","x-auditable":true},"value":{"description":"The status of Cache By Device Type.\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"Cache By Device Type","type":"object","x-stainless-skip":["terraform"]},"zones_cache_deception_armor":{"properties":{"id":{"description":"Protect from web cache deception attacks while still allowing static\nassets to be cached. This setting verifies that the URL's extension\nmatches the returned `Content-Type`.\n","enum":["cache_deception_armor"],"type":"string","x-auditable":true},"value":{"description":"The status of Cache Deception Armor.\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"Cache Deception Armor","type":"object","x-stainless-skip":["terraform"]},"zones_cache_key_fields":{"properties":{"id":{"description":"Control specifically what variables to include when deciding which\nresources to cache. This allows customers to determine what to cache\nbased on something other than just the URL.\n","enum":["cache_key_fields"],"type":"string"},"value":{"properties":{"cookie":{"description":"Controls which cookies appear in the Cache Key.\n","properties":{"check_presence":{"description":"A list of cookies to check for the presence of, without\nincluding their actual values.\n","example":["foo","bar"],"items":{"example":"foo","minLength":1,"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"include":{"description":"A list of cookies to include.\n","example":["foo","bar"],"items":{"example":"foo","minLength":1,"type":"string"},"maxItems":50,"minItems":1,"type":"array"}},"type":"object"},"header":{"description":"Controls which headers go into the Cache Key. Exactly one of\n`include` or `exclude` is expected.\n","properties":{"check_presence":{"description":"A list of headers to check for the presence of, without\nincluding their actual values.\n","example":["foo","bar"],"items":{"example":"foo","minLength":1,"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"exclude":{"description":"A list of headers to ignore.\n","example":["foo","bar"],"items":{"example":"foo","minLength":1,"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"include":{"description":"A list of headers to include.\n","example":["foo","bar"],"items":{"example":"foo","minLength":1,"type":"string"},"maxItems":50,"minItems":1,"type":"array"}},"type":"object"},"host":{"description":"Determines which host header to include in the Cache Key.\n","properties":{"resolved":{"description":"Whether to include the Host header in the HTTP request sent\nto the origin.\n","type":"boolean"}},"type":"object"},"query_string":{"description":"Controls which URL query string parameters go into the Cache\nKey. Exactly one of `include` or `exclude` is expected.\n","properties":{"exclude":{"oneOf":[{"description":"Ignore all query string parameters.\n","enum":["*"],"type":"string"},{"description":"A list of query string parameters to ignore.\n","example":["foo","bar"],"items":{"example":"foo","minLength":1,"type":"string"},"maxItems":50,"minItems":1,"type":"array"}]},"include":{"oneOf":[{"description":"Include all query string parameters.\n","enum":["*"],"type":"string"},{"description":"A list of query string parameters to include.\n","example":["foo","bar"],"items":{"example":"foo","minLength":1,"type":"string"},"maxItems":50,"minItems":1,"type":"array"}]}},"type":"object"},"user":{"description":"Feature fields to add features about the end-user (client) into\nthe Cache Key.\n","properties":{"device_type":{"description":"Classifies a request as `mobile`, `desktop`, or `tablet`\nbased on the User Agent.\n","type":"boolean"},"geo":{"description":"Includes the client's country, derived from the IP address.\n","type":"boolean"},"lang":{"description":"Includes the first language code contained in the\n`Accept-Language` header sent by the client.\n","type":"boolean"}},"type":"object"}},"type":"object"}},"title":"Custom Cache Key","type":"object","x-stainless-skip":["terraform"]},"zones_cache_level":{"properties":{"id":{"description":"Apply custom caching based on the option selected.\n","enum":["cache_level"],"type":"string","x-auditable":true},"value":{"description":"* `bypass`: Cloudflare does not cache.\n* `basic`: Delivers resources from cache when there is no query\n  string.\n* `simplified`: Delivers the same resource to everyone independent\n  of the query string.\n* `aggressive`: Caches all static content that has a query string.\n* `cache_everything`: Treats all content as static and caches all\n  file types beyond the [Cloudflare default cached\n  content](https://developers.cloudflare.com/cache/concepts/default-cache-behavior/#default-cached-file-extensions).\n","enum":["bypass","basic","simplified","aggressive","cache_everything"],"example":"bypass","type":"string","x-auditable":true}},"title":"Cache Level","type":"object","x-stainless-skip":["terraform"]},"zones_cache_level_value":{"default":"aggressive","description":"Value of the zone setting.","enum":["aggressive","basic","simplified"],"type":"string"},"zones_cache_on_cookie":{"properties":{"id":{"description":"Apply the Cache Everything option (Cache Level setting) based on a\nregular expression match against a cookie name.\n","enum":["cache_on_cookie"],"type":"string","x-auditable":true},"value":{"description":"The regular expression to use for matching cookie names in the\nrequest.\n","example":"bypass=.*|PHPSESSID=.*","maxLength":150,"minLength":1,"type":"string","x-auditable":true}},"title":"Cache on Cookie","type":"object","x-stainless-skip":["terraform"]},"zones_cache_ttl_by_status":{"properties":{"id":{"description":"Enterprise customers can set cache time-to-live (TTL) based on the\nresponse status from the origin web server. Cache TTL refers to the\nduration of a resource in the Cloudflare network before being\nmarked as stale or discarded from cache. Status codes are returned\nby a resource's origin. Setting cache TTL based on response status\noverrides the default cache behavior (standard caching) for static\nfiles and overrides cache instructions sent by the origin web\nserver. To cache non-static assets, set a Cache Level of Cache\nEverything using a Page Rule. Setting no-store Cache-Control or a\nlow TTL (using `max-age`/`s-maxage`) increases requests to origin\nweb servers and decreases performance.\n","enum":["cache_ttl_by_status"],"type":"string","x-auditable":true},"value":{"additionalProperties":{"anyOf":[{"description":"`no-store` (equivalent to -1), `no-cache` (equivalent to 0)\n","enum":["no-cache","no-store"],"example":"no-cache","type":"string"},{"description":"An integer value that defines the duration an asset is valid in\nseconds.\n","example":86400,"type":"integer"}]},"description":"A JSON object containing status codes and their corresponding TTLs.\nEach key-value pair in the cache TTL by status cache rule has the\nfollowing syntax\n- `status_code`: An integer value such as 200 or 500. status_code\n  matches the exact status code from the origin web server. Valid\n  status codes are between 100-999.\n- `status_code_range`: Integer values for from and to.\n  status_code_range matches any status code from the origin web\n  server within the specified range.\n- `value`: An integer value that defines the duration an asset is\n  valid in seconds or one of the following strings: no-store\n  (equivalent to -1), no-cache (equivalent to 0).\n","example":{"200-299":86400,"300-499":"no-cache","500-599":"no-store"},"type":"object"}},"title":"Cache TTL by Status Code","type":"object","x-stainless-skip":["terraform"]},"zones_challenge_ttl":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["challenge_ttl"],"example":"challenge_ttl"},"value":{"$ref":"#/components/schemas/zones_challenge_ttl_value"}}}],"description":"Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).","title":"Challenge Page TTL"},"zones_challenge_ttl_value":{"default":1800,"description":"Value of the zone setting.","enum":[300,900,1800,2700,3600,7200,10800,14400,28800,57600,86400,604800,2592000,31536000],"type":"number"},"zones_china_network_enabled":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["china_network_enabled"],"example":"china_network_enabled"},"value":{"$ref":"#/components/schemas/zones_china_network_enabled_value"}}}],"description":"Determines whether or not the china network is enabled.\n","title":"China Network Enabled"},"zones_china_network_enabled_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"readOnly":true,"type":"string"},"zones_ciphers":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["ciphers"],"example":"ciphers"},"value":{"$ref":"#/components/schemas/zones_ciphers_value"}}}],"default":[],"description":"An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.","title":"Zone ciphers allowed for TLS termination"},"zones_ciphers_value":{"default":[],"description":"Value of the zone setting.","example":["ECDHE-RSA-AES128-GCM-SHA256","AES128-SHA"],"items":{"type":"string"},"type":"array","uniqueItems":true},"zones_cname_flattening":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"How to flatten the cname destination.","enum":["cname_flattening"]},"value":{"$ref":"#/components/schemas/zones_cname_flattening_value"}}}],"deprecated":true,"description":"Whether or not cname flattening is on.","title":"Cloudflare CNAME Flattening","x-stainless-deprecation-message":"This zone setting is deprecated; please use the DNS Settings route instead. More information at https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2025-03-21"},"zones_cname_flattening_value":{"default":"flatten_at_root","deprecated":true,"description":"Value of the cname flattening setting.","enum":["flatten_at_root","flatten_all"],"type":"string","x-stainless-deprecation-message":"This zone setting is deprecated; please use the DNS Settings route instead. More information at https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2025-03-21"},"zones_components-schemas-api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/zones_messages"},"messages":{"$ref":"#/components/schemas/zones_messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"zones_components-schemas-api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/zones_messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/zones_messages"}],"example":[]},"result":{"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"zones_created_on":{"description":"The timestamp of when the Page Rule was created.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"zones_development_mode":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["development_mode"],"example":"development_mode"},"time_remaining":{"description":"Value of the zone setting.\nNotes: The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is false.","example":3600,"readOnly":true,"type":"number"},"value":{"$ref":"#/components/schemas/zones_development_mode_value"}}}],"description":"Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.","title":"Development Mode"},"zones_development_mode_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_disable_apps":{"properties":{"id":{"description":"Turn off all active [Cloudflare Apps](https://developers.cloudflare.com/support/more-dashboard-apps/cloudflare-apps/)\n(deprecated).\n","enum":["disable_apps"],"type":"string","x-auditable":true}},"title":"Disable Apps","type":"object","x-stainless-skip":["terraform"]},"zones_disable_performance":{"properties":{"id":{"description":"Turn off\n[Rocket Loader](https://developers.cloudflare.com/speed/optimization/content/rocket-loader/),\n[Mirage](https://developers.cloudflare.com/speed/optimization/images/mirage/), and\n[Polish](https://developers.cloudflare.com/images/polish/).\n","enum":["disable_performance"],"type":"string","x-auditable":true}},"title":"Disable Performance","type":"object","x-stainless-skip":["terraform"]},"zones_disable_security":{"properties":{"id":{"description":"Turn off\n[Email Obfuscation](https://developers.cloudflare.com/waf/tools/scrape-shield/email-address-obfuscation/),\n[Rate Limiting (previous version, deprecated)](https://developers.cloudflare.com/waf/reference/legacy/old-rate-limiting/),\n[Scrape Shield](https://developers.cloudflare.com/waf/tools/scrape-shield/),\n[URL (Zone) Lockdown](https://developers.cloudflare.com/waf/tools/zone-lockdown/), and\n[WAF managed rules (previous version, deprecated)](https://developers.cloudflare.com/waf/reference/legacy/old-waf-managed-rules/).\n","enum":["disable_security"],"type":"string","x-auditable":true}},"title":"Disable Security","type":"object","x-stainless-skip":["terraform"]},"zones_disable_zaraz":{"properties":{"id":{"description":"Turn off [Zaraz](https://developers.cloudflare.com/zaraz/).\n","enum":["disable_zaraz"],"type":"string","x-auditable":true}},"title":"Disable Zaraz","type":"object","x-stainless-skip":["terraform"]},"zones_early_hints":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["early_hints"],"example":"early_hints"},"value":{"$ref":"#/components/schemas/zones_early_hints_value"}}}],"description":"When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.","title":"Early Hints"},"zones_early_hints_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_edge_cache_ttl":{"properties":{"id":{"description":"Specify how long to cache a resource in the Cloudflare global\nnetwork. *Edge Cache TTL* is not visible in response headers.\n","enum":["edge_cache_ttl"],"type":"string","x-auditable":true},"value":{"maximum":31536000,"minimum":1,"type":"integer","x-auditable":true}},"title":"Edge Cache TTL","type":"object","x-stainless-skip":["terraform"]},"zones_edge_cache_ttl_value":{"default":7200,"description":"Value of the zone setting.\nNotes: The minimum TTL available depends on the plan level of the zone. (Enterprise = 30, Business = 1800, Pro = 3600, Free = 7200)","enum":[30,60,300,1200,1800,3600,7200,10800,14400,18000,28800,43200,57600,72000,86400,172800,259200,345600,432000,518400,604800],"type":"number"},"zones_email_obfuscation":{"properties":{"id":{"description":"Turn on or off **Email Obfuscation**.","enum":["email_obfuscation"],"type":"string","x-auditable":true},"value":{"description":"The status of Email Obfuscation.\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"Email Obfuscation","type":"object","x-stainless-skip":["terraform"]},"zones_email_obfuscation_value":{"default":"on","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_explicit_cache_control":{"properties":{"id":{"description":"Origin Cache Control is enabled by default for Free, Pro, and\nBusiness domains and disabled by default for Enterprise domains.\n","enum":["explicit_cache_control"],"type":"string","x-auditable":true},"value":{"description":"The status of Origin Cache Control.\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"Origin Cache Control","type":"object","x-stainless-skip":["terraform"]},"zones_forwarding_url":{"properties":{"id":{"description":"Redirects one URL to another using an `HTTP 301/302` redirect. Refer\nto [Wildcard matching and referencing](https://developers.cloudflare.com/rules/page-rules/reference/wildcard-matching/).\n","enum":["forwarding_url"],"example":"forwarding_url","type":"string","x-auditable":true},"value":{"properties":{"status_code":{"description":"The status code to use for the URL redirect. 301 is a permanent\nredirect. 302 is a temporary redirect.\n","enum":[301,302],"example":"temporary","type":"integer","x-auditable":true},"url":{"description":"The URL to redirect the request to.\nNotes: ${num} refers to the position of '*' in the constraint value.","example":"http://www.example.com/somewhere/$1/astring/$2/anotherstring/$3","maxLength":1500,"type":"string","x-auditable":true}}}},"title":"Forwarding URL","type":"object","x-stainless-skip":["terraform"]},"zones_h2_prioritization":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["h2_prioritization"],"example":"h2_prioritization"},"value":{"$ref":"#/components/schemas/zones_h2_prioritization_value"}}}],"description":"HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers.","title":"HTTP/2 Edge Prioritization"},"zones_h2_prioritization_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off","custom"],"type":"string"},"zones_host_header_override":{"properties":{"id":{"description":"Apply a specific host header.","enum":["host_header_override"],"type":"string","x-auditable":true},"value":{"description":"The hostname to use in the `Host` header","example":"example.com","minLength":1,"type":"string","x-auditable":true}},"title":"Host Header Override","type":"object","x-stainless-skip":["terraform"]},"zones_hotlink_protection":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["hotlink_protection"],"example":"hotlink_protection"},"value":{"$ref":"#/components/schemas/zones_hotlink_protection_value"}}}],"description":"When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).","title":"Hotlink Protection"},"zones_hotlink_protection_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_http2":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["http2"],"example":"http2"},"value":{"$ref":"#/components/schemas/zones_http2_value"}}}],"description":"HTTP2 enabled for this zone.","title":"HTTP2 Value"},"zones_http2_value":{"default":"off","description":"Value of the HTTP2 setting.","enum":["on","off"],"type":"string"},"zones_http3":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["http3"],"example":"http3"},"value":{"$ref":"#/components/schemas/zones_http3_value"}}}],"description":"HTTP3 enabled for this zone.","title":"HTTP3 Value"},"zones_http3_value":{"default":"off","description":"Value of the HTTP3 setting.","enum":["on","off"],"type":"string"},"zones_identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string"},"zones_image_resizing":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["image_resizing"],"example":"image_resizing"},"value":{"$ref":"#/components/schemas/zones_image_resizing_value"}}}],"description":"Image Transformations provides on-demand resizing, conversion and optimization for images served through Cloudflare's network. Refer to the [Image Transformations documentation](https://developers.cloudflare.com/images/) for more information.","title":"Image Transformations"},"zones_image_resizing_value":{"default":"off","description":"Whether the feature is enabled, disabled, or enabled in `open proxy` mode.","enum":["on","off","open"],"type":"string"},"zones_ip_geolocation":{"properties":{"id":{"description":"Cloudflare adds a CF-IPCountry HTTP header containing the country code that corresponds to the visitor.\n","enum":["ip_geolocation"],"example":"ip_geolocation","type":"string","x-auditable":true},"value":{"description":"The status of adding the IP Geolocation Header.\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"IP Geolocation Header","type":"object","x-stainless-skip":["terraform"]},"zones_ip_geolocation_value":{"default":"on","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_ipv6":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["ipv6"],"example":"ipv6"},"value":{"$ref":"#/components/schemas/zones_ipv6_value"}}}],"description":"Enable IPv6 on all subdomains that are Cloudflare enabled.  (https://support.cloudflare.com/hc/en-us/articles/200168586).","title":"IPv6"},"zones_ipv6_value":{"default":"off","description":"Value of the zone setting.","enum":["off","on"],"type":"string"},"zones_max_upload":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"identifier of the zone setting.","enum":["max_upload"],"example":"max_upload"},"value":{"$ref":"#/components/schemas/zones_max_upload_value"}}}],"description":"Maximum size of an allowable upload.","title":"Max Upload"},"zones_max_upload_value":{"default":100,"description":"Value of the zone setting.\nNotes: The size depends on the plan level of the zone. (Enterprise = 500, Business = 200, Pro = 100, Free = 100)","enum":[100,125,150,175,200,225,250,275,300,325,350,375,400,425,450,475,500,1000],"type":"integer"},"zones_messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"zones_min_tls_version":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["min_tls_version"],"example":"min_tls_version"},"value":{"$ref":"#/components/schemas/zones_min_tls_version_value"}}}],"default":"1.0","description":"Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted.","title":"Zone Minimum TLS Version value"},"zones_min_tls_version_value":{"default":"1.0","description":"Value of the zone setting.","enum":["1.0","1.1","1.2","1.3"],"type":"string"},"zones_mirage":{"properties":{"id":{"description":"Cloudflare Mirage reduces bandwidth used by images in mobile browsers.\nIt can accelerate loading of image-heavy websites on very slow mobile connections and HTTP/1.\n","enum":["mirage"],"example":"mirage","type":"string","x-auditable":true},"value":{"description":"The status of Mirage.\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"Mirage","type":"object","x-stainless-skip":["terraform"]},"zones_mirage_value":{"default":"off","deprecated":true,"description":"Value of the zone setting.","enum":["on","off"],"type":"string","x-stainless-deprecation-message":"Mirage is being deprecated. More information at https://developers.cloudflare.com/speed/optimization/images/mirage/"},"zones_modified_on":{"description":"The timestamp of when the Page Rule was last modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string","x-auditable":true},"zones_multiple_settings":{"items":{"anyOf":[{"$ref":"#/components/schemas/zones_0rtt"},{"$ref":"#/components/schemas/zones_advanced_ddos"},{"$ref":"#/components/schemas/zones_cache-rules_aegis"},{"$ref":"#/components/schemas/zones_always_online"},{"$ref":"#/components/schemas/zones_schemas-always_use_https"},{"$ref":"#/components/schemas/zones_schemas-automatic_https_rewrites"},{"$ref":"#/components/schemas/zones_brotli"},{"$ref":"#/components/schemas/zones_schemas-browser_cache_ttl"},{"$ref":"#/components/schemas/zones_schemas-browser_check"},{"$ref":"#/components/schemas/zones_schemas-cache_level"},{"$ref":"#/components/schemas/zones_challenge_ttl"},{"$ref":"#/components/schemas/zones_china_network_enabled"},{"$ref":"#/components/schemas/zones_ciphers"},{"$ref":"#/components/schemas/zones_cname_flattening"},{"$ref":"#/components/schemas/zones_development_mode"},{"$ref":"#/components/schemas/zones_early_hints"},{"$ref":"#/components/schemas/zones_schemas-edge_cache_ttl"},{"$ref":"#/components/schemas/zones_schemas-email_obfuscation"},{"$ref":"#/components/schemas/zones_h2_prioritization"},{"$ref":"#/components/schemas/zones_hotlink_protection"},{"$ref":"#/components/schemas/zones_http2"},{"$ref":"#/components/schemas/zones_http3"},{"$ref":"#/components/schemas/zones_schemas-ip_geolocation"},{"$ref":"#/components/schemas/zones_ipv6"},{"$ref":"#/components/schemas/zones_max_upload"},{"$ref":"#/components/schemas/zones_min_tls_version"},{"$ref":"#/components/schemas/zones_schemas-mirage"},{"$ref":"#/components/schemas/zones_nel"},{"$ref":"#/components/schemas/zones_schemas-opportunistic_encryption"},{"$ref":"#/components/schemas/zones_opportunistic_onion"},{"$ref":"#/components/schemas/zones_orange_to_orange"},{"$ref":"#/components/schemas/zones_schemas-origin_error_page_pass_thru"},{"$ref":"#/components/schemas/zones_cache-rules_origin_h2_max_streams"},{"$ref":"#/components/schemas/zones_cache-rules_origin_max_http_version"},{"$ref":"#/components/schemas/zones_schemas-polish"},{"$ref":"#/components/schemas/zones_prefetch_preload"},{"$ref":"#/components/schemas/zones_privacy_pass"},{"$ref":"#/components/schemas/zones_proxy_read_timeout"},{"$ref":"#/components/schemas/zones_pseudo_ipv4"},{"$ref":"#/components/schemas/zones_replace_insecure_js"},{"$ref":"#/components/schemas/zones_schemas-response_buffering"},{"$ref":"#/components/schemas/zones_schemas-rocket_loader"},{"$ref":"#/components/schemas/zones_schemas-automatic_platform_optimization"},{"$ref":"#/components/schemas/zones_security_header"},{"$ref":"#/components/schemas/zones_schemas-security_level"},{"$ref":"#/components/schemas/zones_server_side_exclude"},{"$ref":"#/components/schemas/zones_sha1_support"},{"$ref":"#/components/schemas/zones_schemas-sort_query_string_for_cache"},{"$ref":"#/components/schemas/zones_schemas-ssl"},{"$ref":"#/components/schemas/zones_ssl_recommender"},{"$ref":"#/components/schemas/zones_tls_1_2_only"},{"$ref":"#/components/schemas/zones_tls_1_3"},{"$ref":"#/components/schemas/zones_tls_client_auth"},{"$ref":"#/components/schemas/zones_schemas-true_client_ip_header"},{"$ref":"#/components/schemas/zones_schemas-waf"},{"$ref":"#/components/schemas/zones_webp"},{"$ref":"#/components/schemas/zones_websockets"}]},"type":"array"},"zones_name":{"description":"The domain name.","example":"example.com","maxLength":253,"pattern":"^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$","type":"string"},"zones_nel":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"Zone setting identifier.","enum":["nel"],"example":"nel"},"value":{"$ref":"#/components/schemas/zones_nel_value"}}}],"description":"Enable Network Error Logging reporting on your zone. (Beta) ","title":"Network Error Logging"},"zones_nel_value":{"default":{"enabled":false},"description":"Value of the zone setting.","properties":{"enabled":{"default":false,"example":false,"type":"boolean"}},"type":"object"},"zones_opportunistic_encryption":{"properties":{"id":{"description":"Opportunistic Encryption allows browsers to access HTTP URIs over an encrypted TLS channel.\nIt's not a substitute for HTTPS, but provides additional security for otherwise vulnerable requests.\n","enum":["opportunistic_encryption"],"example":"opportunistic_encryption","type":"string","x-auditable":true},"value":{"description":"The status of Opportunistic Encryption.\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"Opportunistic Encryption","type":"object","x-stainless-skip":["terraform"]},"zones_opportunistic_encryption_value":{"default":"on","description":"Value of the zone setting.\nNotes: Default value depends on the zone's plan level.","enum":["on","off"],"type":"string"},"zones_opportunistic_onion":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["opportunistic_onion"],"example":"opportunistic_onion"},"value":{"$ref":"#/components/schemas/zones_opportunistic_onion_value"}}}],"default":"off","description":"Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.","title":"Zone Enable Onion Routing"},"zones_opportunistic_onion_value":{"default":"off","description":"Value of the zone setting.\nNotes: Default value depends on the zone's plan level.","enum":["on","off"],"type":"string"},"zones_orange_to_orange":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["orange_to_orange"],"example":"orange_to_orange"},"value":{"$ref":"#/components/schemas/zones_orange_to_orange_value"}}}],"description":"Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.","title":"Orange to Orange"},"zones_orange_to_orange_value":{"default":"on","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_origin_error_page_pass_thru":{"properties":{"id":{"description":"Turn on or off Cloudflare error pages generated from issues sent from the origin server. If enabled, this setting triggers error pages issued by the origin.\n","enum":["origin_error_page_pass_thru"],"example":"origin_error_page_pass_thru","type":"string","x-auditable":true},"value":{"description":"The status of Origin Error Page Passthru.\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"Origin Error Page Passthru","type":"object","x-stainless-skip":["terraform"]},"zones_origin_error_page_pass_thru_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_page_rule":{"properties":{"actions":{"$ref":"#/components/schemas/zones_actions"},"created_on":{"$ref":"#/components/schemas/zones_created_on"},"id":{"$ref":"#/components/schemas/zones_schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/zones_modified_on"},"priority":{"$ref":"#/components/schemas/zones_priority"},"status":{"$ref":"#/components/schemas/zones_status"},"targets":{"$ref":"#/components/schemas/zones_targets"}},"required":["id","targets","actions","priority","status","modified_on","created_on"],"type":"object"},"zones_paused":{"default":false,"description":"Indicates whether the zone is only using Cloudflare DNS services. A\ntrue value means the zone will not receive security or performance\nbenefits.\n","type":"boolean"},"zones_polish":{"properties":{"id":{"description":"Apply options from the Polish feature of the Cloudflare Speed app.\n","enum":["polish"],"example":"polish","type":"string","x-auditable":true},"value":{"description":"The level of Polish you want applied to your origin.\n","enum":["off","lossless","lossy"],"example":"lossless","type":"string","x-auditable":true}},"title":"Polish","type":"object","x-stainless-skip":["terraform"]},"zones_polish_value":{"default":"off","description":"Value of the zone setting.","enum":["off","lossless","lossy"],"type":"string"},"zones_prefetch_preload":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["prefetch_preload"],"example":"prefetch_preload"},"value":{"$ref":"#/components/schemas/zones_prefetch_preload_value"}}}],"default":"off","description":"Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.","title":"Prefetch preload"},"zones_prefetch_preload_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_priority":{"default":1,"description":"The priority of the rule, used to define which Page Rule is processed\nover another. A higher number indicates a higher priority. For example,\nif you have a catch-all Page Rule (rule A: `/images/*`) but want a more\nspecific Page Rule to take precedence (rule B: `/images/special/*`),\nspecify a higher priority for rule B so it overrides rule A.\n","type":"integer","x-auditable":true},"zones_privacy_pass":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["privacy_pass"],"example":"privacy_pass"},"value":{"$ref":"#/components/schemas/zones_privacy_pass_value"}}}],"default":"off","deprecated":true,"description":"Privacy Pass v1 was a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors by allowing users to reduce the number of CAPTCHAs shown. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).","title":"Privacy Pass v1 (deprecated)","x-stainless-deprecation-message":"Privacy Pass v1 was deprecated in 2023. (Announcement - https://blog.cloudflare.com/privacy-pass-standard/) and (API deprecation details - https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2024-03-31)"},"zones_privacy_pass_value":{"default":"off","deprecated":true,"description":"Value of the Privacy Pass v1 (deprecated) zone setting","enum":["on","off"],"type":"string","x-stainless-deprecation-message":"Privacy Pass v1 was deprecated in 2023. (Announcement - https://blog.cloudflare.com/privacy-pass-standard/) and (API deprecation details - https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2024-03-31)"},"zones_proxy_read_timeout":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["proxy_read_timeout"],"example":"proxy_read_timeout"},"value":{"$ref":"#/components/schemas/zones_proxy_read_timeout_value"}}}],"description":"Maximum time between two read operations from origin.","title":"Proxy Read Timeout"},"zones_proxy_read_timeout_value":{"default":100,"description":"Value of the zone setting.\nNotes: Value must be between 1 and 6000","type":"number"},"zones_pseudo_ipv4":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"default":"pseudo_ipv4","description":"Value of the Pseudo IPv4 setting.","enum":["pseudo_ipv4"]},"value":{"$ref":"#/components/schemas/zones_pseudo_ipv4_value"}}}],"description":"The value set for the Pseudo IPv4 setting.","title":"Pseudo IPv4 Value"},"zones_pseudo_ipv4_value":{"default":"off","description":"Value of the Pseudo IPv4 setting.","enum":["off","add_header","overwrite_header"],"type":"string"},"zones_replace_insecure_js":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["replace_insecure_js"],"example":"replace_insecure_js"},"value":{"$ref":"#/components/schemas/zones_replace_insecure_js_value"}}}],"description":"Automatically replace insecure JavaScript libraries with safer and faster alternatives provided under cdnjs and powered by Cloudflare. Currently supports the following libraries: Polyfill under polyfill.io.\n","title":"Replace insecure JavaScript libraries"},"zones_replace_insecure_js_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_resolve_override":{"properties":{"id":{"description":"Change the origin address to the value specified in this setting.\n","enum":["resolve_override"],"example":"resolve_override","type":"string","x-auditable":true},"value":{"description":"The origin address you want to override with.\n","example":"example.com","type":"string","x-auditable":true}},"title":"Resolve Override","type":"object","x-stainless-skip":["terraform"]},"zones_respect_strong_etag":{"properties":{"id":{"description":"Turn on or off byte-for-byte equivalency checks between the\nCloudflare cache and the origin server.\n","enum":["respect_strong_etag"],"type":"string","x-auditable":true},"value":{"description":"The status of Respect Strong ETags\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"Respect Strong ETags","type":"object","x-stainless-skip":["terraform"]},"zones_response_buffering":{"deprecated":true,"properties":{"id":{"description":"Turn on or off whether Cloudflare should wait for an entire file\nfrom the origin server before forwarding it to the site visitor. By\ndefault, Cloudflare sends packets to the client as they arrive from\nthe origin server.\n","enum":["response_buffering"],"type":"string","x-auditable":true},"value":{"description":"The status of Response Buffering\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"Response Buffering","type":"object","x-stainless-deprecation-message":"This page rule is deprecated. This functionality is no longer supported.","x-stainless-skip":["terraform"]},"zones_response_buffering_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_result_info":{"properties":{"count":{"description":"Total number of results for the requested service.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"},"total_pages":{"description":"Total number of pages","example":100,"type":"number"}},"type":"object"},"zones_rocket_loader":{"properties":{"id":{"description":"Turn on or off Rocket Loader in the Cloudflare Speed app.\n","enum":["rocket_loader"],"type":"string","x-auditable":true},"value":{"description":"The status of Rocket Loader\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"Rocket Loader","type":"object","x-stainless-skip":["terraform"]},"zones_rocket_loader_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_schemas-always_use_https":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["always_use_https"],"example":"always_use_https"},"value":{"$ref":"#/components/schemas/zones_always_use_https_value"}}}],"default":"off","description":"Reply to all requests for URLs that use \"http\" with a 301 redirect to the equivalent \"https\" URL. If you only want to redirect for a subset of requests, consider creating an \"Always use HTTPS\" page rule.","title":"Zone Enable Always Use HTTPS"},"zones_schemas-api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/zones_schemas-messages"},"messages":{"$ref":"#/components/schemas/zones_schemas-messages"},"success":{"description":"Whether the API call was successful.","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"zones_schemas-api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"zones_schemas-api-response-single":{"allOf":[{"$ref":"#/components/schemas/zones_components-schemas-api-response-common"},{"properties":{"result":{"anyOf":[{"type":"object"},{"type":"string"}]}}}],"type":"object"},"zones_schemas-api-response-single-id":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/zones_schemas-identifier"}},"required":["id"],"type":"object"}}}],"type":"object"},"zones_schemas-automatic_https_rewrites":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["automatic_https_rewrites"],"example":"automatic_https_rewrites"},"value":{"$ref":"#/components/schemas/zones_automatic_https_rewrites_value"}}}],"default":"off","description":"Enable the Automatic HTTPS Rewrites feature for this zone.","title":"Zone Enable Automatic HTTPS Rewrites"},"zones_schemas-automatic_platform_optimization":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["automatic_platform_optimization"],"example":"automatic_platform_optimization"},"value":{"$ref":"#/components/schemas/zones_automatic_platform_optimization"}}}],"description":"[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts.","title":"Automatic Platform Optimization for WordPress"},"zones_schemas-base":{"properties":{"editable":{"description":"Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).","enum":[true,false],"readOnly":true,"type":"boolean"},"id":{"description":"Identifier of the zone setting.","example":"development_mode","type":"string"},"modified_on":{"description":"last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"value":{"description":"Current value of the zone setting.","example":"on"}},"required":["id","value"]},"zones_schemas-browser_cache_ttl":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["browser_cache_ttl"],"example":"browser_cache_ttl"},"value":{"$ref":"#/components/schemas/zones_browser_cache_ttl_value"}}}],"description":"Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).","title":"Browser Cache TTL"},"zones_schemas-browser_check":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["browser_check"],"example":"browser_check"},"value":{"$ref":"#/components/schemas/zones_browser_check_value"}}}],"description":"Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page.  It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).","title":"Browser Check"},"zones_schemas-cache_level":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["cache_level"],"example":"cache_level"},"value":{"$ref":"#/components/schemas/zones_cache_level_value"}}}],"description":"Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).","title":"Cloudflare Cache Level"},"zones_schemas-edge_cache_ttl":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["edge_cache_ttl"],"example":"edge_cache_ttl"},"value":{"$ref":"#/components/schemas/zones_edge_cache_ttl_value"}}}],"description":"Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers.","title":"Edge Cache TTL"},"zones_schemas-email_obfuscation":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["email_obfuscation"],"example":"email_obfuscation"},"value":{"$ref":"#/components/schemas/zones_email_obfuscation_value"}}}],"description":"Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).","title":"Email Obfuscation"},"zones_schemas-identifier":{"description":"Identifier.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string","x-auditable":true},"zones_schemas-ip_geolocation":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["ip_geolocation"],"example":"ip_geolocation"},"value":{"$ref":"#/components/schemas/zones_ip_geolocation_value"}}}],"description":"Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).","title":"IP Geolocation"},"zones_schemas-messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"documentation_url":{"type":"string"},"message":{"type":"string"},"source":{"properties":{"pointer":{"type":"string"}},"type":"object"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"zones_schemas-mirage":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["mirage"],"example":"mirage"},"value":{"$ref":"#/components/schemas/zones_mirage_value"}}}],"deprecated":true,"description":"Automatically optimize image loading for website visitors on mobile\ndevices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed)\nfor more information.\n","title":"Mirage Image Optimization","x-stainless-deprecation-message":"Mirage is being deprecated. More information at https://developers.cloudflare.com/speed/optimization/images/mirage/"},"zones_schemas-opportunistic_encryption":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["opportunistic_encryption"],"example":"opportunistic_encryption"},"value":{"$ref":"#/components/schemas/zones_opportunistic_encryption_value"}}}],"description":"Enables the Opportunistic Encryption feature for a zone.","title":"Enable Opportunistic Encryption for a zone"},"zones_schemas-origin_error_page_pass_thru":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["origin_error_page_pass_thru"],"example":"origin_error_page_pass_thru"},"value":{"$ref":"#/components/schemas/zones_origin_error_page_pass_thru_value"}}}],"default":"off","description":"Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.","title":"Error Pages On"},"zones_schemas-polish":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["polish"],"example":"polish"},"value":{"$ref":"#/components/schemas/zones_polish_value"}}}],"description":"Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.","title":"Polish Image Optimization"},"zones_schemas-response_buffering":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["response_buffering"],"example":"response_buffering"},"value":{"$ref":"#/components/schemas/zones_response_buffering_value"}}}],"default":"off","deprecated":true,"description":"Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.","title":"Response Buffering","x-stainless-deprecation-message":"This zone setting is deprecated. This functionality is no longer supported."},"zones_schemas-rocket_loader":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["rocket_loader"],"example":"rocket_loader"},"value":{"$ref":"#/components/schemas/zones_rocket_loader_value"}}}],"description":"Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information.","title":"Rocket Loader"},"zones_schemas-security_level":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["security_level"],"example":"security_level"},"value":{"$ref":"#/components/schemas/zones_security_level_value"}}}],"description":"Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).","title":"Security Level"},"zones_schemas-sort_query_string_for_cache":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["sort_query_string_for_cache"],"example":"sort_query_string_for_cache"},"value":{"$ref":"#/components/schemas/zones_sort_query_string_for_cache_value"}}}],"default":"off","description":"Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.","title":"Get String Sort"},"zones_schemas-ssl":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["ssl"],"example":"ssl"},"value":{"$ref":"#/components/schemas/zones_ssl_value"}}}],"description":"SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server  (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full:  SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).","title":"SSL"},"zones_schemas-true_client_ip_header":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["true_client_ip_header"],"example":"true_client_ip_header"},"value":{"$ref":"#/components/schemas/zones_true_client_ip_header_value"}}}],"default":"off","description":"Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.","title":"True Client IP Header"},"zones_schemas-waf":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["waf"],"example":"waf"},"value":{"$ref":"#/components/schemas/zones_waf_value"}}}],"description":"The WAF examines HTTP requests to your website.  It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully  to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).","title":"Web Application Firewall"},"zones_security_header":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone's security header.","enum":["security_header"],"example":"security_header"},"value":{"$ref":"#/components/schemas/zones_security_header_value"}}}],"description":"Cloudflare security header for a zone.","title":"Security Header"},"zones_security_header_value":{"default":{"strict_transport_security":{"enabled":true,"include_subdomains":true,"max_age":86400,"nosniff":true,"preload":false}},"properties":{"strict_transport_security":{"description":"Strict Transport Security.","properties":{"enabled":{"description":"Whether or not strict transport security is enabled.","example":true,"type":"boolean"},"include_subdomains":{"description":"Include all subdomains for strict transport security.","example":true,"type":"boolean"},"max_age":{"description":"Max age in seconds of the strict transport security.","example":86400,"type":"number"},"nosniff":{"description":"Whether or not to include 'X-Content-Type-Options: nosniff' header.","example":true,"type":"boolean"},"preload":{"description":"Enable automatic preload of the HSTS configuration.","example":true,"type":"boolean"}},"type":"object"}},"type":"object"},"zones_security_level":{"properties":{"id":{"description":"Control options for the **Security Level** feature from the **Security** app.\n","enum":["security_level"],"type":"string","x-auditable":true},"value":{"enum":["off","essentially_off","low","medium","high","under_attack"],"example":"under_attack","type":"string","x-auditable":true}},"title":"Security Level","type":"object","x-stainless-skip":["terraform"]},"zones_security_level_value":{"default":"medium","description":"Value of the zone setting.","enum":["off","essentially_off","low","medium","high","under_attack"],"type":"string"},"zones_server_side_exclude":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["server_side_exclude"],"example":"server_side_exclude"},"value":{"$ref":"#/components/schemas/zones_server_side_exclude_value"}}}],"description":"If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: \u003c!--sse--\u003e\u003c!--/sse--\u003e. For example: \u003c!--sse--\u003e  Bad visitors won't see my phone number, 555-555-5555 \u003c!--/sse--\u003e. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).","title":"Server Side Exclude"},"zones_server_side_exclude_value":{"default":"on","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_setting":{"oneOf":[{"$ref":"#/components/schemas/zones_0rtt"},{"$ref":"#/components/schemas/zones_advanced_ddos"},{"$ref":"#/components/schemas/zones_cache-rules_aegis"},{"$ref":"#/components/schemas/zones_always_online"},{"$ref":"#/components/schemas/zones_schemas-always_use_https"},{"$ref":"#/components/schemas/zones_schemas-automatic_https_rewrites"},{"$ref":"#/components/schemas/zones_brotli"},{"$ref":"#/components/schemas/zones_schemas-browser_cache_ttl"},{"$ref":"#/components/schemas/zones_schemas-browser_check"},{"$ref":"#/components/schemas/zones_schemas-cache_level"},{"$ref":"#/components/schemas/zones_challenge_ttl"},{"$ref":"#/components/schemas/zones_china_network_enabled"},{"$ref":"#/components/schemas/zones_ciphers"},{"$ref":"#/components/schemas/zones_cname_flattening"},{"$ref":"#/components/schemas/zones_development_mode"},{"$ref":"#/components/schemas/zones_early_hints"},{"$ref":"#/components/schemas/zones_schemas-edge_cache_ttl"},{"$ref":"#/components/schemas/zones_schemas-email_obfuscation"},{"$ref":"#/components/schemas/zones_h2_prioritization"},{"$ref":"#/components/schemas/zones_hotlink_protection"},{"$ref":"#/components/schemas/zones_http2"},{"$ref":"#/components/schemas/zones_http3"},{"$ref":"#/components/schemas/zones_image_resizing"},{"$ref":"#/components/schemas/zones_schemas-ip_geolocation"},{"$ref":"#/components/schemas/zones_ipv6"},{"$ref":"#/components/schemas/zones_max_upload"},{"$ref":"#/components/schemas/zones_min_tls_version"},{"$ref":"#/components/schemas/zones_schemas-mirage"},{"$ref":"#/components/schemas/zones_nel"},{"$ref":"#/components/schemas/zones_schemas-opportunistic_encryption"},{"$ref":"#/components/schemas/zones_opportunistic_onion"},{"$ref":"#/components/schemas/zones_orange_to_orange"},{"$ref":"#/components/schemas/zones_schemas-origin_error_page_pass_thru"},{"$ref":"#/components/schemas/zones_cache-rules_origin_h2_max_streams"},{"$ref":"#/components/schemas/zones_cache-rules_origin_max_http_version"},{"$ref":"#/components/schemas/zones_schemas-polish"},{"$ref":"#/components/schemas/zones_prefetch_preload"},{"$ref":"#/components/schemas/zones_privacy_pass"},{"$ref":"#/components/schemas/zones_proxy_read_timeout"},{"$ref":"#/components/schemas/zones_pseudo_ipv4"},{"$ref":"#/components/schemas/zones_replace_insecure_js"},{"$ref":"#/components/schemas/zones_schemas-response_buffering"},{"$ref":"#/components/schemas/zones_schemas-rocket_loader"},{"$ref":"#/components/schemas/zones_schemas-automatic_platform_optimization"},{"$ref":"#/components/schemas/zones_security_header"},{"$ref":"#/components/schemas/zones_schemas-security_level"},{"$ref":"#/components/schemas/zones_server_side_exclude"},{"$ref":"#/components/schemas/zones_sha1_support"},{"$ref":"#/components/schemas/zones_schemas-sort_query_string_for_cache"},{"$ref":"#/components/schemas/zones_schemas-ssl"},{"$ref":"#/components/schemas/zones_ssl_recommender"},{"$ref":"#/components/schemas/zones_tls_1_2_only"},{"$ref":"#/components/schemas/zones_tls_1_3"},{"$ref":"#/components/schemas/zones_tls_client_auth"},{"$ref":"#/components/schemas/zones_transformations"},{"$ref":"#/components/schemas/zones_transformations_allowed_origins"},{"$ref":"#/components/schemas/zones_schemas-true_client_ip_header"},{"$ref":"#/components/schemas/zones_schemas-waf"},{"$ref":"#/components/schemas/zones_webp"},{"$ref":"#/components/schemas/zones_websockets"}],"type":"object"},"zones_setting_name":{"description":"Setting name","example":"always_online","type":"string"},"zones_setting_readonly":{"enum":[false],"type":"boolean"},"zones_setting_toggle":{"description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_setting_value":{"oneOf":[{"$ref":"#/components/schemas/zones_0rtt_value"},{"$ref":"#/components/schemas/zones_advanced_ddos_value"},{"$ref":"#/components/schemas/zones_cache-rules_aegis_value"},{"$ref":"#/components/schemas/zones_always_online_value"},{"$ref":"#/components/schemas/zones_always_use_https_value"},{"$ref":"#/components/schemas/zones_automatic_https_rewrites_value"},{"$ref":"#/components/schemas/zones_brotli_value"},{"$ref":"#/components/schemas/zones_browser_cache_ttl_value"},{"$ref":"#/components/schemas/zones_browser_check_value"},{"$ref":"#/components/schemas/zones_cache_level_value"},{"$ref":"#/components/schemas/zones_challenge_ttl_value"},{"$ref":"#/components/schemas/zones_china_network_enabled_value"},{"$ref":"#/components/schemas/zones_ciphers_value"},{"$ref":"#/components/schemas/zones_cname_flattening_value"},{"$ref":"#/components/schemas/zones_development_mode_value"},{"$ref":"#/components/schemas/zones_early_hints_value"},{"$ref":"#/components/schemas/zones_edge_cache_ttl_value"},{"$ref":"#/components/schemas/zones_email_obfuscation_value"},{"$ref":"#/components/schemas/zones_h2_prioritization_value"},{"$ref":"#/components/schemas/zones_hotlink_protection_value"},{"$ref":"#/components/schemas/zones_http2_value"},{"$ref":"#/components/schemas/zones_http3_value"},{"$ref":"#/components/schemas/zones_image_resizing_value"},{"$ref":"#/components/schemas/zones_ip_geolocation_value"},{"$ref":"#/components/schemas/zones_ipv6_value"},{"$ref":"#/components/schemas/zones_max_upload_value"},{"$ref":"#/components/schemas/zones_min_tls_version_value"},{"$ref":"#/components/schemas/zones_mirage_value"},{"$ref":"#/components/schemas/zones_nel_value"},{"$ref":"#/components/schemas/zones_opportunistic_encryption_value"},{"$ref":"#/components/schemas/zones_opportunistic_onion_value"},{"$ref":"#/components/schemas/zones_orange_to_orange_value"},{"$ref":"#/components/schemas/zones_origin_error_page_pass_thru_value"},{"$ref":"#/components/schemas/zones_cache-rules_origin_h2_max_streams_value"},{"$ref":"#/components/schemas/zones_cache-rules_origin_max_http_version_value"},{"$ref":"#/components/schemas/zones_polish_value"},{"$ref":"#/components/schemas/zones_prefetch_preload_value"},{"$ref":"#/components/schemas/zones_privacy_pass_value"},{"$ref":"#/components/schemas/zones_proxy_read_timeout_value"},{"$ref":"#/components/schemas/zones_pseudo_ipv4_value"},{"$ref":"#/components/schemas/zones_replace_insecure_js_value"},{"$ref":"#/components/schemas/zones_response_buffering_value"},{"$ref":"#/components/schemas/zones_rocket_loader_value"},{"$ref":"#/components/schemas/zones_automatic_platform_optimization"},{"$ref":"#/components/schemas/zones_security_header_value"},{"$ref":"#/components/schemas/zones_security_level_value"},{"$ref":"#/components/schemas/zones_server_side_exclude_value"},{"$ref":"#/components/schemas/zones_sha1_support_value"},{"$ref":"#/components/schemas/zones_sort_query_string_for_cache_value"},{"$ref":"#/components/schemas/zones_ssl_value"},{"$ref":"#/components/schemas/zones_tls_1_2_only_value"},{"$ref":"#/components/schemas/zones_tls_1_3_value"},{"$ref":"#/components/schemas/zones_tls_client_auth_value"},{"$ref":"#/components/schemas/zones_true_client_ip_header_value"},{"$ref":"#/components/schemas/zones_waf_value"},{"$ref":"#/components/schemas/zones_webp_value"},{"$ref":"#/components/schemas/zones_websockets_value"}]},"zones_setting_writable":{"enum":[true],"type":"boolean"},"zones_settings":{"description":"Settings available for the zone.","example":[{"id":"browser_check","properties":[{"name":"value","type":"toggle"}]},{"id":"browser_cache_ttl","properties":[{"max":31536000,"min":1800,"name":"value","suggested_values":[1800,3600,7200,10800,14400,18000,28800,43200,57600,72000,86400,172800,259200,345600,432000,691200,1382400,2073600,2678400,5356800,16070400,31536000],"type":"range"}]},{"id":"browser_check","properties":[{"name":"value","type":"toggle"}]},{"id":"cache_key_fields","properties":[{"name":"value","properties":[{"allowEmpty":true,"choices":["include","exclude"],"multiple":false,"name":"query_string","type":"select"},{"allowEmpty":true,"choices":["include","exclude","check_presence"],"multiple":true,"name":"header","type":"select"},{"allowEmpty":false,"choices":["resolved"],"multiple":true,"name":"host","type":"select"},{"allowEmpty":true,"choices":["include","check_presence"],"multiple":true,"name":"cookie","type":"select"},{"allowEmpty":false,"choices":["device_type","geo","lang"],"multiple":true,"name":"user","type":"select"}],"type":"object"}]},{"id":"cache_deception_armor","properties":[{"name":"value","type":"toggle"}]},{"id":"cache_level","properties":[{"choices":["bypass","basic","simplified","aggressive","cache_everything"],"multiple":false,"name":"value","type":"select"}]},{"id":"cache_ttl_by_status","properties":[{"allowEmpty":false,"name":"value","type":"object"}]},{"id":"disable_apps","properties":[]},{"id":"disable_performance","properties":[]},{"id":"disable_security","properties":[]},{"id":"edge_cache_ttl","properties":[{"max":2419200,"min":7200,"name":"value","suggested_values":[7200,10800,14400,18000,28800,43200,57600,72000,86400,172800,259200,345600,432000,518400,604800,1209600,2419200],"type":"range"}]},{"id":"email_obfuscation","properties":[{"name":"value","type":"toggle"}]},{"id":"forwarding_url","properties":[{"choices":[301,302],"multiple":false,"name":"status_code","type":"choice"},{"name":"url","type":"forwardingUrl"}]},{"id":"ip_geolocation","properties":[{"name":"value","type":"toggle"}]},{"id":"explicit_cache_control","properties":[{"name":"value","type":"toggle"}]},{"id":"rocket_loader","properties":[{"name":"value","type":"toggle"}]},{"id":"security_level","properties":[{"choices":["essentially_off","low","medium","high","under_attack"],"multiple":false,"name":"value","type":"select"}]},{"id":"server_side_exclude","properties":[{"name":"value","type":"toggle"}]},{"id":"ssl","properties":[{"choices":["off","flexible","full","strict"],"multiple":false,"name":"value","type":"choice"}]}],"items":{"type":"object"},"type":"array"},"zones_settings-api_components-schemas-api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/zones_messages"},"messages":{"$ref":"#/components/schemas/zones_messages"},"success":{"description":"Whether the API call was successful","example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"zones_sha1_support":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"Zone setting identifier.","enum":["sha1_support"],"example":"sha1_support"},"value":{"$ref":"#/components/schemas/zones_sha1_support_value"}}}],"description":"Allow SHA1 support.","title":"Toggle SHA1 support"},"zones_sha1_support_value":{"default":"off","description":"Value of the zone setting.","enum":["off","on"],"type":"string"},"zones_sort_query_string_for_cache":{"properties":{"id":{"description":"Turn on or off the reordering of query strings. When query strings have the same structure, caching improves.\n","enum":["sort_query_string_for_cache"],"example":"sort_query_string_for_cache","type":"string","x-auditable":true},"value":{"description":"The status of Query String Sort\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"Query String Sort","type":"object","x-stainless-skip":["terraform"]},"zones_sort_query_string_for_cache_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_ssl":{"properties":{"id":{"description":"Control options for the SSL feature of the Edge Certificates tab in the Cloudflare SSL/TLS app.\n","enum":["ssl"],"type":"string","x-auditable":true},"value":{"description":"The encryption mode that Cloudflare uses to connect to your origin server.\n","enum":["off","flexible","full","strict","origin_pull"],"example":"full","type":"string","x-auditable":true}},"title":"SSL","type":"object","x-stainless-skip":["terraform"]},"zones_ssl_recommender":{"allOf":[{"properties":{"enabled":{"$ref":"#/components/schemas/zones_ssl_recommender_enabled"},"id":{"description":"Enrollment value for SSL/TLS Recommender.","enum":["ssl_recommender"],"example":"ssl_recommender"}}}],"description":"Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support.","title":"SSL/TLS Recommender"},"zones_ssl_recommender_enabled":{"default":false,"description":"ssl-recommender enrollment setting.","type":"boolean"},"zones_ssl_value":{"default":"off","description":"Value of the zone setting.\nNotes: Depends on the zone's plan level","enum":["off","flexible","full","strict"],"type":"string"},"zones_status":{"default":"disabled","description":"The status of the Page Rule.","enum":["active","disabled"],"example":"active","type":"string","x-auditable":true},"zones_string_constraint":{"description":"String constraint.","properties":{"operator":{"default":"contains","description":"The matches operator can use asterisks and pipes as wildcard and 'or' operators.","enum":["matches","contains","equals","not_equal","not_contain"],"x-auditable":true},"value":{"description":"The value to apply the operator to.","type":"string","x-auditable":true}},"required":["operator","value"],"type":"object"},"zones_target":{"description":"A request condition target.","oneOf":[{"$ref":"#/components/schemas/zones_url_target"}],"required":["target","constraint"]},"zones_targets":{"description":"The rule targets to evaluate on each request.","example":[{"constraint":{"operator":"matches","value":"*example.com/images/*"},"target":"url"}],"items":{"$ref":"#/components/schemas/zones_target"},"type":"array","x-stainless-skip":["terraform"]},"zones_tls_1_2_only":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"Zone setting identifier.","enum":["tls_1_2_only"],"example":"tls_1_2_only"},"value":{"$ref":"#/components/schemas/zones_tls_1_2_only_value"}}}],"description":"Only allows TLS1.2.","title":"TLS1.2 only"},"zones_tls_1_2_only_value":{"default":"off","description":"Value of the zone setting.","enum":["off","on"],"type":"string"},"zones_tls_1_3":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["tls_1_3"],"example":"tls_1_3"},"value":{"$ref":"#/components/schemas/zones_tls_1_3_value"}}}],"default":"off","description":"Enables Crypto TLS 1.3 feature for a zone.","title":"Enable TLS 1.3 value for a zone"},"zones_tls_1_3_value":{"default":"off","description":"Value of the zone setting.\nNotes: Default value depends on the zone's plan level.","enum":["on","off","zrt"],"type":"string"},"zones_tls_client_auth":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["tls_client_auth"],"example":"tls_client_auth"},"value":{"$ref":"#/components/schemas/zones_tls_client_auth_value"}}}],"description":"TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).","title":"TLS Client Authentication"},"zones_tls_client_auth_value":{"default":"on","description":"value of the zone setting.","enum":["on","off"],"type":"string"},"zones_transformations":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting. Shared between Image Transformations and Video Transformations.","enum":["transformations"],"example":"transformations"},"value":{"$ref":"#/components/schemas/zones_image_resizing_value"}}}],"description":"Media Transformations provides on-demand resizing, conversion and optimization for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information.","title":"Media Transformations"},"zones_transformations_allowed_origins":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting. Shared between Image Transformations and Video Transformations.","enum":["transformations_allowed_origins"],"example":"transformations_allowed_origins"},"value":{"$ref":"#/components/schemas/zones_transformations_allowed_origins_value"}}}],"description":"Media Transformations Allowed Origins restricts transformations for images and video served through Cloudflare's network. Refer to the [Image Transformations](https://developers.cloudflare.com/images/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information.","title":"Media Transformations Allowed Origins"},"zones_transformations_allowed_origins_value":{"description":"Comma-separated list of allowed origins.\nRefer to the [Image Transformations](https://developers.cloudflare.com/images/transform-images/sources/) and [Video Transformations](https://developers.cloudflare.com/stream/transform-videos/#getting-started) documentation for more information.","type":"string"},"zones_true_client_ip_header":{"properties":{"id":{"description":"Turn on or off the True-Client-IP Header feature of the Cloudflare Network app.\n","enum":["true_client_ip_header"],"example":"true_client_ip_header","type":"string","x-auditable":true},"value":{"description":"The status of True Client IP Header.\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"True Client IP Header","type":"object","x-stainless-skip":["terraform"]},"zones_true_client_ip_header_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_type":{"default":"full","description":"A full zone implies that DNS is hosted with Cloudflare. A partial zone is\ntypically a partner-hosted zone or a CNAME setup.\n","enum":["full","partial","secondary","internal"],"example":"full","type":"string"},"zones_url_target":{"description":"URL target.","properties":{"constraint":{"allOf":[{"$ref":"#/components/schemas/zones_string_constraint"},{"properties":{"value":{"description":"The URL pattern to match against the current request. The pattern may contain up to four asterisks ('*') as placeholders.","example":"*example.com/images/*","pattern":"^(https?://)?(([-a-zA-Z0-9*]*\\.)+[-a-zA-Z0-9]{2,20})(:(8080|8443|443|80))?(/[\\S]+)?$","type":"string","x-auditable":true}}}],"description":"The constraint of a target.","type":"object"},"target":{"description":"A target based on the URL of the request.","enum":["url"],"example":"url","x-auditable":true}},"type":"object"},"zones_vanity_name_servers":{"default":[],"description":"An array of domains used for custom name servers. This is only\navailable for Business and Enterprise plans.","example":["ns1.example.com","ns2.example.com"],"items":{"format":"hostname","maxLength":253,"type":"string"},"type":"array"},"zones_waf":{"properties":{"id":{"description":"Turn on or off [WAF managed rules (previous version, deprecated)](https://developers.cloudflare.com/waf/reference/legacy/old-waf-managed-rules/).\nYou cannot enable or disable individual WAF managed rules via Page Rules.\n","enum":["waf"],"example":"waf","type":"string","x-auditable":true},"value":{"description":"The status of WAF managed rules (previous version).\n","enum":["on","off"],"example":"on","type":"string","x-auditable":true}},"title":"WAF","type":"object","x-stainless-skip":["terraform"]},"zones_waf_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"zones_webp":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["webp"],"example":"webp"},"value":{"$ref":"#/components/schemas/zones_webp_value"}}}],"description":"When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.","title":"Polish WebP Conversion"},"zones_webp_value":{"default":"off","description":"Value of the zone setting.","enum":["off","on"],"type":"string"},"zones_websockets":{"allOf":[{"$ref":"#/components/schemas/zones_base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["websockets"],"example":"websockets"},"value":{"$ref":"#/components/schemas/zones_websockets_value"}}}],"description":"WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-).","title":"WebSockets"},"zones_websockets_value":{"default":"off","description":"Value of the zone setting.","enum":["off","on"],"type":"string"},"zones_zone":{"properties":{"account":{"description":"The account the zone belongs to.","properties":{"id":{"$ref":"#/components/schemas/zones_identifier"},"name":{"description":"The name of the account.","example":"Example Account Name","type":"string"}},"type":"object"},"activated_on":{"description":"The last time proof of ownership was detected and the zone was made\nactive.","example":"2014-01-02T00:01:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"cname_suffix":{"description":"Allows the customer to use a custom apex.\n*Tenants Only Configuration*.","example":"cdn.cloudflare.com","type":"string"},"created_on":{"description":"When the zone was created.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"development_mode":{"description":"The interval (in seconds) from when development mode expires\n(positive integer) or last expired (negative integer) for the\ndomain. If development mode has never been enabled, this value is 0.","example":7200,"readOnly":true,"type":"number"},"id":{"$ref":"#/components/schemas/zones_identifier"},"meta":{"description":"Metadata about the zone.","properties":{"cdn_only":{"description":"The zone is only configured for CDN.","example":true,"type":"boolean"},"custom_certificate_quota":{"description":"Number of Custom Certificates the zone can have.","example":1,"type":"integer"},"dns_only":{"description":"The zone is only configured for DNS.","example":true,"type":"boolean"},"foundation_dns":{"description":"The zone is setup with Foundation DNS.","example":true,"type":"boolean"},"page_rule_quota":{"description":"Number of Page Rules a zone can have.","example":100,"type":"integer"},"phishing_detected":{"description":"The zone has been flagged for phishing.","example":false,"type":"boolean"},"step":{"example":2,"type":"integer"}},"type":"object"},"modified_on":{"description":"When the zone was last modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"The domain name.","example":"example.com","maxLength":253,"pattern":"^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$","type":"string"},"name_servers":{"description":"The name servers Cloudflare assigns to a zone.","example":["bob.ns.cloudflare.com","lola.ns.cloudflare.com"],"items":{"format":"hostname","type":"string"},"readOnly":true,"type":"array"},"original_dnshost":{"description":"DNS host at the time of switching to Cloudflare.","example":"NameCheap","maxLength":50,"nullable":true,"readOnly":true,"type":"string"},"original_name_servers":{"description":"Original name servers before moving to Cloudflare.","example":["ns1.originaldnshost.com","ns2.originaldnshost.com"],"items":{"format":"hostname","type":"string"},"nullable":true,"readOnly":true,"type":"array"},"original_registrar":{"description":"Registrar for the domain at the time of switching to Cloudflare.","example":"GoDaddy","nullable":true,"readOnly":true,"type":"string"},"owner":{"description":"The owner of the zone.","properties":{"id":{"$ref":"#/components/schemas/zones_identifier"},"name":{"description":"Name of the owner.","example":"Example Org","type":"string"},"type":{"description":"The type of owner.","example":"organization","type":"string"}},"type":"object"},"paused":{"$ref":"#/components/schemas/zones_paused"},"permissions":{"deprecated":true,"description":"Legacy permissions based on legacy user membership information.","items":{"example":"#worker:read","type":"string"},"type":"array","x-stainless-deprecation-message":"This has been replaced by Account memberships."},"plan":{"deprecated":true,"description":"A Zones subscription information.","properties":{"can_subscribe":{"description":"States if the subscription can be activated.","example":false,"type":"boolean"},"currency":{"description":"The denomination of the customer.","example":"USD","type":"string"},"externally_managed":{"description":"If this Zone is managed by another company.","example":false,"type":"boolean"},"frequency":{"description":"How often the customer is billed.","example":"monthly","type":"string"},"id":{"$ref":"#/components/schemas/zones_identifier"},"is_subscribed":{"description":"States if the subscription active.","example":false,"type":"boolean"},"legacy_discount":{"description":"If the legacy discount applies to this Zone.","example":false,"type":"boolean"},"legacy_id":{"description":"The legacy name of the plan.","example":"free","type":"string"},"name":{"description":"Name of the owner.","example":"Example Org","type":"string"},"price":{"description":"How much the customer is paying.","example":10.99,"type":"number"}},"x-stainless-deprecation-message":"Please use the `/zones/{zone_id}/subscription` API\nto update a zone's plan. Changing this value will create/cancel\nassociated subscriptions. To view available plans for this zone,\nsee [Zone Plans](https://developers.cloudflare.com/api/resources/zones/subresources/plans/)."},"status":{"description":"The zone status on Cloudflare.","enum":["initializing","pending","active","moved"],"example":"active","readOnly":true,"type":"string"},"tenant":{"description":"The root organizational unit that this zone belongs to (such as a tenant or organization).","properties":{"id":{"$ref":"#/components/schemas/zones_identifier"},"name":{"description":"The name of the Tenant account.","example":"Example Account Name","type":"string"}}},"tenant_unit":{"description":"The immediate parent organizational unit that this zone belongs to (such as under a tenant or sub-organization).","properties":{"id":{"$ref":"#/components/schemas/zones_identifier"}}},"type":{"$ref":"#/components/schemas/zones_type"},"vanity_name_servers":{"default":[],"description":"An array of domains used for custom name servers. This is only available for Business and Enterprise plans.","example":["ns1.example.com","ns2.example.com"],"items":{"format":"hostname","maxLength":253,"type":"string"},"type":"array"},"verification_key":{"description":"Verification key for partial zone setup.","example":"284344499-1084221259","readOnly":true,"type":"string"}},"required":["id","name","development_mode","owner","account","meta","name_servers","original_name_servers","original_registrar","original_dnshost","created_on","modified_on","activated_on","plan"],"type":"object"},"zones_zone_settings_response_collection":{"allOf":[{"$ref":"#/components/schemas/zones_settings-api_components-schemas-api-response-common"},{"properties":{"result":{"items":{"anyOf":[{"$ref":"#/components/schemas/zones_0rtt"},{"$ref":"#/components/schemas/zones_advanced_ddos"},{"$ref":"#/components/schemas/zones_cache-rules_aegis"},{"$ref":"#/components/schemas/zones_always_online"},{"$ref":"#/components/schemas/zones_schemas-always_use_https"},{"$ref":"#/components/schemas/zones_schemas-automatic_https_rewrites"},{"$ref":"#/components/schemas/zones_brotli"},{"$ref":"#/components/schemas/zones_schemas-browser_cache_ttl"},{"$ref":"#/components/schemas/zones_schemas-browser_check"},{"$ref":"#/components/schemas/zones_schemas-cache_level"},{"$ref":"#/components/schemas/zones_challenge_ttl"},{"$ref":"#/components/schemas/zones_ciphers"},{"$ref":"#/components/schemas/zones_cname_flattening"},{"$ref":"#/components/schemas/zones_development_mode"},{"$ref":"#/components/schemas/zones_early_hints"},{"$ref":"#/components/schemas/zones_schemas-edge_cache_ttl"},{"$ref":"#/components/schemas/zones_schemas-email_obfuscation"},{"$ref":"#/components/schemas/zones_h2_prioritization"},{"$ref":"#/components/schemas/zones_hotlink_protection"},{"$ref":"#/components/schemas/zones_http2"},{"$ref":"#/components/schemas/zones_http3"},{"$ref":"#/components/schemas/zones_image_resizing"},{"$ref":"#/components/schemas/zones_schemas-ip_geolocation"},{"$ref":"#/components/schemas/zones_ipv6"},{"$ref":"#/components/schemas/zones_max_upload"},{"$ref":"#/components/schemas/zones_min_tls_version"},{"$ref":"#/components/schemas/zones_schemas-mirage"},{"$ref":"#/components/schemas/zones_nel"},{"$ref":"#/components/schemas/zones_schemas-opportunistic_encryption"},{"$ref":"#/components/schemas/zones_opportunistic_onion"},{"$ref":"#/components/schemas/zones_orange_to_orange"},{"$ref":"#/components/schemas/zones_schemas-origin_error_page_pass_thru"},{"$ref":"#/components/schemas/zones_cache-rules_origin_h2_max_streams"},{"$ref":"#/components/schemas/zones_cache-rules_origin_max_http_version"},{"$ref":"#/components/schemas/zones_schemas-polish"},{"$ref":"#/components/schemas/zones_prefetch_preload"},{"$ref":"#/components/schemas/zones_privacy_pass"},{"$ref":"#/components/schemas/zones_proxy_read_timeout"},{"$ref":"#/components/schemas/zones_pseudo_ipv4"},{"$ref":"#/components/schemas/zones_replace_insecure_js"},{"$ref":"#/components/schemas/zones_schemas-response_buffering"},{"$ref":"#/components/schemas/zones_schemas-rocket_loader"},{"$ref":"#/components/schemas/zones_schemas-automatic_platform_optimization"},{"$ref":"#/components/schemas/zones_security_header"},{"$ref":"#/components/schemas/zones_schemas-security_level"},{"$ref":"#/components/schemas/zones_server_side_exclude"},{"$ref":"#/components/schemas/zones_sha1_support"},{"$ref":"#/components/schemas/zones_schemas-sort_query_string_for_cache"},{"$ref":"#/components/schemas/zones_schemas-ssl"},{"$ref":"#/components/schemas/zones_ssl_recommender"},{"$ref":"#/components/schemas/zones_tls_1_2_only"},{"$ref":"#/components/schemas/zones_tls_1_3"},{"$ref":"#/components/schemas/zones_tls_client_auth"},{"$ref":"#/components/schemas/zones_transformations"},{"$ref":"#/components/schemas/zones_transformations_allowed_origins"},{"$ref":"#/components/schemas/zones_schemas-true_client_ip_header"},{"$ref":"#/components/schemas/zones_schemas-waf"},{"$ref":"#/components/schemas/zones_webp"},{"$ref":"#/components/schemas/zones_websockets"}]},"type":"array"}}}]},"zones_zone_settings_single_request":{"oneOf":[{"properties":{"enabled":{"$ref":"#/components/schemas/zones_ssl_recommender_enabled"}},"type":"object"},{"properties":{"value":{"$ref":"#/components/schemas/zones_setting_value"}},"type":"object"}]}},"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":{"url":"https://developers.cloudflare.com/realtime/realtimekit/"},"info":{"description":"Welcome to Cloudflare's API documentation site. We are experimenting with an updated version of our API documentation - check out [developers.cloudflare.com/api-next/](https://developers.cloudflare.com/api-next/) to test out the new experience.\n\nTo get started using Cloudflare's products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.\n\nUsing the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions. You can also authenticate with [API keys](https://developers.cloudflare.com/fundamentals/api/get-started/keys/), but these keys have [several limitations](https://developers.cloudflare.com/fundamentals/api/get-started/keys/#limitations) that make them less secure than API tokens. Whenever possible, use API tokens to interact with the Cloudflare API.\n\nTo create an API token, from the Cloudflare dashboard, go to My Profile \u003e API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to\nour [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).\n\nFor information regarding rate limits, refer to our [API Rate Limits](https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/platform/limits/#api-rate-limits).\n\nTotally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).","license":{"name":"BSD-3-Clause","url":"https://opensource.org/licenses/BSD-3-Clause"},"title":"Cloudflare API","version":"4.0.0"},"openapi":"3.0.3","paths":{"/accounts":{"get":{"description":"List all accounts you have ownership or verified access to.","operationId":"accounts-list-accounts","parameters":[{"in":"query","name":"name","schema":{"description":"Name of the account.","example":"example.com","readOnly":true,"type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"direction","schema":{"description":"Direction to order results.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_response_collection_accounts"}}},"description":"List Accounts response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"List Accounts response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Accounts","tags":["Accounts"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create an account (only available for tenant admins at this time)","operationId":"account-creation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_create-account"}}},"description":"Parameters for account creation","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_response_single_account"}}},"description":"Account Creation Success Response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Account Creation Failure Response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create an account","tags":["Accounts"],"x-cfPlanAvailability":{"business":false,"enterprise":false,"free":false,"pro":false}}},"/accounts/move":{"post":{"description":"Batch move a collection of accounts to a specific organization. ⚠️ Not implemented.","operationId":"Accounts_batchMoveAccounts","requestBody":{"content":{"application/json":{"schema":{"properties":{"account_ids":{"description":"Move these accounts to the destination organization.","items":{"type":"string"},"type":"array"},"destination_organization_id":{"description":"Move accounts to this organization ID.","type":"string"}},"required":["account_ids","destination_organization_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"$ref":"#/components/schemas/organizations-api_BatchAccountMoveResponse"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Batch move accounts","tags":["Accounts"]}},"/accounts/{account_identifier}/custom_pages":{"get":{"description":"Fetches all the custom pages at the account level.","operationId":"custom-pages-for-an-account-list-custom-pages","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-pages_custom_page_result_list"}}},"description":"List custom pages response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-pages_custom_page_result_list"},{"$ref":"#/components/schemas/custom-pages_api-response-common-failure"}]}}},"description":"List custom pages response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List custom pages","tags":["Custom pages for an account"],"x-api-token-group":["Zero Trust: PII Read","Account Custom Pages Write","Account Custom Pages Read","Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_identifier}/custom_pages/{identifier}":{"get":{"description":"Fetches the details of a custom page.","operationId":"custom-pages-for-an-account-get-a-custom-page","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_error_page_type"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-pages_custom_page_result"}}},"description":"Get a custom page response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-pages_custom_page_result"},{"$ref":"#/components/schemas/custom-pages_api-response-common-failure"}]}}},"description":"Get a custom page response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a custom page","tags":["Custom pages for an account"],"x-api-token-group":["Zero Trust: PII Read","Account Custom Pages Write","Account Custom Pages Read","Account Settings Write","Account Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Updates the configuration of an existing custom page.","operationId":"custom-pages-for-an-account-update-a-custom-page","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_error_page_type"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"state":{"$ref":"#/components/schemas/custom-pages_state"},"url":{"$ref":"#/components/schemas/custom-pages_url"}},"required":["url","state"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-pages_custom_page_result"}}},"description":"Update a custom page response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-pages_custom_page_result"},{"$ref":"#/components/schemas/custom-pages_api-response-common-failure"}]}}},"description":"Update a custom page response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update a custom page","tags":["Custom pages for an account"],"x-api-token-group":["Account Custom Pages Write","Account Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}":{"delete":{"description":"Delete a specific account (only available for tenant admins at this time). This is a permanent operation that will delete any zones or other resources under the account","operationId":"account-deletion","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"description":"The account ID of the account to be deleted","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-single-id"}}},"description":"Account Deletion Success Response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Account Deletion Failure Response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a specific account","tags":["Accounts"],"x-api-token-group":["Account Settings Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":false,"free":false,"pro":false}},"get":{"description":"Get information about a specific account that you are a member of.","operationId":"accounts-account-details","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_response_single_account"}}},"description":"Account Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Account Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Account Details","tags":["Accounts"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","DNS View Write","DNS View Read","SCIM Provisioning","Load Balancers Account Write","Load Balancers Account Read","Zero Trust: PII Read","DDoS Botnet Feed Write","DDoS Botnet Feed Read","Workers R2 Storage Write","Workers R2 Storage Read","DDoS Protection Write","DDoS Protection Read","Workers Tail Read","Workers KV Storage Write","Workers KV Storage Read","Workers Scripts Write","Workers Scripts Read","Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read","Account Firewall Access Rules Write","Account Firewall Access Rules Read","DNS Firewall Write","DNS Firewall Read","Billing Write","Billing Read","Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Update an existing account.","operationId":"accounts-update-account","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_components-schemas-account"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_response_single_account"}}},"description":"Update Account response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Update Account response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update Account","tags":["Accounts"],"x-api-token-group":["Account Settings Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/abuse-reports":{"get":{"description":"List the abuse reports for a given account","operationId":"ListAbuseReports","parameters":[{"description":"Cloudflare Account ID","in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string"}},{"description":"Where in pagination to start listing abuse reports","in":"query","name":"page","schema":{"type":"integer"}},{"description":"How many abuse reports per page to list","in":"query","name":"per_page","schema":{"type":"integer"}},{"description":"A property to sort by, followed by the order (id, cdate, domain, type, status)","example":"cdate,desc","in":"query","name":"sort","schema":{"type":"string"}},{"description":"Filter by domain name related to the abuse report","example":"example.com","in":"query","name":"domain","schema":{"type":"string"}},{"description":"Returns reports created before the specified date","example":"2009-11-10T23:00:00Z","in":"query","name":"created_before","schema":{"description":"Time in RFC 3339 format (https://www.rfc-editor.org/rfc/rfc3339.html)","example":"2009-11-10T23:00:00Z","type":"string"}},{"description":"Returns reports created after the specified date","example":"2009-11-10T23:00:00Z","in":"query","name":"created_after","schema":{"description":"Time in RFC 3339 format (https://www.rfc-editor.org/rfc/rfc3339.html)","example":"2009-11-10T23:00:00Z","type":"string"}},{"description":"Filter by the status of the report.","example":"denied","in":"query","name":"status","schema":{"$ref":"#/components/schemas/abuse-reports_ReportStatus"}},{"description":"Filter by the type of the report.","example":"denied","in":"query","name":"type","schema":{"$ref":"#/components/schemas/abuse-reports_ReportType"}},{"description":"Filter reports that have any mitigations in the given status.","example":"active","in":"query","name":"mitigation_status","schema":{"$ref":"#/components/schemas/abuse-reports_MitigationStatus"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"result":{"properties":{"reports":{"items":{"$ref":"#/components/schemas/abuse-reports_AbuseReport"},"type":"array"}},"required":["reports"],"type":"object"},"result_info":{"properties":{"count":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"},"total_pages":{"type":"number"}},"required":["page","per_page","count","total_count","total_pages"],"type":"object"},"success":{"type":"boolean"}},"required":["success"],"type":"object"}}},"description":"Abuse report list successful"},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"success":{"type":"boolean"}},"required":["success"],"type":"object"}}},"description":"Failed to retrieve abuse reports"}},"security":[{"api_token":[]}],"summary":"List abuse reports","tags":["tseng-abuse-complaint-processor_other"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read"]}},"/accounts/{account_id}/abuse-reports/{report_id}/mitigations":{"get":{"description":"List mitigations done to remediate the abuse report.","operationId":"ListMitigations","parameters":[{"description":"Cloudflare Account ID","in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string"}},{"description":"Abuse Report ID","in":"path","name":"report_id","required":true,"schema":{"type":"string"}},{"description":"Where in pagination to start listing abuse reports","in":"query","name":"page","schema":{"type":"integer"}},{"description":"How many abuse reports per page to list","in":"query","name":"per_page","schema":{"type":"integer"}},{"description":"A property to sort by, followed by the order","example":"type,desc","in":"query","name":"sort","schema":{"enum":["type,asc","type,desc","effective_date,asc","effective_date,desc","status,asc","status,desc","entity_type,asc","entity_type,desc"],"type":"string"}},{"description":"Filter by the type of mitigation. This filter parameter can be specified multiple times to include multiple types of mitigations in the result set, e.g. ?type=rate_limit_cache\u0026type=legal_block.","in":"query","name":"type","schema":{"$ref":"#/components/schemas/abuse-reports_MitigationType"}},{"description":"Returns mitigations that were dispatched before the given date","example":"2009-11-10T23:00:00Z","in":"query","name":"effective_before","schema":{"description":"Time in RFC 3339 format (https://www.rfc-editor.org/rfc/rfc3339.html)","example":"2009-11-10T23:00:00Z","type":"string"}},{"description":"Returns mitigation that were dispatched after the given date","example":"2009-11-10T23:00:00Z","in":"query","name":"effective_after","schema":{"description":"Time in RFC 3339 format (https://www.rfc-editor.org/rfc/rfc3339.html)","example":"2009-11-10T23:00:00Z","type":"string"}},{"description":"Filter by the status of the mitigation.","in":"query","name":"status","schema":{"$ref":"#/components/schemas/abuse-reports_MitigationStatus"}},{"description":"Filter by the type of entity the mitigation impacts.","in":"query","name":"entity_type","schema":{"$ref":"#/components/schemas/abuse-reports_MitigatedEntityType"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"result":{"properties":{"mitigations":{"items":{"$ref":"#/components/schemas/abuse-reports_MitigationListItem"},"type":"array"}},"required":["mitigations"],"type":"object"},"result_info":{"properties":{"count":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"},"total_pages":{"type":"number"}},"required":["page","per_page","count","total_count","total_pages"],"type":"object"},"success":{"type":"boolean"}},"required":["success"],"type":"object"}}},"description":"List abuse report mitigations successful"},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"success":{"type":"boolean"}},"required":["success"],"type":"object"}}},"description":"Failed to list abuse report mitigations"}},"security":[{"api_token":[]}],"summary":"List abuse report mitigations","tags":["tseng-abuse-complaint-processor_other"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read"]}},"/accounts/{account_id}/abuse-reports/{report_id}/mitigations/appeal":{"post":{"description":"Request a review for mitigations on an account.","operationId":"RequestReview","parameters":[{"description":"Cloudflare Account ID","in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string"}},{"description":"Abuse Report ID","in":"path","name":"report_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/abuse-reports_MitigationAppealRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/abuse-reports_MitigationAppealResult"}}},"description":"Mitigation appeals received"},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"success":{"type":"boolean"}},"required":["success"],"type":"object"}}},"description":"Failed to request review on delayed action."}},"security":[{"api_token":[]}],"summary":"Request review on mitigations","tags":["tseng-abuse-complaint-processor_other"],"x-api-token-group":["Trust and Safety Write"]}},"/accounts/{account_id}/abuse-reports/{report_param}":{"get":{"description":"Retrieve the details of an abuse report.","operationId":"GetAbuseReport","parameters":[{"description":"Cloudflare Account ID","in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string"}},{"description":"Identifier of the abuse report","in":"path","name":"report_param","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/abuse-reports_ErrorMessage"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"result":{"$ref":"#/components/schemas/abuse-reports_AbuseReport"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Report submitted successfully"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/abuse-reports_ErrorMessage"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"result":{"$ref":"#/components/schemas/abuse-reports_AbuseReport"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Report submitted with an error"},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/abuse-reports_ErrorMessage"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/abuse-reports_Message"},"type":"array"},"result":{"$ref":"#/components/schemas/abuse-reports_AbuseReport"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Report submitted with an error"}},"security":[{"api_token":[]}],"summary":"Abuse Report Details","tags":["tseng-abuse-complaint-processor_other"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read"]},"post":{"description":"Submit the Abuse Report of a particular type","operationId":"SubmitAbuseReport","parameters":[{"description":"Cloudflare Account ID","in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string"}},{"description":"The report type to be submitted. Example: abuse_general","in":"path","name":"report_param","required":true,"schema":{"$ref":"#/components/schemas/abuse-reports_SubmissionReportType"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/abuse-reports_SubmitReportRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/abuse-reports_SubmitReportResponse"}}},"description":"Report submitted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/abuse-reports_SubmitErrorResponse"}}},"description":"Report submitted with an error"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/abuse-reports_SubmitErrorResponse"}}},"description":"Report submitted with an error"}},"security":[{"api_token":[]}],"summary":"Submit an abuse report","tags":["tseng-abuse-complaint-processor_other"]}},"/accounts/{account_id}/access/ai-controls/mcp/portals":{"get":{"operationId":"mcp-portals-api-list-portals","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"a86a8f5c339544d7bdc89926de14fb8c","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"in":"query","name":"search","schema":{"description":"Search by id, name, hostname","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"readOnly":true,"type":"string"},"description":{"example":"This is my custom MCP Portal","maxLength":512,"type":"string"},"hostname":{"example":"exmaple.com","pattern":"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$","type":"string"},"id":{"description":"portal id","example":"my-mcp-portal","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"modified_at":{"format":"date-time","readOnly":true,"type":"string"},"modified_by":{"readOnly":true,"type":"string"},"name":{"example":"My MCP Portal","maxLength":350,"type":"string"}},"required":["id","name","hostname"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"List objects"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List MCP Portals","tags":["MCP Portal"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.mcp_portals"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"mcp-portals-api-create-portals","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"a86a8f5c339544d7bdc89926de14fb8c","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"example":"This is my custom MCP Portal","maxLength":512,"type":"string"},"hostname":{"example":"exmaple.com","pattern":"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$","type":"string"},"id":{"description":"portal id","example":"my-mcp-portal","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"name":{"example":"My MCP Portal","maxLength":350,"type":"string"},"servers":{"items":{"properties":{"default_disabled":{"default":false,"type":"boolean"},"on_behalf":{"default":true,"type":"boolean"},"server_id":{"description":"server id","example":"my-mcp-server","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"updated_prompts":{"items":{"properties":{"description":{"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"},"updated_tools":{"items":{"properties":{"description":{"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"}},"required":["server_id"],"type":"object"},"maxItems":20,"type":"array"}},"required":["id","name","hostname"],"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"readOnly":true,"type":"string"},"description":{"example":"This is my custom MCP Portal","maxLength":512,"type":"string"},"hostname":{"example":"exmaple.com","pattern":"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$","type":"string"},"id":{"description":"portal id","example":"my-mcp-portal","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"modified_at":{"format":"date-time","readOnly":true,"type":"string"},"modified_by":{"readOnly":true,"type":"string"},"name":{"example":"My MCP Portal","maxLength":350,"type":"string"}},"required":["id","name","hostname"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the created Object"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7001,"type":"number"},"message":{"example":"Input Validation Error","type":"string"},"path":{"items":{"example":"body","type":"string"},"type":"array"}},"required":["code","message","path"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Input Validation Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a new MCP Portal","tags":["MCP Portal"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.mcp_portals"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/access/ai-controls/mcp/portals/{id}":{"delete":{"operationId":"mcp-portals-api-delete-portals","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"a86a8f5c339544d7bdc89926de14fb8c","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"description":"portal id","example":"my-mcp-portal","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"readOnly":true,"type":"string"},"description":{"example":"This is my custom MCP Portal","maxLength":512,"type":"string"},"hostname":{"example":"exmaple.com","pattern":"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$","type":"string"},"id":{"description":"portal id","example":"my-mcp-portal","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"modified_at":{"format":"date-time","readOnly":true,"type":"string"},"modified_by":{"readOnly":true,"type":"string"},"name":{"example":"My MCP Portal","maxLength":350,"type":"string"}},"required":["id","name","hostname"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the Object if it was successfully deleted"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a MCP Portal","tags":["MCP Portal"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.mcp_portals"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"mcp-portals-api-fetch-gateways","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"portal id","example":"my-mcp-portal","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"example":"a86a8f5c339544d7bdc89926de14fb8c","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"readOnly":true,"type":"string"},"description":{"example":"This is my custom MCP Portal","maxLength":512,"type":"string"},"hostname":{"example":"exmaple.com","pattern":"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$","type":"string"},"id":{"description":"portal id","example":"my-mcp-portal","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"modified_at":{"format":"date-time","readOnly":true,"type":"string"},"modified_by":{"readOnly":true,"type":"string"},"name":{"example":"My MCP Portal","maxLength":350,"type":"string"},"servers":{"items":{"properties":{"auth_type":{"enum":["oauth","bearer","unauthenticated"],"example":"unauthenticated","type":"string"},"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"readOnly":true,"type":"string"},"default_disabled":{"default":false,"type":"boolean"},"description":{"example":"This is one remote mcp server","maxLength":512,"nullable":true,"type":"string"},"error":{"readOnly":true,"type":"string"},"hostname":{"example":"https://exmaple.com/mcp","format":"uri","type":"string"},"id":{"description":"server id","example":"my-mcp-server","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"last_synced":{"format":"date-time","readOnly":true,"type":"string"},"modified_at":{"format":"date-time","readOnly":true,"type":"string"},"modified_by":{"readOnly":true,"type":"string"},"name":{"example":"My MCP Server","maxLength":350,"type":"string"},"on_behalf":{"default":true,"type":"boolean"},"prompts":{"items":{"additionalProperties":{},"type":"object"},"readOnly":true,"type":"array"},"status":{"default":"waiting","readOnly":true,"type":"string"},"tools":{"items":{"additionalProperties":{},"type":"object"},"readOnly":true,"type":"array"},"updated_prompts":{"items":{"additionalProperties":{"anyOf":[{"type":"number"},{"type":"string"}]},"type":"object"},"type":"array"},"updated_tools":{"items":{"additionalProperties":{"anyOf":[{"type":"number"},{"type":"string"}]},"type":"object"},"type":"array"}},"required":["id","name","hostname","auth_type","tools","prompts","updated_tools","updated_prompts"],"type":"object"},"type":"array"}},"required":["id","name","hostname","servers"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns a single object if found"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Read details of an MCP Portal","tags":["MCP Portal"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.mcp_portals"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"operationId":"mcp-portals-api-update-portals","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"portal id","example":"my-mcp-portal","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"example":"a86a8f5c339544d7bdc89926de14fb8c","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"example":"This is my custom MCP Portal","maxLength":512,"type":"string"},"hostname":{"example":"exmaple.com","pattern":"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$","type":"string"},"name":{"example":"My MCP Portal","maxLength":350,"type":"string"},"servers":{"items":{"properties":{"default_disabled":{"default":false,"type":"boolean"},"on_behalf":{"default":true,"type":"boolean"},"server_id":{"description":"server id","example":"my-mcp-server","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"updated_prompts":{"items":{"properties":{"description":{"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"},"updated_tools":{"items":{"properties":{"description":{"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"}},"required":["server_id"],"type":"object"},"maxItems":20,"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"readOnly":true,"type":"string"},"description":{"example":"This is my custom MCP Portal","maxLength":512,"type":"string"},"hostname":{"example":"exmaple.com","pattern":"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$","type":"string"},"id":{"description":"portal id","example":"my-mcp-portal","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"modified_at":{"format":"date-time","readOnly":true,"type":"string"},"modified_by":{"readOnly":true,"type":"string"},"name":{"example":"My MCP Portal","maxLength":350,"type":"string"}},"required":["id","name","hostname"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the updated Object"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7001,"type":"number"},"message":{"example":"Input Validation Error","type":"string"},"path":{"items":{"example":"body","type":"string"},"type":"array"}},"required":["code","message","path"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Input Validation Error"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update a MCP Portal","tags":["MCP Portal"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.mcp_portals"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/access/ai-controls/mcp/servers":{"get":{"operationId":"mcp-portals-api-list-servers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"a86a8f5c339544d7bdc89926de14fb8c","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"in":"query","name":"search","schema":{"description":"Search by id, name","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"auth_type":{"enum":["oauth","bearer","unauthenticated"],"example":"unauthenticated","type":"string"},"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"readOnly":true,"type":"string"},"description":{"example":"This is one remote mcp server","maxLength":512,"nullable":true,"type":"string"},"error":{"readOnly":true,"type":"string"},"hostname":{"example":"https://exmaple.com/mcp","format":"uri","type":"string"},"id":{"description":"server id","example":"my-mcp-server","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"last_synced":{"format":"date-time","readOnly":true,"type":"string"},"modified_at":{"format":"date-time","readOnly":true,"type":"string"},"modified_by":{"readOnly":true,"type":"string"},"name":{"example":"My MCP Server","maxLength":350,"type":"string"},"prompts":{"items":{"additionalProperties":{},"type":"object"},"readOnly":true,"type":"array"},"status":{"default":"waiting","readOnly":true,"type":"string"},"tools":{"items":{"additionalProperties":{},"type":"object"},"readOnly":true,"type":"array"}},"required":["id","name","hostname","auth_type","tools","prompts"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"List objects"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List MCP Servers","tags":["MCP Portal Servers"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.mcp_portals"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"mcp-portals-api-create-servers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"a86a8f5c339544d7bdc89926de14fb8c","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"auth_credentials":{"type":"string"},"auth_type":{"enum":["oauth","bearer","unauthenticated"],"example":"unauthenticated","type":"string"},"description":{"example":"This is one remote mcp server","maxLength":512,"nullable":true,"type":"string"},"hostname":{"example":"https://exmaple.com/mcp","format":"uri","type":"string"},"id":{"description":"server id","example":"my-mcp-server","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"name":{"example":"My MCP Server","maxLength":350,"type":"string"}},"required":["id","name","hostname","auth_type"],"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"auth_type":{"enum":["oauth","bearer","unauthenticated"],"example":"unauthenticated","type":"string"},"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"readOnly":true,"type":"string"},"description":{"example":"This is one remote mcp server","maxLength":512,"nullable":true,"type":"string"},"error":{"readOnly":true,"type":"string"},"hostname":{"example":"https://exmaple.com/mcp","format":"uri","type":"string"},"id":{"description":"server id","example":"my-mcp-server","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"last_synced":{"format":"date-time","readOnly":true,"type":"string"},"modified_at":{"format":"date-time","readOnly":true,"type":"string"},"modified_by":{"readOnly":true,"type":"string"},"name":{"example":"My MCP Server","maxLength":350,"type":"string"},"prompts":{"items":{"additionalProperties":{},"type":"object"},"readOnly":true,"type":"array"},"status":{"default":"waiting","readOnly":true,"type":"string"},"tools":{"items":{"additionalProperties":{},"type":"object"},"readOnly":true,"type":"array"}},"required":["id","name","hostname","auth_type","tools","prompts"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the created Object"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7001,"type":"number"},"message":{"example":"Input Validation Error","type":"string"},"path":{"items":{"example":"body","type":"string"},"type":"array"}},"required":["code","message","path"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Input Validation Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a new MCP Server","tags":["MCP Portal Servers"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.mcp_portals"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/access/ai-controls/mcp/servers/{id}":{"delete":{"operationId":"mcp-portals-api-delete-servers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"a86a8f5c339544d7bdc89926de14fb8c","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"description":"server id","example":"my-mcp-server","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"auth_type":{"enum":["oauth","bearer","unauthenticated"],"example":"unauthenticated","type":"string"},"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"readOnly":true,"type":"string"},"description":{"example":"This is one remote mcp server","maxLength":512,"nullable":true,"type":"string"},"error":{"readOnly":true,"type":"string"},"hostname":{"example":"https://exmaple.com/mcp","format":"uri","type":"string"},"id":{"description":"server id","example":"my-mcp-server","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"last_synced":{"format":"date-time","readOnly":true,"type":"string"},"modified_at":{"format":"date-time","readOnly":true,"type":"string"},"modified_by":{"readOnly":true,"type":"string"},"name":{"example":"My MCP Server","maxLength":350,"type":"string"},"prompts":{"items":{"additionalProperties":{},"type":"object"},"readOnly":true,"type":"array"},"status":{"default":"waiting","readOnly":true,"type":"string"},"tools":{"items":{"additionalProperties":{},"type":"object"},"readOnly":true,"type":"array"}},"required":["id","name","hostname","auth_type","tools","prompts"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the Object if it was successfully deleted"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a MCP Server","tags":["MCP Portal Servers"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.mcp_portals"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"mcp-portals-api-fetch-servers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"a86a8f5c339544d7bdc89926de14fb8c","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"description":"server id","example":"my-mcp-server","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"auth_type":{"enum":["oauth","bearer","unauthenticated"],"example":"unauthenticated","type":"string"},"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"readOnly":true,"type":"string"},"description":{"example":"This is one remote mcp server","maxLength":512,"nullable":true,"type":"string"},"error":{"readOnly":true,"type":"string"},"hostname":{"example":"https://exmaple.com/mcp","format":"uri","type":"string"},"id":{"description":"server id","example":"my-mcp-server","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"last_synced":{"format":"date-time","readOnly":true,"type":"string"},"modified_at":{"format":"date-time","readOnly":true,"type":"string"},"modified_by":{"readOnly":true,"type":"string"},"name":{"example":"My MCP Server","maxLength":350,"type":"string"},"prompts":{"items":{"additionalProperties":{},"type":"object"},"readOnly":true,"type":"array"},"status":{"default":"waiting","readOnly":true,"type":"string"},"tools":{"items":{"additionalProperties":{},"type":"object"},"readOnly":true,"type":"array"}},"required":["id","name","hostname","auth_type","tools","prompts"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns a single object if found"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Read the details of a MCP Server","tags":["MCP Portal Servers"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.mcp_portals"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"operationId":"mcp-portals-api-update-servers","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"server id","example":"my-mcp-server","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"example":"a86a8f5c339544d7bdc89926de14fb8c","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"auth_credentials":{"type":"string"},"description":{"example":"This is one remote mcp server","maxLength":512,"nullable":true,"type":"string"},"name":{"example":"My MCP Server","maxLength":350,"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"auth_type":{"enum":["oauth","bearer","unauthenticated"],"example":"unauthenticated","type":"string"},"created_at":{"format":"date-time","readOnly":true,"type":"string"},"created_by":{"readOnly":true,"type":"string"},"description":{"example":"This is one remote mcp server","maxLength":512,"nullable":true,"type":"string"},"error":{"readOnly":true,"type":"string"},"hostname":{"example":"https://exmaple.com/mcp","format":"uri","type":"string"},"id":{"description":"server id","example":"my-mcp-server","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"},"last_synced":{"format":"date-time","readOnly":true,"type":"string"},"modified_at":{"format":"date-time","readOnly":true,"type":"string"},"modified_by":{"readOnly":true,"type":"string"},"name":{"example":"My MCP Server","maxLength":350,"type":"string"},"prompts":{"items":{"additionalProperties":{},"type":"object"},"readOnly":true,"type":"array"},"status":{"default":"waiting","readOnly":true,"type":"string"},"tools":{"items":{"additionalProperties":{},"type":"object"},"readOnly":true,"type":"array"}},"required":["id","name","hostname","auth_type","tools","prompts"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the updated Object"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7001,"type":"number"},"message":{"example":"Input Validation Error","type":"string"},"path":{"items":{"example":"body","type":"string"},"type":"array"}},"required":["code","message","path"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Input Validation Error"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update a MCP Server","tags":["MCP Portal Servers"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.mcp_portals"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/access/ai-controls/mcp/servers/{id}/sync":{"post":{"operationId":"mcp-portals-api-sync-server","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"portal id","example":"my-mcp-portal","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"example":"a86a8f5c339544d7bdc89926de14fb8c","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":""},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Sync MCP Server Capabilities","tags":["MCP Portal Servers"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.mcp_portals"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/access/apps":{"get":{"description":"Lists all Access applications in an account.","operationId":"access-applications-list-access-applications","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"query","name":"name","schema":{"description":"The name of the app.","type":"string"}},{"in":"query","name":"domain","schema":{"description":"The domain of the app.","type":"string"}},{"in":"query","name":"aud","schema":{"description":"The aud of the app.","type":"string"}},{"in":"query","name":"target_attributes","schema":{"description":"Target Criteria attributes in key=value format.","type":"string"}},{"in":"query","name":"exact","schema":{"description":"True for only exact string matches against passed name/domain query parameters.","type":"boolean"}},{"in":"query","name":"search","schema":{"description":"Search for apps by other listed query parameters.","type":"string"}},{"$ref":"#/components/parameters/access_page"},{"$ref":"#/components/parameters/access_per_page"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_apps_components-schemas-response_collection"}}},"description":"List Access applications response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List Access applications response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Access applications","tags":["Access applications"],"x-api-token-group":["Access: Apps and Policies Revoke","Access: Apps and Policies Write","Access: Apps and Policies Read"]},"post":{"description":"Adds a new application to Access.","operationId":"access-applications-add-an-application","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app_request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/access_apps_components-schemas-single_response"},{"properties":{"result":{"$ref":"#/components/schemas/access_app_response"}}}]}}},"description":"Add an Access application response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Add an Access application response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Add an Access application","tags":["Access applications"],"x-api-token-group":["Access: Apps and Policies Write"]}},"/accounts/{account_id}/access/apps/ca":{"get":{"description":"Lists short-lived certificate CAs and their public keys.","operationId":"access-short-lived-certificate-c-as-list-short-lived-certificate-c-as","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"$ref":"#/components/parameters/access_page"},{"in":"query","name":"per_page","schema":{"default":100,"description":"Number of results per page.","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_ca_components-schemas-response_collection"}}},"description":"List short-lived certificate CAs response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List short-lived certificate CAs response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List short-lived certificate CAs","tags":["Access short-lived certificate CAs"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read"]}},"/accounts/{account_id}/access/apps/{app_id}":{"delete":{"description":"Deletes an application from Access.","operationId":"access-applications-delete-an-access-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_id_response"}}},"description":"Delete an Access application response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete an Access application response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an Access application","tags":["Access applications"],"x-api-token-group":["Access: Apps and Policies Write"]},"get":{"description":"Fetches information about an Access application.","operationId":"access-applications-get-an-access-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_apps_components-schemas-single_response"}}},"description":"Get an Access application response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get an Access application response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get an Access application","tags":["Access applications"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read"]},"put":{"description":"Updates an Access application.","operationId":"access-applications-update-an-access-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/access_apps_components-schemas-single_response"},{"properties":{"result":{"$ref":"#/components/schemas/access_app_response"}}}]}}},"description":"Update an Access application response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update an Access application response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an Access application","tags":["Access applications"],"x-api-token-group":["Access: Apps and Policies Write"]}},"/accounts/{account_id}/access/apps/{app_id}/ca":{"delete":{"description":"Deletes a short-lived certificate CA.","operationId":"access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-id_response"}}},"description":"Delete a short-lived certificate CA response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete a short-lived certificate CA response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a short-lived certificate CA","tags":["Access short-lived certificate CAs"],"x-api-token-group":["Access: Apps and Policies Write"]},"get":{"description":"Fetches a short-lived certificate CA and its public key.","operationId":"access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_ca_components-schemas-single_response"}}},"description":"Get a short-lived certificate CA response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get a short-lived certificate CA response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a short-lived certificate CA","tags":["Access short-lived certificate CAs"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read"]},"post":{"description":"Generates a new short-lived certificate CA and public key.","operationId":"access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_ca_components-schemas-single_response"}}},"description":"Create a short-lived certificate CA response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create a short-lived certificate CA response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a short-lived certificate CA","tags":["Access short-lived certificate CAs"],"x-api-token-group":["Access: Apps and Policies Write"]}},"/accounts/{account_id}/access/apps/{app_id}/policies":{"get":{"description":"Lists Access policies configured for an application. Returns both exclusively scoped and reusable policies used by the application.","operationId":"access-policies-list-access-app-policies","parameters":[{"description":"The application ID.","in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"$ref":"#/components/parameters/access_page"},{"in":"query","name":"per_page","schema":{"default":200,"description":"Number of results per page.","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app-policies_components-schemas-response_collection"}}},"description":"List Access application policies response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List Access application policies response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Access application policies","tags":["Access application-scoped policies"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read"]},"post":{"description":"Creates a policy applying exclusive to a single application that defines the users or groups who can reach it. We recommend creating a reusable policy instead and subsequently referencing its ID in the application's 'policies' array.","operationId":"access-policies-create-an-access-policy","parameters":[{"description":"The application ID.","in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app_policy_request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app-policies_components-schemas-single_response"}}},"description":"Create an Access application policy response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create an Access application policy response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create an Access application policy","tags":["Access application-scoped policies"],"x-api-token-group":["Access: Apps and Policies Write"]}},"/accounts/{account_id}/access/apps/{app_id}/policies/{policy_id}":{"delete":{"description":"Deletes an Access policy specific to an application. To delete a reusable policy, use the /accounts/{account_id}/policies/{uid} endpoint.","operationId":"access-policies-delete-an-access-policy","parameters":[{"description":"The application ID.","in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"description":"The policy ID.","in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app-policies_components-schemas-id_response"}}},"description":"Delete an Access application policy response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete an Access application policy response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an Access application policy","tags":["Access application-scoped policies"],"x-api-token-group":["Access: Apps and Policies Write"]},"get":{"description":"Fetches a single Access policy configured for an application. Returns both exclusively owned and reusable policies used by the application.","operationId":"access-policies-get-an-access-policy","parameters":[{"description":"The application ID.","in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"description":"The policy ID.","in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app-policies_components-schemas-single_response"}}},"description":"Get an Access policy response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get an Access policy response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get an Access application policy","tags":["Access application-scoped policies"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read"]},"put":{"description":"Updates an Access policy specific to an application. To update a reusable policy, use the /accounts/{account_id}/policies/{uid} endpoint.","operationId":"access-policies-update-an-access-policy","parameters":[{"description":"The application ID.","in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"description":"The policy ID.","in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app_policy_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app-policies_components-schemas-single_response"}}},"description":"Update an Access application policy response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update an Access application policy response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an Access application policy","tags":["Access application-scoped policies"],"x-api-token-group":["Access: Apps and Policies Write"]}},"/accounts/{account_id}/access/apps/{app_id}/policies/{policy_id}/make_reusable":{"put":{"description":"Converts an application-scoped policy to a reusable policy. The policy will no longer be exclusively scoped to the application. Further updates to the policy should go through the /accounts/{account_id}/policies/{uid} endpoint.","operationId":"access-policies-convert-reusable","parameters":[{"description":"The application ID.","in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"description":"The policy ID.","in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app-policies_components-schemas-response_collection"}}},"description":"Convert an Access application policy to a reusable policy"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Convert an Access application policy to a reusable policy failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Convert an Access application policy to a reusable policy","tags":["Access application-scoped policies"],"x-api-token-group":["Access: Apps and Policies Write"]}},"/accounts/{account_id}/access/apps/{app_id}/revoke_tokens":{"post":{"description":"Revokes all tokens issued for an application.","operationId":"access-applications-revoke-service-tokens","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-empty_response"}}},"description":"Revoke application tokens response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Revoke application tokens response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Revoke application tokens","tags":["Access applications"],"x-api-token-group":["Access: Apps and Policies Revoke","Access: Apps and Policies Write"]}},"/accounts/{account_id}/access/apps/{app_id}/settings":{"patch":{"description":"Updates Access application settings.","operationId":"access-applications-patch-update-access-application-settings","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app_settings_request"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/access_single_response_update"}]}}},"description":"Update Access application settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update Access application settings response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Access application settings","tags":["Access applications"]},"put":{"description":"Updates Access application settings.","operationId":"access-applications-put-update-access-application-settings","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app_settings_request"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/access_single_response_update"}]}}},"description":"Update Access application settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update Access application settings response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Access application settings","tags":["Access applications"],"x-api-token-group":["Access: Apps and Policies Write"]}},"/accounts/{account_id}/access/apps/{app_id}/user_policy_checks":{"get":{"description":"Tests if a specific user has permission to access an application.","operationId":"access-applications-test-access-policies","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_policy_check_response"}}},"description":"Test Access policies response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Test Access policies response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Test Access policies","tags":["Access applications"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read"]}},"/accounts/{account_id}/access/bookmarks":{"get":{"deprecated":true,"description":"Lists Bookmark applications.","operationId":"access-bookmark-applications-(-deprecated)-list-bookmark-applications","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_bookmarks_components-schemas-response_collection"}}},"description":"List Bookmark applications response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List Bookmark applications response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Bookmark applications","tags":["Access Bookmark applications (Deprecated)"],"x-api-token-group":["Access: Apps and Policies Revoke","Access: Apps and Policies Write","Access: Apps and Policies Read"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of using a specialized Access Application App Type.","display":true,"eol":"2023-03-19","id":"bookmarks_deprecation"}}},"/accounts/{account_id}/access/bookmarks/{bookmark_id}":{"delete":{"deprecated":true,"description":"Deletes a Bookmark application.","operationId":"access-bookmark-applications-(-deprecated)-delete-a-bookmark-application","parameters":[{"in":"path","name":"bookmark_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_id_response"}}},"description":"Delete a Bookmark application response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete a Bookmark application response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a Bookmark application","tags":["Access Bookmark applications (Deprecated)"],"x-api-token-group":["Access: Apps and Policies Write"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of using a specialized Access Application App Type.","display":true,"eol":"2023-03-19","id":"bookmarks_deprecation"}},"get":{"deprecated":true,"description":"Fetches a single Bookmark application.","operationId":"access-bookmark-applications-(-deprecated)-get-a-bookmark-application","parameters":[{"in":"path","name":"bookmark_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_bookmarks_components-schemas-single_response"}}},"description":"Get a Bookmark application response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get a Bookmark application response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a Bookmark application","tags":["Access Bookmark applications (Deprecated)"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of using a specialized Access Application App Type.","display":true,"eol":"2023-03-19","id":"bookmarks_deprecation"}},"post":{"deprecated":true,"description":"Create a new Bookmark application.","operationId":"access-bookmark-applications-(-deprecated)-create-a-bookmark-application","parameters":[{"in":"path","name":"bookmark_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_bookmarks_components-schemas-single_response"}}},"description":"Create a Bookmark application response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create a Bookmark application response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a Bookmark application","tags":["Access Bookmark applications (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of using a specialized Access Application App Type.","display":true,"eol":"2023-03-19","id":"bookmarks_deprecation"}},"put":{"deprecated":true,"description":"Updates a configured Bookmark application.","operationId":"access-bookmark-applications-(-deprecated)-update-a-bookmark-application","parameters":[{"in":"path","name":"bookmark_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_bookmarks_components-schemas-single_response"}}},"description":"Update a Bookmark application response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update a Bookmark application response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a Bookmark application","tags":["Access Bookmark applications (Deprecated)"],"x-api-token-group":["Access: Apps and Policies Write"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of using a specialized Access Application App Type.","display":true,"eol":"2023-03-19","id":"bookmarks_deprecation"}}},"/accounts/{account_id}/access/certificates":{"get":{"description":"Lists all mTLS root certificates.","operationId":"access-mtls-authentication-list-mtls-certificates","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"$ref":"#/components/parameters/access_page"},{"in":"query","name":"per_page","schema":{"default":50,"description":"Number of results per page.","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_certificates_components-schemas-response_collection"}}},"description":"List mTLS certificates response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List mTLS certificates response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List mTLS certificates","tags":["Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write","Access: Mutual TLS Certificates Read"]},"post":{"description":"Adds a new mTLS root certificate to Access.","operationId":"access-mtls-authentication-add-an-mtls-certificate","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"associated_hostnames":{"$ref":"#/components/schemas/access_associated_hostnames"},"certificate":{"description":"The certificate content.","example":"-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----","type":"string"},"name":{"$ref":"#/components/schemas/access_certificates_components-schemas-name"}},"required":["name","certificate"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_certificates_components-schemas-single_response"}}},"description":"Add an mTLS certificate response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Add an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Add an mTLS certificate","tags":["Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write"]}},"/accounts/{account_id}/access/certificates/settings":{"get":{"description":"List all mTLS hostname settings for this account.","operationId":"access-mtls-authentication-list-mtls-certificates-hostname-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_response_collection_hostnames"}}},"description":"List mTLS hostname settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List mTLS hostname settings response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List all mTLS hostname settings","tags":["Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write","Access: Mutual TLS Certificates Read"]},"put":{"description":"Updates an mTLS certificate's hostname settings.","operationId":"access-mtls-authentication-update-an-mtls-certificate-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"settings":{"items":{"$ref":"#/components/schemas/access_settings"},"type":"array"}},"required":["settings"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_response_collection_hostnames"}}},"description":"Update an mTLS certificates hostname settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update an mTLS certificates hostname settings failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an mTLS certificate's hostname settings","tags":["Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write"]}},"/accounts/{account_id}/access/certificates/{certificate_id}":{"delete":{"description":"Deletes an mTLS certificate.","operationId":"access-mtls-authentication-delete-an-mtls-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_components-schemas-id_response"}}},"description":"Delete an mTLS certificate response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an mTLS certificate","tags":["Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write"]},"get":{"description":"Fetches a single mTLS certificate.","operationId":"access-mtls-authentication-get-an-mtls-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_certificates_components-schemas-single_response"}}},"description":"Get an mTLS certificate response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get an mTLS certificate","tags":["Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write","Access: Mutual TLS Certificates Read"]},"put":{"description":"Updates a configured mTLS certificate.","operationId":"access-mtls-authentication-update-an-mtls-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"associated_hostnames":{"$ref":"#/components/schemas/access_associated_hostnames"},"name":{"$ref":"#/components/schemas/access_certificates_components-schemas-name"}},"required":["associated_hostnames"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_certificates_components-schemas-single_response"}}},"description":"Update an mTLS certificate response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an mTLS certificate","tags":["Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write"]}},"/accounts/{account_id}/access/custom_pages":{"get":{"description":"List custom pages","operationId":"access-custom-pages-list-custom-pages","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"$ref":"#/components/parameters/access_page"},{"in":"query","name":"per_page","schema":{"default":50,"description":"Number of results per page.","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_custom-pages_components-schemas-response_collection"}}},"description":"List custom pages response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List custom pages response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List custom pages","tags":["Access custom pages"],"x-api-token-group":["Access: Custom Pages Write","Access: Custom Pages Read"]},"post":{"description":"Create a custom page","operationId":"access-custom-pages-create-a-custom-page","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_custom_page"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_single_response_without_html"}}},"description":"Create a custom page response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create a custom page response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a custom page","tags":["Access custom pages"],"x-api-token-group":["Access: Custom Pages Write"]}},"/accounts/{account_id}/access/custom_pages/{custom_page_id}":{"delete":{"description":"Delete a custom page","operationId":"access-custom-pages-delete-a-custom-page","parameters":[{"in":"path","name":"custom_page_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_components-schemas-id_response"}}},"description":"Delete a custom page response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete a custom page response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a custom page","tags":["Access custom pages"],"x-api-token-group":["Access: Custom Pages Write"]},"get":{"description":"Fetches a custom page and also returns its HTML.","operationId":"access-custom-pages-get-a-custom-page","parameters":[{"in":"path","name":"custom_page_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_custom-pages_components-schemas-single_response"}}},"description":"Get a custom page response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get a custom page response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a custom page","tags":["Access custom pages"],"x-api-token-group":["Access: Custom Pages Write","Access: Custom Pages Read"]},"put":{"description":"Update a custom page","operationId":"access-custom-pages-update-a-custom-page","parameters":[{"in":"path","name":"custom_page_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_custom_page"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_single_response_without_html"}}},"description":"Update a custom page response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update a custom page response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a custom page","tags":["Access custom pages"],"x-api-token-group":["Access: Custom Pages Write"]}},"/accounts/{account_id}/access/gateway_ca":{"get":{"description":"Lists SSH Certificate Authorities (CA).","operationId":"access-gateway-ca-list-SSH-ca","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_gateway_ca_components-schemas-response_collection"}}},"description":"List SSH Certificate Authorities (CA) response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List SSH Certificate Authorities (CA) response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List SSH Certificate Authorities (CA)","tags":["Gateway CA"],"x-api-token-group":["Access: SSH Auditing Write","Access: SSH Auditing Read"]},"post":{"description":"Adds a new SSH Certificate Authority (CA).","operationId":"access-gateway-ca-add-an-SSH-ca","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_gateway_ca_components-schemas-single_response"}}},"description":"Add a new SSH Certificate Authority (CA) response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Add a new SSH Certificate Authority (CA) response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Add a new SSH Certificate Authority (CA)","tags":["Gateway CA"],"x-api-token-group":["Access: SSH Auditing Write"]}},"/accounts/{account_id}/access/gateway_ca/{certificate_id}":{"delete":{"description":"Deletes an SSH Certificate Authority.","operationId":"access-gateway-ca-delete-an-SSH-ca","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_id_response"}}},"description":"Delete an SSH Certificate Authority (CA) response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete an SSH Certificate Authority (CA) response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an SSH Certificate Authority (CA)","tags":["Gateway CA"],"x-api-token-group":["Access: SSH Auditing Write"]}},"/accounts/{account_id}/access/groups":{"get":{"description":"Lists all Access groups.","operationId":"access-groups-list-access-groups","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"query","name":"name","schema":{"description":"The name of the group.","type":"string"}},{"in":"query","name":"search","schema":{"description":"Search for groups by other listed query parameters.","type":"string"}},{"$ref":"#/components/parameters/access_page"},{"$ref":"#/components/parameters/access_per_page"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-response_collection"}}},"description":"List Access groups response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List Access groups response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Access groups","tags":["Access groups"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]},"post":{"description":"Creates a new Access group.","operationId":"access-groups-create-an-access-group","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"exclude":{"$ref":"#/components/schemas/access_exclude"},"include":{"$ref":"#/components/schemas/access_include"},"is_default":{"$ref":"#/components/schemas/access_is_default"},"name":{"$ref":"#/components/schemas/access_groups_components-schemas-name"},"require":{"$ref":"#/components/schemas/access_require"}},"required":["name","include"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_groups_components-schemas-single_response"}}},"description":"Create an Access group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create an Access group response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create an Access group","tags":["Access groups"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/accounts/{account_id}/access/groups/{group_id}":{"delete":{"description":"Deletes an Access group.","operationId":"access-groups-delete-an-access-group","parameters":[{"in":"path","name":"group_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_id_response"}}},"description":"Delete an Access group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete an Access group response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an Access group","tags":["Access groups"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]},"get":{"description":"Fetches a single Access group.","operationId":"access-groups-get-an-access-group","parameters":[{"in":"path","name":"group_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_groups_components-schemas-single_response"}}},"description":"Get an Access group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get an Access group response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get an Access group","tags":["Access groups"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]},"put":{"description":"Updates a configured Access group.","operationId":"access-groups-update-an-access-group","parameters":[{"in":"path","name":"group_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"exclude":{"$ref":"#/components/schemas/access_exclude"},"include":{"$ref":"#/components/schemas/access_include"},"is_default":{"$ref":"#/components/schemas/access_is_default"},"name":{"$ref":"#/components/schemas/access_groups_components-schemas-name"},"require":{"$ref":"#/components/schemas/access_require"}},"required":["name","include"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_groups_components-schemas-single_response"}}},"description":"Update an Access group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update an Access group response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an Access group","tags":["Access groups"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/accounts/{account_id}/access/identity_providers":{"get":{"description":"Lists all configured identity providers.","operationId":"access-identity-providers-list-access-identity-providers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"query","name":"scim_enabled","schema":{"description":"Indicates to Access to only retrieve identity providers that have the System for Cross-Domain Identity Management (SCIM) enabled.","example":true,"type":"string"}},{"$ref":"#/components/parameters/access_page"},{"in":"query","name":"per_page","schema":{"default":200,"description":"Number of results per page.","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_response_collection"}}},"description":"List Access identity providers response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List Access identity providers response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Access identity providers","tags":["Access identity providers"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]},"post":{"description":"Adds a new identity provider to Access.","operationId":"access-identity-providers-add-an-access-identity-provider","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_identity-providers"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_components-schemas-single_response"}}},"description":"Add an Access identity provider response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Add an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Add an Access identity provider","tags":["Access identity providers"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/accounts/{account_id}/access/identity_providers/{identity_provider_id}":{"delete":{"description":"Deletes an identity provider from Access.","operationId":"access-identity-providers-delete-an-access-identity-provider","parameters":[{"in":"path","name":"identity_provider_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_id_response"}}},"description":"Delete an Access identity provider response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an Access identity provider","tags":["Access identity providers"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]},"get":{"description":"Fetches a configured identity provider.","operationId":"access-identity-providers-get-an-access-identity-provider","parameters":[{"in":"path","name":"identity_provider_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_components-schemas-single_response"}}},"description":"Get an Access identity provider response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get an Access identity provider","tags":["Access identity providers"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]},"put":{"description":"Updates a configured identity provider.","operationId":"access-identity-providers-update-an-access-identity-provider","parameters":[{"in":"path","name":"identity_provider_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_identity-providers"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_components-schemas-single_response"}}},"description":"Update an Access identity provider response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an Access identity provider","tags":["Access identity providers"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/accounts/{account_id}/access/identity_providers/{identity_provider_id}/scim/groups":{"get":{"description":"Lists SCIM Group resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).","operationId":"access-identity-providers-list-scim-group-resources","parameters":[{"in":"path","name":"identity_provider_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"query","name":"cf_resource_id","schema":{"$ref":"#/components/schemas/access_cf_resource_id"}},{"in":"query","name":"idp_resource_id","schema":{"$ref":"#/components/schemas/access_idp_resource_id"}},{"in":"query","name":"name","schema":{"$ref":"#/components/schemas/access_groups-name"}},{"$ref":"#/components/parameters/access_page"},{"in":"query","name":"per_page","schema":{"default":100,"description":"Number of results per page.","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_scim_groups_response"}}},"description":"List SCIM Group resources response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List SCIM Group resources response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List SCIM Group resources","tags":["Access identity providers"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]}},"/accounts/{account_id}/access/identity_providers/{identity_provider_id}/scim/users":{"get":{"description":"Lists SCIM User resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).","operationId":"access-identity-providers-list-scim-user-resources","parameters":[{"in":"path","name":"identity_provider_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"query","name":"cf_resource_id","schema":{"$ref":"#/components/schemas/access_users-cf_resource_id"}},{"in":"query","name":"idp_resource_id","schema":{"$ref":"#/components/schemas/access_users-idp_resource_id"}},{"in":"query","name":"username","schema":{"$ref":"#/components/schemas/access_username"}},{"in":"query","name":"email","schema":{"$ref":"#/components/schemas/access_email"}},{"in":"query","name":"name","schema":{"$ref":"#/components/schemas/access_users-name"}},{"$ref":"#/components/parameters/access_page"},{"in":"query","name":"per_page","schema":{"default":100,"description":"Number of results per page.","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_scim_users_response"}}},"description":"List SCIM User resources response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List SCIM User resources response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List SCIM User resources","tags":["Access identity providers"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]}},"/accounts/{account_id}/access/keys":{"get":{"description":"Gets the Access key rotation settings for an account.","operationId":"access-key-configuration-get-the-access-key-configuration","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_keys_components-schemas-single_response"}}},"description":"Get the Access key configuration response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get the Access key configuration response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get the Access key configuration","tags":["Access key configuration"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]},"put":{"description":"Updates the Access key rotation settings for an account.","operationId":"access-key-configuration-update-the-access-key-configuration","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"key_rotation_interval_days":{"$ref":"#/components/schemas/access_key_rotation_interval_days"}},"required":["key_rotation_interval_days"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_keys_components-schemas-single_response"}}},"description":"Update the Access key configuration response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update the Access key configuration response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update the Access key configuration","tags":["Access key configuration"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/accounts/{account_id}/access/keys/rotate":{"post":{"description":"Perfoms a key rotation for an account.","operationId":"access-key-configuration-rotate-access-keys","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_keys_components-schemas-single_response"}}},"description":"Rotate Access keys response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Rotate Access keys response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Rotate Access keys","tags":["Access key configuration"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/accounts/{account_id}/access/logs/access_requests":{"get":{"description":"Gets a list of Access authentication audit logs for an account.","operationId":"access-authentication-logs-get-access-authentication-logs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"description":"The maximum number of log entries to retrieve.","example":25,"in":"query","name":"limit","schema":{"default":25,"type":"integer"}},{"description":"The chronological sorting order for the logs.","example":"desc","in":"query","name":"direction","schema":{"default":"desc","enum":["desc","asc"]}},{"description":"The earliest event timestamp to query.","in":"query","name":"since","schema":{"example":"2020-07-01T05:20:00Z","format":"date-time","type":"string"}},{"description":"The latest event timestamp to query.","in":"query","name":"until","schema":{"example":"2020-10-01T05:20:00Z","format":"date-time","type":"string"}},{"$ref":"#/components/parameters/access_page"},{"in":"query","name":"per_page","schema":{"default":25,"description":"Number of results per page.","type":"integer"}},{"description":"Filter by user email. Defaults to substring matching. To force exact matching, set `email_exact=true`.\nExample (default): `email=@example.com` returns all events with that domain.\nExample (exact): `email=user@example.com\u0026email_exact=true` returns only that user.\n","in":"query","name":"email","schema":{"$ref":"#/components/schemas/access_components-schemas-email"}},{"description":"When true, `email` is matched exactly instead of substring matching.","example":true,"in":"query","name":"email_exact","schema":{"default":false,"type":"boolean"}},{"description":"Filter by user UUID.\n","in":"query","name":"user_id","schema":{"$ref":"#/components/schemas/access_user_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_access-requests_components-schemas-response_collection"}}},"description":"Get Access authentication logs response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get Access authentication logs response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Access authentication logs","tags":["Access authentication logs"],"x-api-token-group":["Access: Audit Logs Read"]}},"/accounts/{account_id}/access/logs/scim/updates":{"get":{"description":"Lists Access SCIM update logs that maintain a record of updates made to User and Group resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).","operationId":"access-scim-update-logs-list-access-scim-update-logs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"query","name":"limit","schema":{"$ref":"#/components/schemas/access_limit"}},{"example":"desc","in":"query","name":"direction","schema":{"$ref":"#/components/schemas/access_direction"}},{"in":"query","name":"since","schema":{"$ref":"#/components/schemas/access_since"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/access_until"}},{"in":"query","name":"idp_id","required":true,"schema":{"$ref":"#/components/schemas/access_idp_id"}},{"in":"query","name":"status","schema":{"$ref":"#/components/schemas/access_requests-status"}},{"in":"query","name":"resource_type","schema":{"$ref":"#/components/schemas/access_resource_type"}},{"in":"query","name":"request_method","schema":{"$ref":"#/components/schemas/access_request_method"}},{"in":"query","name":"resource_user_email","schema":{"$ref":"#/components/schemas/access_resource_user_email"}},{"in":"query","name":"resource_group_name","schema":{"$ref":"#/components/schemas/access_resource_group_name"}},{"in":"query","name":"cf_resource_id","schema":{"$ref":"#/components/schemas/access_requests-cf_resource_id"}},{"in":"query","name":"idp_resource_id","schema":{"$ref":"#/components/schemas/access_requests-idp_resource_id"}},{"$ref":"#/components/parameters/access_page"},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of results per page.","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_scim_update_logs_response"}}},"description":"Get Access SCIM update logs response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get Access SCIM update logs response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Access SCIM update logs","tags":["Access SCIM update logs"],"x-api-token-group":["Access: SCIM logs read"]}},"/accounts/{account_id}/access/organizations":{"get":{"description":"Returns the configuration for your Zero Trust organization.","operationId":"zero-trust-organization-get-your-zero-trust-organization","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_single_response"}}},"description":"Get your Zero Trust organization response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get your Zero Trust organization response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get your Zero Trust organization","tags":["Zero Trust organization"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Revoke","Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]},"post":{"description":"Sets up a Zero Trust organization for your account.","operationId":"zero-trust-organization-create-your-zero-trust-organization","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_authenticate_via_warp":{"$ref":"#/components/schemas/access_allow_authenticate_via_warp"},"auth_domain":{"$ref":"#/components/schemas/access_auth_domain"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/access_auto_redirect_to_identity"},"is_ui_read_only":{"$ref":"#/components/schemas/access_is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/access_login_design"},"name":{"$ref":"#/components/schemas/access_name"},"session_duration":{"$ref":"#/components/schemas/access_session_duration"},"ui_read_only_toggle_reason":{"$ref":"#/components/schemas/access_ui_read_only_toggle_reason"},"user_seat_expiration_inactive_time":{"$ref":"#/components/schemas/access_user_seat_expiration_inactive_time"},"warp_auth_session_duration":{"$ref":"#/components/schemas/access_warp_auth_session_duration"}},"required":["name","auth_domain"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_single_response"}}},"description":"Create your Zero Trust organization response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create your Zero Trust organization response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create your Zero Trust organization","tags":["Zero Trust organization"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]},"put":{"description":"Updates the configuration for your Zero Trust organization.","operationId":"zero-trust-organization-update-your-zero-trust-organization","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_authenticate_via_warp":{"$ref":"#/components/schemas/access_allow_authenticate_via_warp"},"auth_domain":{"$ref":"#/components/schemas/access_auth_domain"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/access_auto_redirect_to_identity"},"custom_pages":{"$ref":"#/components/schemas/access_custom_pages"},"is_ui_read_only":{"$ref":"#/components/schemas/access_is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/access_login_design"},"name":{"$ref":"#/components/schemas/access_name"},"session_duration":{"$ref":"#/components/schemas/access_session_duration"},"ui_read_only_toggle_reason":{"$ref":"#/components/schemas/access_ui_read_only_toggle_reason"},"user_seat_expiration_inactive_time":{"$ref":"#/components/schemas/access_user_seat_expiration_inactive_time"},"warp_auth_session_duration":{"$ref":"#/components/schemas/access_warp_auth_session_duration"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_single_response"}}},"description":"Update your Zero Trust organization response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update your Zero Trust organization response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update your Zero Trust organization","tags":["Zero Trust organization"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/accounts/{account_id}/access/organizations/doh":{"get":{"description":"Returns the DoH settings for your Zero Trust organization.","operationId":"zero-trust-organization-get-your-zero-trust-organization-doh-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/access_schemas-single_response"},{"properties":{"result":{"properties":{"doh_jwt_duration":{"description":"The duration the DoH JWT is valid for. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.  Note that the maximum duration for this setting is the same as the key rotation period on the account.","example":"800h","type":"string"}},"type":"object"}}}]}}},"description":"Get your Zero Trust organization DoH settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get your Zero Trust organization DoH settings response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get your Zero Trust organization DoH settings","tags":["Zero Trust organization"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Revoke","Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]},"put":{"description":"Updates the DoH settings for your Zero Trust organization.","operationId":"zero-trust-organization-update-your-zero-trust-organization-doh-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"doh_jwt_duration":{"$ref":"#/components/schemas/access_doh_jwt_duration"},"service_token_id":{"description":"The uuid of the service token you want to use for DoH authentication","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","type":"string"}}}}}},"responses":{"201":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/access_schemas-single_response"},{"properties":{"result":{"properties":{"doh_jwt_duration":{"$ref":"#/components/schemas/access_doh_jwt_duration"}},"type":"object"}}}]}}},"description":"Update your Zero Trust organization DoH settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update your Zero Trust organization DoH settings response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update your Zero Trust organization DoH settings","tags":["Zero Trust organization"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/accounts/{account_id}/access/organizations/revoke_user":{"post":{"description":"Revokes a user's access across all applications.","operationId":"zero-trust-organization-revoke-all-access-tokens-for-a-user","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"description":"When set to `true`, all devices associated with the user will be revoked.","example":true,"in":"query","name":"devices","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"devices":{"description":"When set to `true`, all devices associated with the user will be revoked.","example":true,"type":"boolean"},"email":{"description":"The email of the user to revoke.","example":"test@example.com","type":"string"},"user_uid":{"description":"The uuid of the user to revoke.","example":"699d98642c564d2e855e9661899b7252","type":"string"},"warp_session_reauth":{"description":"When set to `true`, the user will be required to re-authenticate to WARP for all Gateway policies that enforce a WARP client session duration. When `false`, the user’s WARP session will remain active","example":true,"type":"boolean"}},"required":["email"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_empty_response"}}},"description":"Revoke all Access tokens for a user response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Revoke all Access tokens for a user response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Revoke all Access tokens for a user","tags":["Zero Trust organization"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/accounts/{account_id}/access/policies":{"get":{"description":"Lists Access reusable policies.","operationId":"access-policies-list-access-reusable-policies","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"$ref":"#/components/parameters/access_page"},{"in":"query","name":"per_page","schema":{"default":100,"description":"Number of results per page.","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_reusable-policies_components-schemas-response_collection"}}},"description":"List Access reusable policies response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List Access reusable policies response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Access reusable policies","tags":["Access reusable policies"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read"]},"post":{"description":"Creates a new Access reusable policy.","operationId":"access-policies-create-an-access-reusable-policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_policy_req"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_reusable-policies_components-schemas-single_response"}}},"description":"Create an Access reusable policy response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create an Access reusable policy response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create an Access reusable policy","tags":["Access reusable policies"],"x-api-token-group":["Access: Apps and Policies Write"]}},"/accounts/{account_id}/access/policies/{policy_id}":{"delete":{"description":"Deletes an Access reusable policy.","operationId":"access-policies-delete-an-access-reusable-policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/access_schemas-uuid"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_reusable-policies_components-schemas-id_response"}}},"description":"Delete an Access reusable policy response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete an Access reusable policy response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an Access reusable policy","tags":["Access reusable policies"],"x-api-token-group":["Access: Apps and Policies Write"]},"get":{"description":"Fetches a single Access reusable policy.","operationId":"access-policies-get-an-access-reusable-policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/access_schemas-uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_reusable-policies_components-schemas-single_response"}}},"description":"Get an Access reusable policy response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get an Access reusable policy response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get an Access reusable policy","tags":["Access reusable policies"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read"]},"put":{"description":"Updates a Access reusable policy.","operationId":"access-policies-update-an-access-reusable-policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/access_schemas-uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_policy_req"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_reusable-policies_components-schemas-single_response"}}},"description":"Update an Access reusable policy response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update an Access reusable policy response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an Access reusable policy","tags":["Access reusable policies"],"x-api-token-group":["Access: Apps and Policies Write"]}},"/accounts/{account_id}/access/policy-tests":{"post":{"description":"Starts an Access policy test.","operationId":"access-policy-tests","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_policy_init_req"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_policy_init_resp"}}},"description":"Start Access policy test response."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Start Access policy test response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Start Access policy test","tags":["Access policy tester"],"x-api-token-group":["Access: Policy Test Write"]}},"/accounts/{account_id}/access/policy-tests/{policy_test_id}":{"get":{"description":"Fetches the current status of a given Access policy test.","operationId":"access-policy-tests-get-an-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"path","name":"policy_test_id","required":true,"schema":{"$ref":"#/components/schemas/access_policy_test_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_policy_update_resp"}}},"description":"Get an Access policy test update response."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get an Access policy test update response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get the current status of a given Access policy test","tags":["Access policy tester"],"x-api-token-group":["Access: Policy Test Write","Access: Policy Test Read"]}},"/accounts/{account_id}/access/policy-tests/{policy_test_id}/users":{"get":{"description":"Fetches a single page of user results from an Access policy test.","operationId":"access-policy-tests-get-a-user-page","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"path","name":"policy_test_id","required":true,"schema":{"$ref":"#/components/schemas/access_policy_test_id"}},{"$ref":"#/components/parameters/access_page"},{"in":"query","name":"per_page","schema":{"default":25,"type":"integer"}},{"description":"Filter users by their policy evaluation status.","in":"query","name":"status","schema":{"enum":["success","fail","error"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_policy_users_resp"}}},"description":"Get an Access policy tester users page response."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get an Access policy tester users page response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get an Access policy test users page","tags":["Access policy tester"],"x-api-token-group":["Access: Policy Test Write","Access: Policy Test Read"]}},"/accounts/{account_id}/access/seats":{"patch":{"description":"Removes a user from a Zero Trust seat when both `access_seat` and `gateway_seat` are set to false.","operationId":"zero-trust-seats-update-a-user-seat","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_seats_definition"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_seats_components-schemas-response_collection"}}},"description":"Update a user seat response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update a user seat response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a user seat","tags":["Zero Trust seats"],"x-api-token-group":["Zero Trust: Seats Write"]}},"/accounts/{account_id}/access/service_tokens":{"get":{"description":"Lists all service tokens.","operationId":"access-service-tokens-list-service-tokens","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"query","name":"name","schema":{"description":"The name of the service token.","type":"string"}},{"in":"query","name":"search","schema":{"description":"Search for service tokens by other listed query parameters.","type":"string"}},{"$ref":"#/components/parameters/access_page"},{"$ref":"#/components/parameters/access_per_page"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_components-schemas-response_collection"}}},"description":"List service tokens response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List service tokens response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List service tokens","tags":["Access service tokens"],"x-api-token-group":["Access: Service Tokens Write","Access: Service Tokens Read"]},"post":{"description":"Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to rotate the Client Secret or create a new service token.","operationId":"access-service-tokens-create-a-service-token","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"client_secret_version":{"$ref":"#/components/schemas/access_client_secret_version"},"duration":{"$ref":"#/components/schemas/access_duration"},"name":{"$ref":"#/components/schemas/access_schemas-name"},"previous_client_secret_expires_at":{"$ref":"#/components/schemas/access_previous_client_secret_expires_at"}},"required":["name"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_create_response"}}},"description":"Create a service token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create a service token response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a service token","tags":["Access service tokens"],"x-api-token-group":["Access: Service Tokens Write"]}},"/accounts/{account_id}/access/service_tokens/{service_token_id}":{"delete":{"description":"Deletes a service token.","operationId":"access-service-tokens-delete-a-service-token","parameters":[{"in":"path","name":"service_token_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-single_response"}}},"description":"Delete a service token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete a service token response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a service token","tags":["Access service tokens"],"x-api-token-group":["Access: Service Tokens Write"]},"get":{"description":"Fetches a single service token.","operationId":"access-service-tokens-get-a-service-token","parameters":[{"in":"path","name":"service_token_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-single_response"}}},"description":"Get a service token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get a service token response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a service token","tags":["Access service tokens"],"x-api-token-group":["Access: Service Tokens Write","Access: Service Tokens Read"]},"put":{"description":"Updates a configured service token.","operationId":"access-service-tokens-update-a-service-token","parameters":[{"in":"path","name":"service_token_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"client_secret_version":{"$ref":"#/components/schemas/access_client_secret_version"},"duration":{"$ref":"#/components/schemas/access_duration"},"name":{"$ref":"#/components/schemas/access_schemas-name"},"previous_client_secret_expires_at":{"$ref":"#/components/schemas/access_previous_client_secret_expires_at"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-single_response"}}},"description":"Update a service token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update a service token response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a service token","tags":["Access service tokens"],"x-api-token-group":["Access: Service Tokens Write"]}},"/accounts/{account_id}/access/service_tokens/{service_token_id}/refresh":{"post":{"description":"Refreshes the expiration of a service token.","operationId":"access-service-tokens-refresh-a-service-token","parameters":[{"in":"path","name":"service_token_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-single_response"}}},"description":"Refresh a service token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Refresh a service token response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Refresh a service token","tags":["Access service tokens"],"x-api-token-group":["Access: Service Tokens Write"]}},"/accounts/{account_id}/access/service_tokens/{service_token_id}/rotate":{"post":{"description":"Generates a new Client Secret for a service token and revokes the old one.","operationId":"access-service-tokens-rotate-a-service-token","parameters":[{"in":"path","name":"service_token_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"previous_client_secret_expires_at":{"description":"The expiration of the previous `client_secret`. If not provided, it defaults to the current timestamp in order to immediately expire the previous secret.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string","x-auditable":true}}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_create_response"}}},"description":"Rotate a service token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Rotate a service token response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Rotate a service token","tags":["Access service tokens"]}},"/accounts/{account_id}/access/tags":{"get":{"description":"List tags","operationId":"access-tags-list-tags","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"$ref":"#/components/parameters/access_page"},{"in":"query","name":"per_page","schema":{"default":50,"description":"Number of results per page.","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_tags_components-schemas-response_collection"}}},"description":"List tags response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List tags response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List tags","tags":["Access tags"],"x-api-token-group":["Access: Apps and Policies Revoke","Access: Apps and Policies Write","Access: Apps and Policies Read"]},"post":{"description":"Create a tag","operationId":"access-tags-create-tag","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/access_tags_components-schemas-name"}}}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_tags_components-schemas-single_response"}}},"description":"Create a tag response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create a tag response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a tag","tags":["Access tags"],"x-api-token-group":["Access: Apps and Policies Write"]}},"/accounts/{account_id}/access/tags/{tag_name}":{"delete":{"description":"Delete a tag","operationId":"access-tags-delete-a-tag","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"path","name":"tag_name","required":true,"schema":{"$ref":"#/components/schemas/access_tags_components-schemas-name"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_name_response"}}},"description":"Delete a tag response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete a tag response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a tag","tags":["Access tags"],"x-api-token-group":["Access: Apps and Policies Write"]},"get":{"description":"Get a tag","operationId":"access-tags-get-a-tag","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"path","name":"tag_name","required":true,"schema":{"$ref":"#/components/schemas/access_tags_components-schemas-name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_tags_components-schemas-single_response"}}},"description":"Get a tag response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get a tag response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a tag","tags":["Access tags"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read"]},"put":{"description":"Update a tag","operationId":"access-tags-update-a-tag","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"path","name":"tag_name","required":true,"schema":{"$ref":"#/components/schemas/access_tags_components-schemas-name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_tag_without_app_count"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_tags_components-schemas-single_response"}}},"description":"Update a tag response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update a tag response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a tag","tags":["Access tags"],"x-api-token-group":["Access: Apps and Policies Write"]}},"/accounts/{account_id}/access/users":{"get":{"description":"Gets a list of users for an account.","operationId":"zero-trust-users-get-users","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"query","name":"name","schema":{"description":"The name of the user.","type":"string"}},{"in":"query","name":"email","schema":{"description":"The email of the user.","type":"string"}},{"in":"query","name":"search","schema":{"description":"Search for users by other listed query parameters.","type":"string"}},{"$ref":"#/components/parameters/access_page"},{"$ref":"#/components/parameters/access_per_page"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_users_components-schemas-response_collection"}}},"description":"Get users response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get users response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get users","tags":["Zero Trust users"],"x-api-token-group":["Access: Audit Logs Read"]}},"/accounts/{account_id}/access/users/{user_id}/active_sessions":{"get":{"description":"Get active sessions for a single user.","operationId":"zero-trust-users-get-active-sessions","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_active_sessions_response"}}},"description":"Get active sessions response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get active sessions response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get active sessions","tags":["Zero Trust users"],"x-api-token-group":["Access: Audit Logs Read"]}},"/accounts/{account_id}/access/users/{user_id}/active_sessions/{nonce}":{"get":{"description":"Get an active session for a single user.","operationId":"zero-trust-users-get-active-session","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}},{"in":"path","name":"nonce","required":true,"schema":{"$ref":"#/components/schemas/access_nonce"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_active_session_response"}}},"description":"Get active session response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get active session response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get single active session","tags":["Zero Trust users"],"x-api-token-group":["Access: Audit Logs Read"]}},"/accounts/{account_id}/access/users/{user_id}/failed_logins":{"get":{"description":"Get all failed login attempts for a single user.","operationId":"zero-trust-users-get-failed-logins","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_failed_login_response"}}},"description":"Get failed logins response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get failed logins response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get failed logins","tags":["Zero Trust users"],"x-api-token-group":["Access: Audit Logs Read"]}},"/accounts/{account_id}/access/users/{user_id}/last_seen_identity":{"get":{"description":"Get last seen identity for a single user.","operationId":"zero-trust-users-get-last-seen-identity","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_last_seen_identity_response"}}},"description":"Get active session response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get active session response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get last seen identity","tags":["Zero Trust users"],"x-api-token-group":["Access: Audit Logs Read"]}},"/accounts/{account_id}/addressing/address_maps":{"get":{"description":"List all address maps owned by the account.","operationId":"ip-address-management-address-maps-list-address-maps","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_components-schemas-response_collection"}}},"description":"List Address Maps response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_components-schemas-response_collection"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"List Address Maps response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Address Maps","tags":["IP Address Management Address Maps"],"x-api-token-group":["Address Maps Write","Address Maps Read"]},"post":{"description":"Create a new address map under the account.","operationId":"ip-address-management-address-maps-create-address-map","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/addressing_schemas-description"},"enabled":{"$ref":"#/components/schemas/addressing_enabled"},"ips":{"example":["192.0.2.1"],"items":{"$ref":"#/components/schemas/addressing_ip_address"},"type":"array"},"memberships":{"$ref":"#/components/schemas/addressing_membership_requests"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_full_response"}}},"description":"Create Address Map response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_full_response"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Create Address Map response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create Address Map","tags":["IP Address Management Address Maps"],"x-api-token-group":["Address Maps Write"]}},"/accounts/{account_id}/addressing/address_maps/{address_map_id}":{"delete":{"description":"Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted.","operationId":"ip-address-management-address-maps-delete-address-map","parameters":[{"in":"path","name":"address_map_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_address_map_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-collection"}}},"description":"Delete Address Map response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-collection"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Delete Address Map response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete Address Map","tags":["IP Address Management Address Maps"],"x-api-token-group":["Address Maps Write"]},"get":{"description":"Show a particular address map owned by the account.","operationId":"ip-address-management-address-maps-address-map-details","parameters":[{"in":"path","name":"address_map_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_address_map_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_full_response"}}},"description":"Address Map Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_full_response"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Address Map Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Address Map Details","tags":["IP Address Management Address Maps"],"x-api-token-group":["Address Maps Write","Address Maps Read"]},"patch":{"description":"Modify properties of an address map owned by the account.","operationId":"ip-address-management-address-maps-update-address-map","parameters":[{"in":"path","name":"address_map_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_address_map_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"default_sni":{"$ref":"#/components/schemas/addressing_default_sni"},"description":{"$ref":"#/components/schemas/addressing_schemas-description"},"enabled":{"$ref":"#/components/schemas/addressing_enabled"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_components-schemas-single_response"}}},"description":"Update Address Map response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_components-schemas-single_response"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Update Address Map response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update Address Map","tags":["IP Address Management Address Maps"],"x-api-token-group":["Address Maps Write"]}},"/accounts/{account_id}/addressing/address_maps/{address_map_id}/accounts/{account_id}":{"delete":{"description":"Remove an account as a member of a particular address map.","operationId":"ip-address-management-address-maps-remove-an-account-membership-from-an-address-map","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}},{"in":"path","name":"address_map_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_address_map_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-collection"}}},"description":"Remove an account membership from an Address Map response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-collection"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Remove an account membership from an Address Map response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Remove an account membership from an Address Map","tags":["IP Address Management Address Maps"],"x-api-token-group":["Address Maps Write"]},"put":{"description":"Add an account as a member of a particular address map.","operationId":"ip-address-management-address-maps-add-an-account-membership-to-an-address-map","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}},{"in":"path","name":"address_map_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_address_map_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-collection"}}},"description":"Add an account membership to an Address Map response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-collection"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Add an account membership to an Address Map response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Add an account membership to an Address Map","tags":["IP Address Management Address Maps"]}},"/accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address}":{"delete":{"description":"Remove an IP from a particular address map.","operationId":"ip-address-management-address-maps-remove-an-ip-from-an-address-map","parameters":[{"in":"path","name":"ip_address","required":true,"schema":{"$ref":"#/components/schemas/addressing_ip_address"}},{"in":"path","name":"address_map_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_address_map_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-collection"}}},"description":"Remove an IP from an Address Map response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-collection"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Remove an IP from an Address Map response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Remove an IP from an Address Map","tags":["IP Address Management Address Maps"],"x-api-token-group":["Address Maps Write"]},"put":{"description":"Add an IP from a prefix owned by the account to a particular address map.","operationId":"ip-address-management-address-maps-add-an-ip-to-an-address-map","parameters":[{"in":"path","name":"ip_address","required":true,"schema":{"$ref":"#/components/schemas/addressing_ip_address"}},{"in":"path","name":"address_map_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_address_map_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-collection"}}},"description":"Add an IP to an Address Map response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-collection"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Add an IP to an Address Map response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Add an IP to an Address Map","tags":["IP Address Management Address Maps"],"x-api-token-group":["Address Maps Write"]}},"/accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}":{"delete":{"description":"Remove a zone as a member of a particular address map.","operationId":"ip-address-management-address-maps-remove-a-zone-membership-from-an-address-map","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_zone_identifier"}},{"in":"path","name":"address_map_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_address_map_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-collection"}}},"description":"Remove a zone membership from an Address Map response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-collection"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Remove a zone membership from an Address Map response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Remove a zone membership from an Address Map","tags":["IP Address Management Address Maps"],"x-api-token-group":["Address Maps Write"]},"put":{"description":"Add a zone as a member of a particular address map.","operationId":"ip-address-management-address-maps-add-a-zone-membership-to-an-address-map","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_zone_identifier"}},{"in":"path","name":"address_map_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_address_map_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-collection"}}},"description":"Add a zone membership to an Address Map response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-collection"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Add a zone membership to an Address Map response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Add a zone membership to an Address Map","tags":["IP Address Management Address Maps"]}},"/accounts/{account_id}/addressing/leases":{"get":{"description":"List all leases owned by the account.","operationId":"ip-address-management-list-leases","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_schemas-account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_leases_components-schemas-response_collection"}}},"description":"List Leases response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_leases_components-schemas-response_collection"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"List Leases response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Leases","tags":["IP Address Management Leases"]}},"/accounts/{account_id}/addressing/loa_documents/{loa_document_id}/download":{"get":{"description":"Download specified LOA document under the account.","operationId":"ip-address-management-prefixes-download-loa-document","parameters":[{"in":"path","name":"loa_document_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_loa_document_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"Download LOA Document response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Download LOA Document response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Download LOA Document","tags":["IP Address Management Prefixes"],"x-api-token-group":["Magic Transit Read","Magic Transit Write"]}},"/accounts/{account_id}/addressing/prefixes":{"get":{"description":"List all prefixes owned by the account.","operationId":"ip-address-management-prefixes-list-prefixes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_response_collection"}}},"description":"List Prefixes response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_response_collection"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"List Prefixes response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Prefixes","tags":["IP Address Management Prefixes"],"x-api-token-group":["Magic Transit Read","Magic Transit Write","IP Prefixes: Write","IP Prefixes: Read","IP Prefixes: BGP On Demand Write","IP Prefixes: BGP On Demand Read"]},"post":{"description":"Add a new prefix under the account.","operationId":"ip-address-management-prefixes-add-prefix","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"asn":{"$ref":"#/components/schemas/addressing_asn"},"cidr":{"$ref":"#/components/schemas/addressing_cidr"},"delegate_loa_creation":{"$ref":"#/components/schemas/addressing_delegate_loa_creation"},"description":{"$ref":"#/components/schemas/addressing_description"}},"required":["cidr","asn"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_single_response"}}},"description":"Add Prefix response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_single_response"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Add Prefix response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Add Prefix","tags":["IP Address Management Prefixes"],"x-api-token-group":null}},"/accounts/{account_id}/addressing/prefixes/{prefix_id}":{"delete":{"description":"Delete an unapproved prefix owned by the account.","operationId":"ip-address-management-prefixes-delete-prefix","parameters":[{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-single"}}},"description":"Delete Prefix response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-collection"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Delete Prefix response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete Prefix","tags":["IP Address Management Prefixes"],"x-api-token-group":["Magic Transit Write"]},"get":{"description":"List a particular prefix owned by the account.","operationId":"ip-address-management-prefixes-prefix-details","parameters":[{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_single_response"}}},"description":"Prefix Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_single_response"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Prefix Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Prefix Details","tags":["IP Address Management Prefixes"],"x-api-token-group":["Magic Transit Read","Magic Transit Write","IP Prefixes: Write","IP Prefixes: Read","IP Prefixes: BGP On Demand Write","IP Prefixes: BGP On Demand Read"]},"patch":{"description":"Modify the description for a prefix owned by the account.","operationId":"ip-address-management-prefixes-update-prefix-description","parameters":[{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/addressing_description"}},"required":["description"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_single_response"}}},"description":"Update Prefix Description response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_single_response"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Update Prefix Description response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update Prefix Description","tags":["IP Address Management Prefixes"],"x-api-token-group":["Magic Transit Write","IP Prefixes: Write"]}},"/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes":{"get":{"description":"List all BGP Prefixes within the specified IP Prefix. BGP Prefixes are used to control which specific subnets are advertised to the Internet. It is possible to advertise subnets more specific than an IP Prefix by creating more specific BGP Prefixes.","operationId":"ip-address-management-prefixes-list-bgp-prefixes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}},{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_response_collection_bgp"}}},"description":"List BGP Prefixes response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_response_collection_bgp"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"List BGP Prefixes response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List BGP Prefixes","tags":["IP Address Management BGP Prefixes"],"x-api-token-group":["Magic Transit Read","Magic Transit Write","IP Prefixes: Write","IP Prefixes: Read","IP Prefixes: BGP On Demand Write","IP Prefixes: BGP On Demand Read"]},"post":{"description":"Create a BGP prefix, controlling the BGP advertisement status of a specific subnet. When created, BGP prefixes are initially withdrawn, and can be advertised with the Update BGP Prefix API.","operationId":"ip-address-management-prefixes-create-bgp-prefix","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}},{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_bgp_prefix_create"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_single_response_bgp"}}},"description":"Create BGP Prefix response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_single_response_bgp"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Create BGP Prefix response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create BGP Prefix","tags":["IP Address Management BGP Prefixes"]}},"/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/prefixes/{bgp_prefix_id}":{"delete":{"description":"Delete a BGP Prefix associated with the specified IP Prefix. A BGP Prefix must be withdrawn before it can be deleted.","operationId":"ip-address-management-prefixes-delete-bgp-prefix","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}},{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"bgp_prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_bgp_prefix_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-common"}}},"description":"Delete BGP Prefix response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-common-failure"}}},"description":"Delete BGP Prefix response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete BGP Prefix","tags":["IP Address Management BGP Prefixes"]},"get":{"description":"Retrieve a single BGP Prefix according to its identifier","operationId":"ip-address-management-prefixes-fetch-bgp-prefix","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}},{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"bgp_prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_bgp_prefix_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_single_response_bgp"}}},"description":"Fetch BGP Prefix response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_single_response_bgp"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Fetch BGP Prefix response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Fetch BGP Prefix","tags":["IP Address Management BGP Prefixes"],"x-api-token-group":["Magic Transit Read","Magic Transit Write","IP Prefixes: Write","IP Prefixes: Read","IP Prefixes: BGP On Demand Write","IP Prefixes: BGP On Demand Read"]},"patch":{"description":"Update the properties of a BGP Prefix, such as the on demand advertisement status (advertised or withdrawn).","operationId":"ip-address-management-prefixes-update-bgp-prefix","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}},{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"bgp_prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_bgp_prefix_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_bgp_prefix_update_advertisement"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_single_response_bgp"}}},"description":"Update BGP Prefix response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_single_response_bgp"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Update BGP Prefix response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update BGP Prefix","tags":["IP Address Management BGP Prefixes"],"x-api-token-group":["Magic Transit Write","IP Prefixes: Write","IP Prefixes: BGP On Demand Write"]}},"/accounts/{account_id}/addressing/prefixes/{prefix_id}/bgp/status":{"get":{"deprecated":true,"description":"View the current advertisement state for a prefix.\n\n**Deprecated:** Prefer the BGP Prefixes endpoints, which additionally allow for advertising and withdrawing \nsubnets of an IP prefix.\n","operationId":"ip-address-management-dynamic-advertisement-get-advertisement-status","parameters":[{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_advertised_response"}}},"description":"Get Advertisement Status response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_advertised_response"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Get Advertisement Status response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Advertisement Status","tags":["IP Address Management Dynamic Advertisement"],"x-api-token-group":["Magic Transit Read","Magic Transit Write","IP Prefixes: Write","IP Prefixes: Read","IP Prefixes: BGP On Demand Write","IP Prefixes: BGP On Demand Read"]},"patch":{"deprecated":true,"description":"Advertise or withdraw the BGP route for a prefix.\n\n**Deprecated:** Prefer the BGP Prefixes endpoints, which additionally allow for advertising and withdrawing \nsubnets of an IP prefix.\n","operationId":"ip-address-management-dynamic-advertisement-update-prefix-dynamic-advertisement-status","parameters":[{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"advertised":{"$ref":"#/components/schemas/addressing_components-schemas-advertised"}},"required":["advertised"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_advertised_response"}}},"description":"Update Prefix Dynamic Advertisement Status response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_advertised_response"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Update Prefix Dynamic Advertisement Status response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update Prefix Dynamic Advertisement Status","tags":["IP Address Management Dynamic Advertisement"],"x-api-token-group":["Magic Transit Write","IP Prefixes: Write","IP Prefixes: BGP On Demand Write"]}},"/accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings":{"get":{"description":"List the Cloudflare services this prefix is currently bound to. Traffic sent to an address within an IP prefix will be routed to the Cloudflare service of the most-specific Service Binding matching the address.\n**Example:** binding `192.0.2.0/24` to Cloudflare Magic Transit and `192.0.2.1/32` to the Cloudflare CDN would route traffic for `192.0.2.1` to the CDN, and traffic for all other IPs in the prefix to Cloudflare Magic Transit.\n","operationId":"ip-address-management-service-bindings-list-service-bindings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}},{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/addressing_service_binding"},"type":"array"}}}]}}},"description":"Service Bindings attached to the Prefix"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-common-failure"}}},"description":"List Service Bindings response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Service Bindings","tags":["IP Address Management Service Bindings"],"x-api-token-group":["IP Prefixes: Write","IP Prefixes: Read"]},"post":{"description":"Creates a new Service Binding, routing traffic to IPs within the given CIDR to a service running on Cloudflare's network.\n**NOTE:** The first Service Binding created for an IP Prefix must exactly match the IP Prefix's CIDR. Subsequent Service Bindings may be created with a more-specific CIDR. Refer to the  [Service Bindings Documentation](https://developers.cloudflare.com/byoip/service-bindings/) for compatibility details.\n","operationId":"ip-address-management-service-bindings-create-service-binding","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}},{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_create_binding_request"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/addressing_service_binding"}}}]}}},"description":"The created Service Binding"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-common-failure"}}},"description":"Create Service Binding response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create Service Binding","tags":["IP Address Management Service Bindings"],"x-api-token-group":["IP Prefixes: Write"]}},"/accounts/{account_id}/addressing/prefixes/{prefix_id}/bindings/{binding_id}":{"delete":{"description":"Delete a Service Binding","operationId":"ip-address-management-service-bindings-delete-service-binding","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}},{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"binding_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_service_binding_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-common"}}},"description":"Service Binding deleted"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-common-failure"}}},"description":"Delete Service Binding response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete Service Binding","tags":["IP Address Management Service Bindings"],"x-api-token-group":["IP Prefixes: Write"]},"get":{"description":"Fetch a single Service Binding","operationId":"ip-address-management-service-bindings-get-service-binding","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}},{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"binding_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_service_binding_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/addressing_service_binding"}}}]}}},"description":"The Service Binding with the requested ID"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-common-failure"}}},"description":"Get Service Binding response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Service Binding","tags":["IP Address Management Service Bindings"],"x-api-token-group":["IP Prefixes: Write","IP Prefixes: Read"]}},"/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations":{"get":{"description":"List all delegations for a given account IP prefix.","operationId":"ip-address-management-prefix-delegation-list-prefix-delegations","parameters":[{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_schemas-response_collection"}}},"description":"List Prefix Delegations response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_schemas-response_collection"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"List Prefix Delegations response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Prefix Delegations","tags":["IP Address Management Prefix Delegation"]},"post":{"description":"Create a new account delegation for a given IP prefix.","operationId":"ip-address-management-prefix-delegation-create-prefix-delegation","parameters":[{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"cidr":{"$ref":"#/components/schemas/addressing_cidr"},"delegated_account_id":{"$ref":"#/components/schemas/addressing_delegated_account_identifier"}},"required":["cidr","delegated_account_id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_schemas-single_response"}}},"description":"Create Prefix Delegation response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_schemas-single_response"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Create Prefix Delegation response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create Prefix Delegation","tags":["IP Address Management Prefix Delegation"],"x-api-token-group":["IP Prefixes: Write"]}},"/accounts/{account_id}/addressing/prefixes/{prefix_id}/delegations/{delegation_id}":{"delete":{"description":"Delete an account delegation for a given IP prefix.","operationId":"ip-address-management-prefix-delegation-delete-prefix-delegation","parameters":[{"in":"path","name":"delegation_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_delegation_identifier"}},{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_id_response"}}},"description":"Delete Prefix Delegation response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_id_response"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Delete Prefix Delegation response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete Prefix Delegation","tags":["IP Address Management Prefix Delegation"],"x-api-token-group":["IP Prefixes: Write"]}},"/accounts/{account_id}/addressing/prefixes/{prefix_id}/validate":{"post":{"description":"Triggers a new prefix validation. The checks are run asynchronously and include IRR, RPKI, and prefix ownership.","operationId":"ip-address-management-prefixes-validate-prefix","parameters":[{"in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_prefix_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_single_response"}}},"description":"Validate Prefix response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_single_response"},{"$ref":"#/components/schemas/addressing_api-response-common-failure"}]}}},"description":"Validate Prefix response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Validate Prefix","tags":["IP Address Management Prefixes"],"x-api-token-group":["Magic Transit Write","IP Prefixes: Write"]}},"/accounts/{account_id}/addressing/regional_hostnames/regions":{"get":{"description":"List all Regional Services regions available for use by this account.","operationId":"dls-account-regional-hostnames-account-list-regions","parameters":[{"$ref":"#/components/parameters/dls_account_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dls_api-response-collection"},{"properties":{"result":{"items":{"properties":{"key":{"$ref":"#/components/schemas/dls_region_key"},"label":{"description":"Human-readable text label for the region","example":"Canada","type":"string"}},"type":"object"},"type":"array"}}}]}}},"description":"List regions response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dls_api-response-common-failure"}]}}},"description":"Failure to list regions"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Regions","tags":["DLS Regional Services"],"x-api-token-group":["DNS Read","DNS Write"]}},"/accounts/{account_id}/addressing/services":{"get":{"description":"Bring-Your-Own IP (BYOIP) prefixes onboarded to Cloudflare must be bound to a service running on the Cloudflare network to enable a Cloudflare product on the IP addresses. This endpoint can be used as a reference of available services on the Cloudflare network, and their service IDs.\n","operationId":"ip-address-management-service-bindings-list-services","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/addressing_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/addressing_api-response-common"},{"properties":{"result":{"items":{"properties":{"id":{"$ref":"#/components/schemas/addressing_service_identifier"},"name":{"$ref":"#/components/schemas/addressing_service_name"}}},"type":"array"}}}]}}},"description":"Service names and IDs"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/addressing_api-response-common-failure"}}},"description":"List Services response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Services","tags":["IP Address Management Service Bindings"],"x-api-token-group":["IP Prefixes: Write","IP Prefixes: Read"]}},"/accounts/{account_id}/ai-gateway/evaluation-types":{"get":{"operationId":"aig-config-list-evaluators","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"default":20,"maximum":50,"minimum":5,"type":"integer"}},{"in":"query","name":"order_by","schema":{"default":"mandatory","type":"string"}},{"in":"query","name":"order_by_direction","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"enable":{"type":"boolean"},"id":{"type":"string"},"mandatory":{"type":"boolean"},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type","mandatory","description","enable","id","created_at","modified_at"],"type":"object"},"type":"array"},"result_info":{"properties":{"count":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["count","page","per_page","total_count"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result","result_info"],"type":"object"}}},"description":"Returns a list of Evaluators"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Evaluators","tags":["AI Gateway Evaluations"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways":{"get":{"operationId":"aig-config-list-gateway","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"in":"query","name":"search","schema":{"description":"Search by id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"authentication":{"type":"boolean","x-auditable":true},"cache_invalidate_on_update":{"type":"boolean","x-auditable":true},"cache_ttl":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"collect_logs":{"type":"boolean","x-auditable":true},"created_at":{"format":"date-time","type":"string"},"dlp":{"anyOf":[{"properties":{"action":{"enum":["BLOCK","FLAG"],"type":"string"},"enabled":{"type":"boolean"},"profiles":{"items":{"type":"string"},"type":"array"}},"required":["profiles","enabled","action"],"type":"object"},{"properties":{"enabled":{"type":"boolean"},"policies":{"items":{"properties":{"action":{"enum":["FLAG","BLOCK"],"type":"string"},"check":{"items":{"enum":["REQUEST","RESPONSE"],"type":"string"},"type":"array"},"enabled":{"type":"boolean"},"id":{"type":"string"},"profiles":{"items":{"type":"string"},"type":"array"}},"required":["id","enabled","action","profiles","check"],"type":"object"},"type":"array"}},"required":["enabled","policies"],"type":"object"}]},"id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"internal_id":{"format":"uuid","type":"string"},"log_management":{"maximum":10000000,"minimum":10000,"nullable":true,"type":"integer","x-auditable":true},"log_management_strategy":{"enum":["STOP_INSERTING","DELETE_OLDEST"],"nullable":true,"type":"string","x-auditable":true},"logpush":{"type":"boolean","x-auditable":true},"logpush_public_key":{"maxLength":1024,"minLength":16,"nullable":true,"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"otel":{"items":{"properties":{"authorization":{"type":"string"},"headers":{"additionalProperties":{"type":"string"},"type":"object"},"url":{"type":"string"}},"required":["url","headers","authorization"],"type":"object"},"nullable":true,"type":"array","x-auditable":true},"rate_limiting_interval":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_limit":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_technique":{"enum":["fixed","sliding"],"type":"string","x-auditable":true},"store_id":{"nullable":true,"type":"string"},"stripe":{"nullable":true,"properties":{"authorization":{"type":"string"},"usage_events":{"items":{"properties":{"payload":{"type":"string"}},"required":["payload"],"type":"object"},"type":"array"}},"required":["authorization","usage_events"],"type":"object","x-auditable":true}},"required":["id","internal_id","account_id","account_tag","rate_limiting_interval","rate_limiting_limit","rate_limiting_technique","collect_logs","cache_ttl","cache_invalidate_on_update","created_at","modified_at"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"List objects"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Gateways","tags":["AI Gateway Gateways"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"aig-config-create-gateway","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"authentication":{"type":"boolean","x-auditable":true},"cache_invalidate_on_update":{"type":"boolean","x-auditable":true},"cache_ttl":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"collect_logs":{"type":"boolean","x-auditable":true},"id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"log_management":{"maximum":10000000,"minimum":10000,"nullable":true,"type":"integer","x-auditable":true},"log_management_strategy":{"enum":["STOP_INSERTING","DELETE_OLDEST"],"nullable":true,"type":"string","x-auditable":true},"logpush":{"type":"boolean","x-auditable":true},"logpush_public_key":{"maxLength":1024,"minLength":16,"nullable":true,"type":"string","x-auditable":true},"rate_limiting_interval":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_limit":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_technique":{"enum":["fixed","sliding"],"type":"string","x-auditable":true}},"required":["id","rate_limiting_interval","rate_limiting_limit","rate_limiting_technique","collect_logs","cache_ttl","cache_invalidate_on_update"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"authentication":{"type":"boolean","x-auditable":true},"cache_invalidate_on_update":{"type":"boolean","x-auditable":true},"cache_ttl":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"collect_logs":{"type":"boolean","x-auditable":true},"created_at":{"format":"date-time","type":"string"},"dlp":{"anyOf":[{"properties":{"action":{"enum":["BLOCK","FLAG"],"type":"string"},"enabled":{"type":"boolean"},"profiles":{"items":{"type":"string"},"type":"array"}},"required":["profiles","enabled","action"],"type":"object"},{"properties":{"enabled":{"type":"boolean"},"policies":{"items":{"properties":{"action":{"enum":["FLAG","BLOCK"],"type":"string"},"check":{"items":{"enum":["REQUEST","RESPONSE"],"type":"string"},"type":"array"},"enabled":{"type":"boolean"},"id":{"type":"string"},"profiles":{"items":{"type":"string"},"type":"array"}},"required":["id","enabled","action","profiles","check"],"type":"object"},"type":"array"}},"required":["enabled","policies"],"type":"object"}]},"id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"internal_id":{"format":"uuid","type":"string"},"log_management":{"maximum":10000000,"minimum":10000,"nullable":true,"type":"integer","x-auditable":true},"log_management_strategy":{"enum":["STOP_INSERTING","DELETE_OLDEST"],"nullable":true,"type":"string","x-auditable":true},"logpush":{"type":"boolean","x-auditable":true},"logpush_public_key":{"maxLength":1024,"minLength":16,"nullable":true,"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"otel":{"items":{"properties":{"authorization":{"type":"string"},"headers":{"additionalProperties":{"type":"string"},"type":"object"},"url":{"type":"string"}},"required":["url","headers","authorization"],"type":"object"},"nullable":true,"type":"array","x-auditable":true},"rate_limiting_interval":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_limit":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_technique":{"enum":["fixed","sliding"],"type":"string","x-auditable":true},"store_id":{"nullable":true,"type":"string"},"stripe":{"nullable":true,"properties":{"authorization":{"type":"string"},"usage_events":{"items":{"properties":{"payload":{"type":"string"}},"required":["payload"],"type":"object"},"type":"array"}},"required":["authorization","usage_events"],"type":"object","x-auditable":true}},"required":["id","internal_id","account_id","account_tag","rate_limiting_interval","rate_limiting_limit","rate_limiting_technique","collect_logs","cache_ttl","cache_invalidate_on_update","created_at","modified_at"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the created Object"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7001,"type":"number"},"message":{"example":"Input Validation Error","type":"string"},"path":{"items":{"example":"body","type":"string"},"type":"array"}},"required":["code","message","path"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Input Validation Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a new Gateway","tags":["AI Gateway Gateways"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets":{"get":{"operationId":"aig-config-list-dataset","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"in":"query","name":"name","schema":{"type":"string","x-auditable":true}},{"in":"query","name":"enable","schema":{"type":"boolean","x-auditable":true}},{"in":"query","name":"search","schema":{"description":"Search by id, name, filters","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enable":{"type":"boolean","x-auditable":true},"filters":{"items":{"properties":{"key":{"enum":["created_at","request_content_type","response_content_type","success","cached","provider","model","cost","tokens","tokens_in","tokens_out","duration","feedback"],"type":"string","x-auditable":true},"operator":{"enum":["eq","contains","lt","gt"],"type":"string","x-auditable":true},"value":{"items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array","x-auditable":true}},"required":["key","operator","value"],"type":"object"},"type":"array"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true}},"required":["gateway_id","name","filters","enable","id","account_id","account_tag","created_at","modified_at"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"List objects"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Datasets","tags":["AI Gateway Datasets"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"aig-config-create-dataset","parameters":[{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"enable":{"type":"boolean","x-auditable":true},"filters":{"items":{"properties":{"key":{"enum":["created_at","request_content_type","response_content_type","success","cached","provider","model","cost","tokens","tokens_in","tokens_out","duration","feedback"],"type":"string","x-auditable":true},"operator":{"enum":["eq","contains","lt","gt"],"type":"string","x-auditable":true},"value":{"items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array","x-auditable":true}},"required":["key","operator","value"],"type":"object"},"type":"array"},"name":{"type":"string","x-auditable":true}},"required":["name","filters","enable"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enable":{"type":"boolean","x-auditable":true},"filters":{"items":{"properties":{"key":{"enum":["created_at","request_content_type","response_content_type","success","cached","provider","model","cost","tokens","tokens_in","tokens_out","duration","feedback"],"type":"string","x-auditable":true},"operator":{"enum":["eq","contains","lt","gt"],"type":"string","x-auditable":true},"value":{"items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array","x-auditable":true}},"required":["key","operator","value"],"type":"object"},"type":"array"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true}},"required":["gateway_id","name","filters","enable","id","account_id","account_tag","created_at","modified_at"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the created Object"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7001,"type":"number"},"message":{"example":"Input Validation Error","type":"string"},"path":{"items":{"example":"body","type":"string"},"type":"array"}},"required":["code","message","path"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Input Validation Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a new Dataset","tags":["AI Gateway Datasets"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets/{id}":{"delete":{"operationId":"aig-config-delete-dataset","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"id","required":true,"schema":{"type":"string","x-auditable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enable":{"type":"boolean","x-auditable":true},"filters":{"items":{"properties":{"key":{"enum":["created_at","request_content_type","response_content_type","success","cached","provider","model","cost","tokens","tokens_in","tokens_out","duration","feedback"],"type":"string","x-auditable":true},"operator":{"enum":["eq","contains","lt","gt"],"type":"string","x-auditable":true},"value":{"items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array","x-auditable":true}},"required":["key","operator","value"],"type":"object"},"type":"array"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true}},"required":["gateway_id","name","filters","enable","id","account_id","account_tag","created_at","modified_at"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the Object if it was successfully deleted"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a Dataset","tags":["AI Gateway Datasets"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"aig-config-fetch-dataset","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"id","required":true,"schema":{"type":"string","x-auditable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enable":{"type":"boolean","x-auditable":true},"filters":{"items":{"properties":{"key":{"enum":["created_at","request_content_type","response_content_type","success","cached","provider","model","cost","tokens","tokens_in","tokens_out","duration","feedback"],"type":"string","x-auditable":true},"operator":{"enum":["eq","contains","lt","gt"],"type":"string","x-auditable":true},"value":{"items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array","x-auditable":true}},"required":["key","operator","value"],"type":"object"},"type":"array"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true}},"required":["gateway_id","name","filters","enable","id","account_id","account_tag","created_at","modified_at"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns a single object if found"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Fetch a Dataset","tags":["AI Gateway Datasets"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"operationId":"aig-config-update-dataset","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"id","required":true,"schema":{"type":"string","x-auditable":true}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"enable":{"type":"boolean","x-auditable":true},"filters":{"items":{"properties":{"key":{"enum":["created_at","request_content_type","response_content_type","success","cached","provider","model","cost","tokens","tokens_in","tokens_out","duration","feedback"],"type":"string","x-auditable":true},"operator":{"enum":["eq","contains","lt","gt"],"type":"string","x-auditable":true},"value":{"items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array","x-auditable":true}},"required":["key","operator","value"],"type":"object"},"type":"array"},"name":{"type":"string","x-auditable":true}},"required":["name","filters","enable"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enable":{"type":"boolean","x-auditable":true},"filters":{"items":{"properties":{"key":{"enum":["created_at","request_content_type","response_content_type","success","cached","provider","model","cost","tokens","tokens_in","tokens_out","duration","feedback"],"type":"string","x-auditable":true},"operator":{"enum":["eq","contains","lt","gt"],"type":"string","x-auditable":true},"value":{"items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array","x-auditable":true}},"required":["key","operator","value"],"type":"object"},"type":"array"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true}},"required":["gateway_id","name","filters","enable","id","account_id","account_tag","created_at","modified_at"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the updated Object"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7001,"type":"number"},"message":{"example":"Input Validation Error","type":"string"},"path":{"items":{"example":"body","type":"string"},"type":"array"}},"required":["code","message","path"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Input Validation Error"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update a Dataset","tags":["AI Gateway Datasets"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations":{"get":{"operationId":"aig-config-list-evaluations","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"in":"query","name":"name","schema":{"type":"string","x-auditable":true}},{"in":"query","name":"processed","schema":{"type":"boolean","x-auditable":true}},{"in":"query","name":"search","schema":{"description":"Search by id, name","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"datasets":{"items":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enable":{"type":"boolean","x-auditable":true},"filters":{"items":{"properties":{"key":{"enum":["created_at","request_content_type","response_content_type","success","cached","provider","model","cost","tokens","tokens_in","tokens_out","duration","feedback"],"type":"string","x-auditable":true},"operator":{"enum":["eq","contains","lt","gt"],"type":"string","x-auditable":true},"value":{"items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array","x-auditable":true}},"required":["key","operator","value"],"type":"object"},"type":"array"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true}},"required":["gateway_id","name","filters","enable","id","account_id","account_tag","created_at","modified_at"],"type":"object"},"type":"array"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true},"processed":{"type":"boolean","x-auditable":true},"results":{"items":{"properties":{"created_at":{"format":"date-time","type":"string"},"evaluation_id":{"type":"string"},"evaluation_type_id":{"type":"string"},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"result":{"type":"string"},"status":{"type":"number"},"status_description":{"type":"string"},"total_logs":{"type":"number"}},"required":["evaluation_id","evaluation_type_id","result","total_logs","status","status_description","id","created_at","modified_at"],"type":"object"},"type":"array"},"total_logs":{"type":"number","x-auditable":true}},"required":["id","account_id","account_tag","gateway_id","name","created_at","modified_at","datasets","results","processed","total_logs"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"List objects"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Evaluations","tags":["AI Gateway Evaluations"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"aig-config-create-evaluations","parameters":[{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"dataset_ids":{"items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"evaluation_type_ids":{"items":{"type":"string"},"type":"array"},"name":{"type":"string","x-auditable":true}},"required":["name","dataset_ids","evaluation_type_ids"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"datasets":{"items":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enable":{"type":"boolean","x-auditable":true},"filters":{"items":{"properties":{"key":{"enum":["created_at","request_content_type","response_content_type","success","cached","provider","model","cost","tokens","tokens_in","tokens_out","duration","feedback"],"type":"string","x-auditable":true},"operator":{"enum":["eq","contains","lt","gt"],"type":"string","x-auditable":true},"value":{"items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array","x-auditable":true}},"required":["key","operator","value"],"type":"object"},"type":"array"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true}},"required":["gateway_id","name","filters","enable","id","account_id","account_tag","created_at","modified_at"],"type":"object"},"type":"array"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true},"processed":{"type":"boolean","x-auditable":true},"results":{"items":{"properties":{"created_at":{"format":"date-time","type":"string"},"evaluation_id":{"type":"string"},"evaluation_type_id":{"type":"string"},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"result":{"type":"string"},"status":{"type":"number"},"status_description":{"type":"string"},"total_logs":{"type":"number"}},"required":["evaluation_id","evaluation_type_id","result","total_logs","status","status_description","id","created_at","modified_at"],"type":"object"},"type":"array"},"total_logs":{"type":"number","x-auditable":true}},"required":["id","account_id","account_tag","gateway_id","name","created_at","modified_at","datasets","results","processed","total_logs"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the created Object"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7001,"type":"number"},"message":{"example":"Input Validation Error","type":"string"},"path":{"items":{"example":"body","type":"string"},"type":"array"}},"required":["code","message","path"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Input Validation Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a new Evaluation","tags":["AI Gateway Evaluations"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations/{id}":{"delete":{"operationId":"aig-config-delete-evaluations","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"id","required":true,"schema":{"type":"string","x-auditable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"datasets":{"items":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enable":{"type":"boolean","x-auditable":true},"filters":{"items":{"properties":{"key":{"enum":["created_at","request_content_type","response_content_type","success","cached","provider","model","cost","tokens","tokens_in","tokens_out","duration","feedback"],"type":"string","x-auditable":true},"operator":{"enum":["eq","contains","lt","gt"],"type":"string","x-auditable":true},"value":{"items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array","x-auditable":true}},"required":["key","operator","value"],"type":"object"},"type":"array"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true}},"required":["gateway_id","name","filters","enable","id","account_id","account_tag","created_at","modified_at"],"type":"object"},"type":"array"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true},"processed":{"type":"boolean","x-auditable":true},"results":{"items":{"properties":{"created_at":{"format":"date-time","type":"string"},"evaluation_id":{"type":"string"},"evaluation_type_id":{"type":"string"},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"result":{"type":"string"},"status":{"type":"number"},"status_description":{"type":"string"},"total_logs":{"type":"number"}},"required":["evaluation_id","evaluation_type_id","result","total_logs","status","status_description","id","created_at","modified_at"],"type":"object"},"type":"array"},"total_logs":{"type":"number","x-auditable":true}},"required":["id","account_id","account_tag","gateway_id","name","created_at","modified_at","datasets","results","processed","total_logs"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the Object if it was successfully deleted"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a Evaluation","tags":["AI Gateway Evaluations"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"aig-config-fetch-evaluations","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"id","required":true,"schema":{"type":"string","x-auditable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"datasets":{"items":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"enable":{"type":"boolean","x-auditable":true},"filters":{"items":{"properties":{"key":{"enum":["created_at","request_content_type","response_content_type","success","cached","provider","model","cost","tokens","tokens_in","tokens_out","duration","feedback"],"type":"string","x-auditable":true},"operator":{"enum":["eq","contains","lt","gt"],"type":"string","x-auditable":true},"value":{"items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array","x-auditable":true}},"required":["key","operator","value"],"type":"object"},"type":"array"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true}},"required":["gateway_id","name","filters","enable","id","account_id","account_tag","created_at","modified_at"],"type":"object"},"type":"array"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true},"processed":{"type":"boolean","x-auditable":true},"results":{"items":{"properties":{"created_at":{"format":"date-time","type":"string"},"evaluation_id":{"type":"string"},"evaluation_type_id":{"type":"string"},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"result":{"type":"string"},"status":{"type":"number"},"status_description":{"type":"string"},"total_logs":{"type":"number"}},"required":["evaluation_id","evaluation_type_id","result","total_logs","status","status_description","id","created_at","modified_at"],"type":"object"},"type":"array"},"total_logs":{"type":"number","x-auditable":true}},"required":["id","account_id","account_tag","gateway_id","name","created_at","modified_at","datasets","results","processed","total_logs"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns a single object if found"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Fetch a Evaluation","tags":["AI Gateway Evaluations"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs":{"delete":{"operationId":"aig-config-delete-gateway-logs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"query","name":"order_by","schema":{"default":"created_at","enum":["created_at","provider","model","model_type","success","cached","cost","tokens_in","tokens_out","duration","feedback"],"type":"string"}},{"in":"query","name":"order_by_direction","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}},{"in":"query","name":"filters","schema":{"items":{"properties":{"key":{"enum":["id","created_at","request_content_type","response_content_type","request_type","success","cached","provider","model","model_type","cost","tokens","tokens_in","tokens_out","duration","feedback","event_id","metadata.key","metadata.value","prompts.prompt_id","prompts.version_id","authentication","wholesale","compatibilityMode","dlp_action"],"type":"string"},"operator":{"enum":["eq","neq","contains","lt","gt"],"type":"string"},"value":{"items":{"anyOf":[{"nullable":true,"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array"}},"required":["key","operator","value"],"type":"object"},"type":"array"}},{"in":"query","name":"limit","schema":{"default":10000,"maximum":10000,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"}},"required":["success"],"type":"object"}}},"description":"Returns if the delete was successful"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Gateway Logs","tags":["AI Gateway Logs"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"aig-config-list-gateway-logs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"default":20,"maximum":50,"minimum":1,"type":"integer"}},{"in":"query","name":"order_by","schema":{"default":"created_at","enum":["created_at","provider","model","model_type","success","cached"],"type":"string"}},{"in":"query","name":"order_by_direction","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"in":"query","name":"filters","schema":{"items":{"properties":{"key":{"enum":["id","created_at","request_content_type","response_content_type","request_type","success","cached","provider","model","model_type","cost","tokens","tokens_in","tokens_out","duration","feedback","event_id","metadata.key","metadata.value","prompts.prompt_id","prompts.version_id","authentication","wholesale","compatibilityMode","dlp_action"],"type":"string"},"operator":{"enum":["eq","neq","contains","lt","gt"],"type":"string"},"value":{"items":{"anyOf":[{"nullable":true,"type":"string"},{"type":"number"},{"type":"boolean"}]},"type":"array"}},"required":["key","operator","value"],"type":"object"},"type":"array"}},{"in":"query","name":"meta_info","schema":{"type":"boolean"}},{"in":"query","name":"direction","schema":{"deprecated":true,"enum":["asc","desc"],"type":"string"}},{"in":"query","name":"start_date","schema":{"deprecated":true,"format":"date-time","type":"string"}},{"in":"query","name":"end_date","schema":{"deprecated":true,"format":"date-time","type":"string"}},{"in":"query","name":"min_cost","schema":{"deprecated":true,"type":"number"}},{"in":"query","name":"max_cost","schema":{"deprecated":true,"type":"number"}},{"in":"query","name":"min_tokens_in","schema":{"deprecated":true,"type":"number"}},{"in":"query","name":"max_tokens_in","schema":{"deprecated":true,"type":"number"}},{"in":"query","name":"min_tokens_out","schema":{"deprecated":true,"type":"number"}},{"in":"query","name":"max_tokens_out","schema":{"deprecated":true,"type":"number"}},{"in":"query","name":"min_total_tokens","schema":{"deprecated":true,"type":"number"}},{"in":"query","name":"max_total_tokens","schema":{"deprecated":true,"type":"number"}},{"in":"query","name":"min_duration","schema":{"deprecated":true,"type":"number"}},{"in":"query","name":"max_duration","schema":{"deprecated":true,"type":"number"}},{"in":"query","name":"feedback","schema":{"anyOf":[{"enum":[-1],"type":"number"},{"enum":[0],"type":"number"},{"enum":[1],"type":"number"}],"deprecated":true}},{"in":"query","name":"success","schema":{"deprecated":true,"type":"boolean"}},{"in":"query","name":"cached","schema":{"deprecated":true,"type":"boolean"}},{"in":"query","name":"model","schema":{"deprecated":true,"type":"string"}},{"in":"query","name":"model_type","schema":{"deprecated":true,"type":"string"}},{"in":"query","name":"provider","schema":{"deprecated":true,"type":"string"}},{"in":"query","name":"request_content_type","schema":{"deprecated":true,"type":"string"}},{"in":"query","name":"response_content_type","schema":{"deprecated":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"cached":{"type":"boolean"},"cost":{"type":"number"},"created_at":{"format":"date-time","type":"string"},"custom_cost":{"type":"boolean"},"duration":{"type":"integer"},"id":{"type":"string"},"metadata":{"type":"string"},"model":{"type":"string"},"model_type":{"type":"string"},"path":{"type":"string"},"provider":{"type":"string"},"request_content_type":{"type":"string"},"request_type":{"type":"string"},"response_content_type":{"type":"string"},"status_code":{"type":"integer"},"step":{"type":"integer"},"success":{"type":"boolean"},"tokens_in":{"nullable":true,"type":"integer"},"tokens_out":{"nullable":true,"type":"integer"}},"required":["id","created_at","provider","model","path","duration","success","cached","tokens_in","tokens_out"],"type":"object"},"type":"array"},"result_info":{"properties":{"count":{"type":"number"},"max_cost":{"type":"number"},"max_duration":{"type":"number"},"max_tokens_in":{"type":"number"},"max_tokens_out":{"type":"number"},"max_total_tokens":{"type":"number"},"min_cost":{"type":"number"},"min_duration":{"type":"number"},"min_tokens_in":{"type":"number"},"min_tokens_out":{"type":"number"},"min_total_tokens":{"type":"number"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"type":"object"},"success":{"type":"boolean"}},"required":["success","result","result_info"],"type":"object"}}},"description":"Returns a list of Gateway Logs"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Gateway Logs","tags":["AI Gateway Logs"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}":{"get":{"operationId":"aig-config-get-gateway-log-detail","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"cached":{"type":"boolean"},"cost":{"type":"number"},"created_at":{"format":"date-time","type":"string"},"custom_cost":{"type":"boolean"},"duration":{"type":"integer"},"id":{"type":"string"},"metadata":{"type":"string"},"model":{"type":"string"},"model_type":{"type":"string"},"path":{"type":"string"},"provider":{"type":"string"},"request_content_type":{"type":"string"},"request_head":{"type":"string"},"request_head_complete":{"type":"boolean"},"request_size":{"type":"integer"},"request_type":{"type":"string"},"response_content_type":{"type":"string"},"response_head":{"type":"string"},"response_head_complete":{"type":"boolean"},"response_size":{"type":"integer"},"status_code":{"type":"integer"},"step":{"type":"integer"},"success":{"type":"boolean"},"tokens_in":{"nullable":true,"type":"integer"},"tokens_out":{"nullable":true,"type":"integer"}},"required":["id","created_at","provider","model","path","duration","success","cached","tokens_in","tokens_out"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the log details"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Gateway Log Detail","tags":["AI Gateway Logs"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"operationId":"aig-config-patch-gateway-log","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"feedback":{"maximum":1,"minimum":-1,"nullable":true,"type":"number"},"metadata":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"nullable":true,"type":"object"},"score":{"maximum":100,"minimum":0,"nullable":true,"type":"number"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the log details"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Gateway Log","tags":["AI Gateway Logs"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}/request":{"get":{"operationId":"aig-config-get-gateway-log-request","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Returns the request body from a specific log"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Gateway Log Request","tags":["AI Gateway Logs"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}/response":{"get":{"operationId":"aig-config-get-gateway-log-response","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Returns the response body from a specific log"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Gateway Log Response","tags":["AI Gateway Logs"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs":{"get":{"operationId":"aig-config-list-providers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"alias":{"type":"string"},"default_config":{"type":"boolean"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"provider_slug":{"type":"string"},"rate_limit":{"type":"number"},"rate_limit_period":{"default":60,"type":"number"},"secret_id":{"type":"string"},"secret_preview":{"type":"string"}},"required":["id","provider_slug","secret_preview","default_config","gateway_id","modified_at","account_id","account_tag","alias","secret_id"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"List objects"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Provider Configs","tags":["AI Gateway Provider Configs"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"aig-config-create-providers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"alias":{"type":"string"},"default_config":{"type":"boolean"},"provider_slug":{"type":"string"},"rate_limit":{"type":"number"},"rate_limit_period":{"default":60,"type":"number"},"secret":{"type":"string"},"secret_id":{"type":"string"}},"required":["provider_slug","default_config","alias","secret_id","secret"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"alias":{"type":"string"},"default_config":{"type":"boolean"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"provider_slug":{"type":"string"},"rate_limit":{"type":"number"},"rate_limit_period":{"default":60,"type":"number"},"secret_id":{"type":"string"},"secret_preview":{"type":"string"}},"required":["id","provider_slug","secret_preview","default_config","gateway_id","modified_at","account_id","account_tag","alias","secret_id"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the created Object"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7001,"type":"number"},"message":{"example":"Input Validation Error","type":"string"},"path":{"items":{"example":"body","type":"string"},"type":"array"}},"required":["code","message","path"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Input Validation Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a new Provider Configs","tags":["AI Gateway Provider Configs"],"x-api-token-group":["Secrets Store Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs/{id}":{"delete":{"operationId":"aig-config-delete-providers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"alias":{"type":"string"},"default_config":{"type":"boolean"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"provider_slug":{"type":"string"},"rate_limit":{"type":"number"},"rate_limit_period":{"default":60,"type":"number"},"secret_id":{"type":"string"},"secret_preview":{"type":"string"}},"required":["id","provider_slug","secret_preview","default_config","gateway_id","modified_at","account_id","account_tag","alias","secret_id"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the Object if it was successfully deleted"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a Provider Configs","tags":["AI Gateway Provider Configs"],"x-api-token-group":["Secrets Store Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"operationId":"aig-config-update-providers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"secret":{"type":"string"}},"required":["secret"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"alias":{"type":"string"},"default_config":{"type":"boolean"},"gateway_id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"provider_slug":{"type":"string"},"rate_limit":{"type":"number"},"rate_limit_period":{"default":60,"type":"number"},"secret_id":{"type":"string"},"secret_preview":{"type":"string"}},"required":["id","provider_slug","secret_preview","default_config","gateway_id","modified_at","account_id","account_tag","alias","secret_id"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the updated Object"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7001,"type":"number"},"message":{"example":"Input Validation Error","type":"string"},"path":{"items":{"example":"body","type":"string"},"type":"array"}},"required":["code","message","path"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Input Validation Error"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update a Provider Configs","tags":["AI Gateway Provider Configs"],"x-api-token-group":["Secrets Store Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes":{"get":{"description":"List all AI Gateway Dynamic Routes.","operationId":"aig-config-list-gateway-dynamic-routes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"example":"54442216","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"order_by":{"type":"string"},"order_by_direction":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"routes":{"items":{"properties":{"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"deployment":{"properties":{"comment":{"nullable":true,"type":"string"},"created_at":{"type":"string"},"deployment_id":{"type":"string"},"version_id":{"type":"string"}},"required":["deployment_id","version_id","created_at"],"type":"object"},"elements":{"items":{"oneOf":[{"properties":{"id":{"type":"string"},"outputs":{"properties":{"next":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["next"],"type":"object"},"type":{"enum":["start"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"false":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"true":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["true","false"],"type":"object"},"properties":{"properties":{"conditions":{"type":"object"}},"type":"object"},"type":{"enum":["conditional"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["percentage"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"key":{"type":"string"},"limit":{"type":"number"},"limitType":{"enum":["count","cost"],"type":"string"},"window":{"type":"number"}},"required":["limitType","key","limit","window"],"type":"object"},"type":{"enum":["rate"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"model":{"type":"string"},"provider":{"type":"string"},"retries":{"type":"number"},"timeout":{"type":"number"}},"required":["provider","model","timeout","retries"],"type":"object"},"type":{"enum":["model"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["end"],"type":"string"}},"required":["id","outputs","type"],"type":"object"}]},"type":"array"},"gateway_id":{"type":"string"},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string"},"version":{"properties":{"active":{"enum":["true","false"],"type":"string"},"comment":{"nullable":true,"type":"string"},"created_at":{"type":"string"},"data":{"type":"string"},"version_id":{"type":"string"}},"required":["version_id","data","active","created_at"],"type":"object"}},"required":["id","name","elements","created_at","modified_at","account_tag","gateway_id","version","deployment"],"type":"object"},"type":"array"}},"required":["routes","page","per_page","order_by","order_by_direction"],"type":"object"},"success":{"type":"boolean"}},"required":["success","data"],"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List all AI Gateway Dynamic Routes.","tags":["AI Gateway Dynamic Routes"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a new AI Gateway Dynamic Route.","operationId":"aig-config-post-gateway-dynamic-route","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"example":"54442216","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"elements":{"items":{"oneOf":[{"properties":{"id":{"type":"string"},"outputs":{"properties":{"next":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["next"],"type":"object"},"type":{"enum":["start"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"false":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"true":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["true","false"],"type":"object"},"properties":{"properties":{"conditions":{"type":"object"}},"type":"object"},"type":{"enum":["conditional"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["percentage"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"key":{"type":"string"},"limit":{"type":"number"},"limitType":{"enum":["count","cost"],"type":"string"},"window":{"type":"number"}},"required":["limitType","key","limit","window"],"type":"object"},"type":{"enum":["rate"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"model":{"type":"string"},"provider":{"type":"string"},"retries":{"type":"number"},"timeout":{"type":"number"}},"required":["provider","model","timeout","retries"],"type":"object"},"type":{"enum":["model"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["end"],"type":"string"}},"required":["id","outputs","type"],"type":"object"}]},"type":"array"},"name":{"type":"string"}},"required":["name","elements"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"deployment":{"properties":{"comment":{"nullable":true,"type":"string"},"created_at":{"type":"string"},"deployment_id":{"type":"string"},"version_id":{"type":"string"}},"required":["deployment_id","version_id","created_at"],"type":"object"},"elements":{"items":{"oneOf":[{"properties":{"id":{"type":"string"},"outputs":{"properties":{"next":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["next"],"type":"object"},"type":{"enum":["start"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"false":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"true":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["true","false"],"type":"object"},"properties":{"properties":{"conditions":{"type":"object"}},"type":"object"},"type":{"enum":["conditional"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["percentage"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"key":{"type":"string"},"limit":{"type":"number"},"limitType":{"enum":["count","cost"],"type":"string"},"window":{"type":"number"}},"required":["limitType","key","limit","window"],"type":"object"},"type":{"enum":["rate"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"model":{"type":"string"},"provider":{"type":"string"},"retries":{"type":"number"},"timeout":{"type":"number"}},"required":["provider","model","timeout","retries"],"type":"object"},"type":{"enum":["model"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["end"],"type":"string"}},"required":["id","outputs","type"],"type":"object"}]},"type":"array"},"gateway_id":{"type":"string"},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string"},"version":{"properties":{"active":{"enum":["true","false"],"type":"string"},"comment":{"nullable":true,"type":"string"},"created_at":{"type":"string"},"data":{"type":"string"},"version_id":{"type":"string"}},"required":["version_id","data","active","created_at"],"type":"object"}},"required":["id","name","elements","created_at","modified_at","account_tag","gateway_id","version","deployment"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a new AI Gateway Dynamic Route.","tags":["AI Gateway Dynamic Routes"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}":{"delete":{"description":"Delete an AI Gateway Dynamic Route.","operationId":"aig-config-delete-gateway-dynamic-route","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"example":"54442216","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"example":"54442216","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"elements":{"items":{"oneOf":[{"properties":{"id":{"type":"string"},"outputs":{"properties":{"next":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["next"],"type":"object"},"type":{"enum":["start"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"false":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"true":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["true","false"],"type":"object"},"properties":{"properties":{"conditions":{"type":"object"}},"type":"object"},"type":{"enum":["conditional"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["percentage"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"key":{"type":"string"},"limit":{"type":"number"},"limitType":{"enum":["count","cost"],"type":"string"},"window":{"type":"number"}},"required":["limitType","key","limit","window"],"type":"object"},"type":{"enum":["rate"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"model":{"type":"string"},"provider":{"type":"string"},"retries":{"type":"number"},"timeout":{"type":"number"}},"required":["provider","model","timeout","retries"],"type":"object"},"type":{"enum":["model"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["end"],"type":"string"}},"required":["id","outputs","type"],"type":"object"}]},"type":"array"},"gateway_id":{"type":"string"},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string"}},"required":["id","name","elements","created_at","modified_at","account_tag","gateway_id"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete an AI Gateway Dynamic Route.","tags":["AI Gateway Dynamic Routes"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get an AI Gateway Dynamic Route.","operationId":"aig-config-get-gateway-dynamic-route","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"example":"54442216","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"example":"54442216","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"deployment":{"properties":{"comment":{"nullable":true,"type":"string"},"created_at":{"type":"string"},"deployment_id":{"type":"string"},"version_id":{"type":"string"}},"required":["deployment_id","version_id","created_at"],"type":"object"},"elements":{"items":{"oneOf":[{"properties":{"id":{"type":"string"},"outputs":{"properties":{"next":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["next"],"type":"object"},"type":{"enum":["start"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"false":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"true":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["true","false"],"type":"object"},"properties":{"properties":{"conditions":{"type":"object"}},"type":"object"},"type":{"enum":["conditional"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["percentage"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"key":{"type":"string"},"limit":{"type":"number"},"limitType":{"enum":["count","cost"],"type":"string"},"window":{"type":"number"}},"required":["limitType","key","limit","window"],"type":"object"},"type":{"enum":["rate"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"model":{"type":"string"},"provider":{"type":"string"},"retries":{"type":"number"},"timeout":{"type":"number"}},"required":["provider","model","timeout","retries"],"type":"object"},"type":{"enum":["model"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["end"],"type":"string"}},"required":["id","outputs","type"],"type":"object"}]},"type":"array"},"gateway_id":{"type":"string"},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string"},"version":{"properties":{"active":{"enum":["true","false"],"type":"string"},"comment":{"nullable":true,"type":"string"},"created_at":{"type":"string"},"data":{"type":"string"},"version_id":{"type":"string"}},"required":["version_id","data","active","created_at"],"type":"object"}},"required":["id","name","elements","created_at","modified_at","account_tag","gateway_id","version","deployment"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get an AI Gateway Dynamic Route.","tags":["AI Gateway Dynamic Routes"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Update an AI Gateway Dynamic Route.","operationId":"aig-config-update-gateway-dynamic-route","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"example":"54442216","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"example":"54442216","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"example":"Route Name","type":"string"}},"required":["name"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"route":{"properties":{"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"deployment":{"properties":{"comment":{"nullable":true,"type":"string"},"created_at":{"type":"string"},"deployment_id":{"type":"string"},"version_id":{"type":"string"}},"required":["deployment_id","version_id","created_at"],"type":"object"},"elements":{"items":{"oneOf":[{"properties":{"id":{"type":"string"},"outputs":{"properties":{"next":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["next"],"type":"object"},"type":{"enum":["start"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"false":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"true":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["true","false"],"type":"object"},"properties":{"properties":{"conditions":{"type":"object"}},"type":"object"},"type":{"enum":["conditional"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["percentage"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"key":{"type":"string"},"limit":{"type":"number"},"limitType":{"enum":["count","cost"],"type":"string"},"window":{"type":"number"}},"required":["limitType","key","limit","window"],"type":"object"},"type":{"enum":["rate"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"model":{"type":"string"},"provider":{"type":"string"},"retries":{"type":"number"},"timeout":{"type":"number"}},"required":["provider","model","timeout","retries"],"type":"object"},"type":{"enum":["model"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["end"],"type":"string"}},"required":["id","outputs","type"],"type":"object"}]},"type":"array"},"gateway_id":{"type":"string"},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string"},"version":{"properties":{"active":{"enum":["true","false"],"type":"string"},"comment":{"nullable":true,"type":"string"},"created_at":{"type":"string"},"data":{"type":"string"},"version_id":{"type":"string"}},"required":["version_id","data","active","created_at"],"type":"object"}},"required":["id","name","elements","created_at","modified_at","account_tag","gateway_id","version","deployment"],"type":"object"},"success":{"type":"boolean"}},"required":["success","route"],"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"properties":{"route":{"properties":{"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"elements":{"items":{"oneOf":[{"properties":{"id":{"type":"string"},"outputs":{"properties":{"next":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["next"],"type":"object"},"type":{"enum":["start"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"false":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"true":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["true","false"],"type":"object"},"properties":{"properties":{"conditions":{"type":"object"}},"type":"object"},"type":{"enum":["conditional"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["percentage"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"key":{"type":"string"},"limit":{"type":"number"},"limitType":{"enum":["count","cost"],"type":"string"},"window":{"type":"number"}},"required":["limitType","key","limit","window"],"type":"object"},"type":{"enum":["rate"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"model":{"type":"string"},"provider":{"type":"string"},"retries":{"type":"number"},"timeout":{"type":"number"}},"required":["provider","model","timeout","retries"],"type":"object"},"type":{"enum":["model"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["end"],"type":"string"}},"required":["id","outputs","type"],"type":"object"}]},"type":"array"},"gateway_id":{"type":"string"},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string"}},"required":["id","name","elements","created_at","modified_at","account_tag","gateway_id"],"type":"object"},"success":{"type":"boolean"}},"required":["success","route"],"type":"object"}}},"description":"Input Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update an AI Gateway Dynamic Route.","tags":["AI Gateway Dynamic Routes"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/deployments":{"get":{"description":"List all AI Gateway Dynamic Route Deployments.","operationId":"aig-config-list-gateway-dynamic-route-deployments","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"example":"54442216","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"example":"54442216","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"deployments":{"items":{"properties":{"comment":{"nullable":true,"type":"string"},"created_at":{"type":"string"},"deployment_id":{"type":"string"},"version_id":{"type":"string"}},"required":["deployment_id","version_id","created_at"],"type":"object"},"type":"array"},"order_by":{"type":"string"},"order_by_direction":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"}},"required":["deployments","page","per_page","order_by","order_by_direction"],"type":"object"},"success":{"type":"boolean"}},"required":["success","data"],"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List all AI Gateway Dynamic Route Deployments.","tags":["AI Gateway Dynamic Routes"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a new AI Gateway Dynamic Route Deployment.","operationId":"aig-config-post-gateway-dynamic-route-deployment","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"example":"54442216","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"example":"54442216","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"example":"Route Deployment Comment","type":"string"},"version_id":{"example":"54442216","type":"string"}},"required":["version_id","comment"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"elements":{"items":{"oneOf":[{"properties":{"id":{"type":"string"},"outputs":{"properties":{"next":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["next"],"type":"object"},"type":{"enum":["start"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"false":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"true":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["true","false"],"type":"object"},"properties":{"properties":{"conditions":{"type":"object"}},"type":"object"},"type":{"enum":["conditional"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["percentage"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"key":{"type":"string"},"limit":{"type":"number"},"limitType":{"enum":["count","cost"],"type":"string"},"window":{"type":"number"}},"required":["limitType","key","limit","window"],"type":"object"},"type":{"enum":["rate"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"model":{"type":"string"},"provider":{"type":"string"},"retries":{"type":"number"},"timeout":{"type":"number"}},"required":["provider","model","timeout","retries"],"type":"object"},"type":{"enum":["model"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["end"],"type":"string"}},"required":["id","outputs","type"],"type":"object"}]},"type":"array"},"gateway_id":{"type":"string"},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string"}},"required":["id","name","elements","created_at","modified_at","account_tag","gateway_id"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a new AI Gateway Dynamic Route Deployment.","tags":["AI Gateway Dynamic Routes"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions":{"get":{"description":"List all AI Gateway Dynamic Route Versions.","operationId":"aig-config-list-gateway-dynamic-route-versions","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"example":"54442216","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"example":"54442216","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"order_by":{"type":"string"},"order_by_direction":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"versions":{"items":{"properties":{"active":{"enum":["true","false"],"type":"string"},"comment":{"nullable":true,"type":"string"},"created_at":{"type":"string"},"data":{"type":"string"},"version_id":{"type":"string"}},"required":["version_id","data","active","created_at"],"type":"object"},"type":"array"}},"required":["versions","page","per_page","order_by","order_by_direction"],"type":"object"},"success":{"type":"boolean"}},"required":["success","data"],"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List all AI Gateway Dynamic Route Versions.","tags":["AI Gateway Dynamic Routes"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a new AI Gateway Dynamic Route Version.","operationId":"aig-config-post-gateway-dynamic-route-version","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"example":"54442216","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"example":"54442216","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"example":"Route Version Comment","type":"string"},"elements":{"items":{"oneOf":[{"properties":{"id":{"type":"string"},"outputs":{"properties":{"next":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["next"],"type":"object"},"type":{"enum":["start"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"false":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"true":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["true","false"],"type":"object"},"properties":{"properties":{"conditions":{"type":"object"}},"type":"object"},"type":{"enum":["conditional"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["percentage"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"key":{"type":"string"},"limit":{"type":"number"},"limitType":{"enum":["count","cost"],"type":"string"},"window":{"type":"number"}},"required":["limitType","key","limit","window"],"type":"object"},"type":{"enum":["rate"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"model":{"type":"string"},"provider":{"type":"string"},"retries":{"type":"number"},"timeout":{"type":"number"}},"required":["provider","model","timeout","retries"],"type":"object"},"type":{"enum":["model"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["end"],"type":"string"}},"required":["id","outputs","type"],"type":"object"}]},"type":"array"}},"required":["elements","comment"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_tag":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"elements":{"items":{"oneOf":[{"properties":{"id":{"type":"string"},"outputs":{"properties":{"next":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["next"],"type":"object"},"type":{"enum":["start"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"false":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"true":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["true","false"],"type":"object"},"properties":{"properties":{"conditions":{"type":"object"}},"type":"object"},"type":{"enum":["conditional"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["percentage"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"key":{"type":"string"},"limit":{"type":"number"},"limitType":{"enum":["count","cost"],"type":"string"},"window":{"type":"number"}},"required":["limitType","key","limit","window"],"type":"object"},"type":{"enum":["rate"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"model":{"type":"string"},"provider":{"type":"string"},"retries":{"type":"number"},"timeout":{"type":"number"}},"required":["provider","model","timeout","retries"],"type":"object"},"type":{"enum":["model"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["end"],"type":"string"}},"required":["id","outputs","type"],"type":"object"}]},"type":"array"},"gateway_id":{"type":"string"},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string"}},"required":["id","name","elements","created_at","modified_at","account_tag","gateway_id"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a new AI Gateway Dynamic Route Version.","tags":["AI Gateway Dynamic Routes"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions/{version_id}":{"get":{"description":"Get an AI Gateway Dynamic Route Version.","operationId":"aig-config-get-gateway-dynamic-route-version","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"path","name":"gateway_id","required":true,"schema":{"example":"54442216","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"example":"54442216","type":"string"}},{"in":"path","name":"version_id","required":true,"schema":{"example":"54442216","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_tag":{"type":"string"},"active":{"enum":["true","false"],"type":"string"},"comment":{"nullable":true,"type":"string"},"created_at":{"type":"string"},"data":{"type":"string"},"elements":{"items":{"oneOf":[{"properties":{"id":{"type":"string"},"outputs":{"properties":{"next":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["next"],"type":"object"},"type":{"enum":["start"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"false":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"true":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["true","false"],"type":"object"},"properties":{"properties":{"conditions":{"type":"object"}},"type":"object"},"type":{"enum":["conditional"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["percentage"],"type":"string"}},"required":["id","outputs","type"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"key":{"type":"string"},"limit":{"type":"number"},"limitType":{"enum":["count","cost"],"type":"string"},"window":{"type":"number"}},"required":["limitType","key","limit","window"],"type":"object"},"type":{"enum":["rate"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"properties":{"fallback":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"success":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"}},"required":["success","fallback"],"type":"object"},"properties":{"properties":{"model":{"type":"string"},"provider":{"type":"string"},"retries":{"type":"number"},"timeout":{"type":"number"}},"required":["provider","model","timeout","retries"],"type":"object"},"type":{"enum":["model"],"type":"string"}},"required":["id","outputs","type","properties"],"type":"object"},{"properties":{"id":{"type":"string"},"outputs":{"additionalProperties":{"properties":{"elementId":{"type":"string"}},"required":["elementId"],"type":"object"},"type":"object"},"type":{"enum":["end"],"type":"string"}},"required":["id","outputs","type"],"type":"object"}]},"type":"array"},"gateway_id":{"type":"string"},"id":{"type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string"},"version_id":{"type":"string"}},"required":["id","name","elements","created_at","modified_at","account_tag","gateway_id","version_id","data","active"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get an AI Gateway Dynamic Route Version.","tags":["AI Gateway Dynamic Routes"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/url/{provider}":{"get":{"operationId":"aig-config-get-gateway-url","parameters":[{"in":"path","name":"gateway_id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}},{"in":"path","name":"account_id","required":true,"schema":{"example":"0d37909e38d3e99c29fa2cd343ac421a","type":"string"}},{"in":"path","name":"provider","required":true,"schema":{"example":"workers-ai","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the log details"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Gateway URL","tags":["AI Gateway Gateways"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai-gateway/gateways/{id}":{"delete":{"operationId":"aig-config-delete-gateway","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"authentication":{"type":"boolean","x-auditable":true},"cache_invalidate_on_update":{"type":"boolean","x-auditable":true},"cache_ttl":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"collect_logs":{"type":"boolean","x-auditable":true},"created_at":{"format":"date-time","type":"string"},"dlp":{"anyOf":[{"properties":{"action":{"enum":["BLOCK","FLAG"],"type":"string"},"enabled":{"type":"boolean"},"profiles":{"items":{"type":"string"},"type":"array"}},"required":["profiles","enabled","action"],"type":"object"},{"properties":{"enabled":{"type":"boolean"},"policies":{"items":{"properties":{"action":{"enum":["FLAG","BLOCK"],"type":"string"},"check":{"items":{"enum":["REQUEST","RESPONSE"],"type":"string"},"type":"array"},"enabled":{"type":"boolean"},"id":{"type":"string"},"profiles":{"items":{"type":"string"},"type":"array"}},"required":["id","enabled","action","profiles","check"],"type":"object"},"type":"array"}},"required":["enabled","policies"],"type":"object"}]},"id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"internal_id":{"format":"uuid","type":"string"},"log_management":{"maximum":10000000,"minimum":10000,"nullable":true,"type":"integer","x-auditable":true},"log_management_strategy":{"enum":["STOP_INSERTING","DELETE_OLDEST"],"nullable":true,"type":"string","x-auditable":true},"logpush":{"type":"boolean","x-auditable":true},"logpush_public_key":{"maxLength":1024,"minLength":16,"nullable":true,"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"otel":{"items":{"properties":{"authorization":{"type":"string"},"headers":{"additionalProperties":{"type":"string"},"type":"object"},"url":{"type":"string"}},"required":["url","headers","authorization"],"type":"object"},"nullable":true,"type":"array","x-auditable":true},"rate_limiting_interval":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_limit":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_technique":{"enum":["fixed","sliding"],"type":"string","x-auditable":true},"store_id":{"nullable":true,"type":"string"},"stripe":{"nullable":true,"properties":{"authorization":{"type":"string"},"usage_events":{"items":{"properties":{"payload":{"type":"string"}},"required":["payload"],"type":"object"},"type":"array"}},"required":["authorization","usage_events"],"type":"object","x-auditable":true}},"required":["id","internal_id","account_id","account_tag","rate_limiting_interval","rate_limiting_limit","rate_limiting_technique","collect_logs","cache_ttl","cache_invalidate_on_update","created_at","modified_at"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the Object if it was successfully deleted"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a Gateway","tags":["AI Gateway Gateways"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"aig-config-fetch-gateway","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"authentication":{"type":"boolean","x-auditable":true},"cache_invalidate_on_update":{"type":"boolean","x-auditable":true},"cache_ttl":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"collect_logs":{"type":"boolean","x-auditable":true},"created_at":{"format":"date-time","type":"string"},"dlp":{"anyOf":[{"properties":{"action":{"enum":["BLOCK","FLAG"],"type":"string"},"enabled":{"type":"boolean"},"profiles":{"items":{"type":"string"},"type":"array"}},"required":["profiles","enabled","action"],"type":"object"},{"properties":{"enabled":{"type":"boolean"},"policies":{"items":{"properties":{"action":{"enum":["FLAG","BLOCK"],"type":"string"},"check":{"items":{"enum":["REQUEST","RESPONSE"],"type":"string"},"type":"array"},"enabled":{"type":"boolean"},"id":{"type":"string"},"profiles":{"items":{"type":"string"},"type":"array"}},"required":["id","enabled","action","profiles","check"],"type":"object"},"type":"array"}},"required":["enabled","policies"],"type":"object"}]},"id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"internal_id":{"format":"uuid","type":"string"},"log_management":{"maximum":10000000,"minimum":10000,"nullable":true,"type":"integer","x-auditable":true},"log_management_strategy":{"enum":["STOP_INSERTING","DELETE_OLDEST"],"nullable":true,"type":"string","x-auditable":true},"logpush":{"type":"boolean","x-auditable":true},"logpush_public_key":{"maxLength":1024,"minLength":16,"nullable":true,"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"otel":{"items":{"properties":{"authorization":{"type":"string"},"headers":{"additionalProperties":{"type":"string"},"type":"object"},"url":{"type":"string"}},"required":["url","headers","authorization"],"type":"object"},"nullable":true,"type":"array","x-auditable":true},"rate_limiting_interval":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_limit":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_technique":{"enum":["fixed","sliding"],"type":"string","x-auditable":true},"store_id":{"nullable":true,"type":"string"},"stripe":{"nullable":true,"properties":{"authorization":{"type":"string"},"usage_events":{"items":{"properties":{"payload":{"type":"string"}},"required":["payload"],"type":"object"},"type":"array"}},"required":["authorization","usage_events"],"type":"object","x-auditable":true}},"required":["id","internal_id","account_id","account_tag","rate_limiting_interval","rate_limiting_limit","rate_limiting_technique","collect_logs","cache_ttl","cache_invalidate_on_update","created_at","modified_at"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns a single object if found"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Fetch a Gateway","tags":["AI Gateway Gateways"],"x-api-token-group":["AI Gateway Write","AI Gateway Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"operationId":"aig-config-update-gateway","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"3ebbcb006d4d46d7bb6a8c7f14676cb0","type":"string"}},{"in":"path","name":"id","required":true,"schema":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"authentication":{"type":"boolean","x-auditable":true},"cache_invalidate_on_update":{"type":"boolean","x-auditable":true},"cache_ttl":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"collect_logs":{"type":"boolean","x-auditable":true},"dlp":{"anyOf":[{"properties":{"action":{"enum":["BLOCK","FLAG"],"type":"string"},"enabled":{"type":"boolean"},"profiles":{"items":{"type":"string"},"type":"array"}},"required":["profiles","enabled","action"],"type":"object"},{"properties":{"enabled":{"type":"boolean"},"policies":{"items":{"properties":{"action":{"enum":["FLAG","BLOCK"],"type":"string"},"check":{"items":{"enum":["REQUEST","RESPONSE"],"type":"string"},"type":"array"},"enabled":{"type":"boolean"},"id":{"type":"string"},"profiles":{"items":{"type":"string"},"type":"array"}},"required":["id","enabled","action","profiles","check"],"type":"object"},"type":"array"}},"required":["enabled","policies"],"type":"object"}]},"log_management":{"maximum":10000000,"minimum":10000,"nullable":true,"type":"integer","x-auditable":true},"log_management_strategy":{"enum":["STOP_INSERTING","DELETE_OLDEST"],"nullable":true,"type":"string","x-auditable":true},"logpush":{"type":"boolean","x-auditable":true},"logpush_public_key":{"maxLength":1024,"minLength":16,"nullable":true,"type":"string","x-auditable":true},"otel":{"items":{"properties":{"authorization":{"type":"string"},"headers":{"additionalProperties":{"type":"string"},"type":"object"},"url":{"type":"string"}},"required":["url","headers","authorization"],"type":"object"},"nullable":true,"type":"array","x-auditable":true},"rate_limiting_interval":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_limit":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_technique":{"enum":["fixed","sliding"],"type":"string","x-auditable":true},"store_id":{"nullable":true,"type":"string"},"stripe":{"nullable":true,"properties":{"authorization":{"type":"string"},"usage_events":{"items":{"properties":{"payload":{"type":"string"}},"required":["payload"],"type":"object"},"type":"array"}},"required":["authorization","usage_events"],"type":"object","x-auditable":true}},"required":["rate_limiting_interval","rate_limiting_limit","rate_limiting_technique","collect_logs","cache_ttl","cache_invalidate_on_update"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"account_id":{"type":"string"},"account_tag":{"type":"string"},"authentication":{"type":"boolean","x-auditable":true},"cache_invalidate_on_update":{"type":"boolean","x-auditable":true},"cache_ttl":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"collect_logs":{"type":"boolean","x-auditable":true},"created_at":{"format":"date-time","type":"string"},"dlp":{"anyOf":[{"properties":{"action":{"enum":["BLOCK","FLAG"],"type":"string"},"enabled":{"type":"boolean"},"profiles":{"items":{"type":"string"},"type":"array"}},"required":["profiles","enabled","action"],"type":"object"},{"properties":{"enabled":{"type":"boolean"},"policies":{"items":{"properties":{"action":{"enum":["FLAG","BLOCK"],"type":"string"},"check":{"items":{"enum":["REQUEST","RESPONSE"],"type":"string"},"type":"array"},"enabled":{"type":"boolean"},"id":{"type":"string"},"profiles":{"items":{"type":"string"},"type":"array"}},"required":["id","enabled","action","profiles","check"],"type":"object"},"type":"array"}},"required":["enabled","policies"],"type":"object"}]},"id":{"description":"gateway id","example":"my-gateway","maxLength":64,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string","x-auditable":true},"internal_id":{"format":"uuid","type":"string"},"log_management":{"maximum":10000000,"minimum":10000,"nullable":true,"type":"integer","x-auditable":true},"log_management_strategy":{"enum":["STOP_INSERTING","DELETE_OLDEST"],"nullable":true,"type":"string","x-auditable":true},"logpush":{"type":"boolean","x-auditable":true},"logpush_public_key":{"maxLength":1024,"minLength":16,"nullable":true,"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"otel":{"items":{"properties":{"authorization":{"type":"string"},"headers":{"additionalProperties":{"type":"string"},"type":"object"},"url":{"type":"string"}},"required":["url","headers","authorization"],"type":"object"},"nullable":true,"type":"array","x-auditable":true},"rate_limiting_interval":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_limit":{"minimum":0,"nullable":true,"type":"integer","x-auditable":true},"rate_limiting_technique":{"enum":["fixed","sliding"],"type":"string","x-auditable":true},"store_id":{"nullable":true,"type":"string"},"stripe":{"nullable":true,"properties":{"authorization":{"type":"string"},"usage_events":{"items":{"properties":{"payload":{"type":"string"}},"required":["payload"],"type":"object"},"type":"array"}},"required":["authorization","usage_events"],"type":"object","x-auditable":true}},"required":["id","internal_id","account_id","account_tag","rate_limiting_interval","rate_limiting_limit","rate_limiting_technique","collect_logs","cache_ttl","cache_invalidate_on_update","created_at","modified_at"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the updated Object"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7001,"type":"number"},"message":{"example":"Input Validation Error","type":"string"},"path":{"items":{"example":"body","type":"string"},"type":"array"}},"required":["code","message","path"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Input Validation Error"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update a Gateway","tags":["AI Gateway Gateways"],"x-api-token-group":["AI Gateway Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.aig"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/authors/search":{"get":{"operationId":"workers-ai-search-author","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"items":{"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","result","errors","messages"],"type":"object"}}},"description":"Returns a list of authors"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Author Search","tags":["Workers AI"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/finetunes":{"get":{"operationId":"workers-ai-list-finetunes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"id":{"format":"uuid","type":"string","x-auditable":true},"model":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true}},"required":["id","model","name","created_at","modified_at"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns all finetunes"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Finetunes","tags":["Workers AI Finetune"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"workers-ai-create-finetune","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"type":"string"},"model":{"type":"string","x-auditable":true},"name":{"type":"string","x-auditable":true},"public":{"default":false,"type":"boolean","x-auditable":true}},"required":["model","name"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"id":{"format":"uuid","type":"string","x-auditable":true},"model":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true},"public":{"type":"boolean","x-auditable":true}},"required":["id","created_at","modified_at","public","name","model"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the created finetune"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["errors","success"],"type":"object"}}},"description":"Finetune creation failed"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a new Finetune","tags":["Workers AI Finetune"],"x-api-token-group":["Workers AI Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/finetunes/public":{"get":{"operationId":"workers-ai-list-public-finetunes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string"}},{"description":"Pagination Limit","in":"query","name":"limit","schema":{"description":"Pagination Limit","type":"number"}},{"description":"Pagination Offset","in":"query","name":"offset","schema":{"description":"Pagination Offset","type":"number"}},{"description":"Order By Column Name","in":"query","name":"orderBy","schema":{"description":"Order By Column Name","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"id":{"format":"uuid","type":"string","x-auditable":true},"model":{"type":"string","x-auditable":true},"modified_at":{"format":"date-time","type":"string"},"name":{"type":"string","x-auditable":true},"public":{"type":"boolean","x-auditable":true}},"required":["id","model","name","public","created_at","modified_at"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns all public finetunes"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Public Finetunes","tags":["Workers AI Finetune"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/finetunes/{finetune_id}/finetune-assets":{"post":{"operationId":"workers-ai-upload-finetune-asset","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string"}},{"in":"path","name":"finetune_id","required":true,"schema":{"example":"bc451aef-f723-4b26-a6b2-901afd2e7a8a","type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"format":"binary","type":"string"},"file_name":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"}},"required":["success"],"type":"object"}}},"description":"Returns successfully if finetunes were uploaded"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Finetune creation failed"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Upload a Finetune Asset","tags":["Workers AI Finetune"],"x-api-token-group":["Workers AI Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/models/schema":{"get":{"operationId":"workers-ai-get-model-schema","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string"}},{"description":"Model Name","in":"query","name":"model","required":true,"schema":{"description":"Model Name","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Model Schema"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Model Schema","tags":["Workers AI"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/models/search":{"get":{"operationId":"workers-ai-search-model","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string"}},{"in":"query","name":"per_page","schema":{"type":"integer"}},{"in":"query","name":"page","schema":{"type":"integer"}},{"description":"Filter by Task Name","in":"query","name":"task","schema":{"description":"Filter by Task Name","example":"Text Generation","type":"string"}},{"description":"Filter by Author","in":"query","name":"author","schema":{"description":"Filter by Author","type":"string"}},{"description":"Filter by Source Id","in":"query","name":"source","schema":{"description":"Filter by Source Id","type":"number"}},{"description":"Filter to hide experimental models","in":"query","name":"hide_experimental","schema":{"description":"Filter to hide experimental models","type":"boolean"}},{"description":"Search","in":"query","name":"search","schema":{"description":"Search","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"items":{"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","result","errors","messages"],"type":"object"}}},"description":"Returns a list of models"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Object not found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Model Search","tags":["Workers AI"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/ai4bharat/indictrans2-en-indic-1B":{"post":{"operationId":"workers-ai-post-run-cf-ai4bharat-indictrans2-en-indic-1B","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"target_language":{"default":"hin_Deva","description":"Target langauge to translate to","enum":["asm_Beng","awa_Deva","ben_Beng","bho_Deva","brx_Deva","doi_Deva","eng_Latn","gom_Deva","gon_Deva","guj_Gujr","hin_Deva","hne_Deva","kan_Knda","kas_Arab","kas_Deva","kha_Latn","lus_Latn","mag_Deva","mai_Deva","mal_Mlym","mar_Deva","mni_Beng","mni_Mtei","npi_Deva","ory_Orya","pan_Guru","san_Deva","sat_Olck","snd_Arab","snd_Deva","tam_Taml","tel_Telu","urd_Arab","unr_Deva"],"type":"string"},"text":{"description":"Input text to translate. Can be a single string or a list of strings.","oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]}},"required":["text","target_language"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/ai4bharat/indictrans2-en-indic-1B model.","tags":["Workers AI Translation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/aisingapore/gemma-sea-lion-v4-27b-it":{"post":{"operationId":"workers-ai-post-run-cf-aisingapore-gemma-sea-lion-v4-27b-it","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":2000,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":2000,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"},{"properties":{"requests":{"items":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"},"type":"array"}},"required":["requests"],"title":"Async Batch","type":"object"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/aisingapore/gemma-sea-lion-v4-27b-it model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/baai/bge-base-en-v1.5":{"post":{"operationId":"workers-ai-post-run-cf-baai-bge-base-en-v1-5","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},{"properties":{"requests":{"description":"Batch of the embeddings requests to run using async-queue","items":{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},"type":"array"}},"required":["requests"]}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/baai/bge-base-en-v1.5 model.","tags":["Workers AI Text Embeddings"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/baai/bge-large-en-v1.5":{"post":{"operationId":"workers-ai-post-run-cf-baai-bge-large-en-v1-5","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},{"properties":{"requests":{"description":"Batch of the embeddings requests to run using async-queue","items":{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},"type":"array"}},"required":["requests"]}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/baai/bge-large-en-v1.5 model.","tags":["Workers AI Text Embeddings"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/baai/bge-m3":{"post":{"operationId":"workers-ai-post-run-cf-baai-bge-m3","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"contexts":{"description":"List of provided contexts. Note that the index in this array is important, as the response will refer to it.","items":{"properties":{"text":{"description":"One of the provided context content","minLength":1,"type":"string"}},"type":"object"},"type":"array"},"query":{"description":"A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts","minLength":1,"type":"string"},"truncate_inputs":{"default":false,"description":"When provided with too long context should the model error out or truncate the context to fit?","type":"boolean"}},"required":["contexts"],"title":"BGE M3 Input Query and Contexts"},{"properties":{"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]},"truncate_inputs":{"default":false,"description":"When provided with too long context should the model error out or truncate the context to fit?","type":"boolean"}},"required":["text"],"title":"BGE M3 Input Embedding"},{"properties":{"requests":{"description":"Batch of the embeddings requests to run using async-queue","items":{"oneOf":[{"properties":{"contexts":{"description":"List of provided contexts. Note that the index in this array is important, as the response will refer to it.","items":{"properties":{"text":{"description":"One of the provided context content","minLength":1,"type":"string"}},"type":"object"},"type":"array"},"query":{"description":"A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts","minLength":1,"type":"string"},"truncate_inputs":{"default":false,"description":"When provided with too long context should the model error out or truncate the context to fit?","type":"boolean"}},"required":["contexts"],"title":"BGE M3 Input Query and Contexts"},{"properties":{"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]},"truncate_inputs":{"default":false,"description":"When provided with too long context should the model error out or truncate the context to fit?","type":"boolean"}},"required":["text"],"title":"BGE M3 Input Embedding"}],"type":"object"},"type":"array"}},"required":["requests"]}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/baai/bge-m3 model.","tags":["Workers AI Text Embeddings"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/baai/bge-reranker-base":{"post":{"operationId":"workers-ai-post-run-cf-baai-bge-reranker-base","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"contexts":{"description":"List of provided contexts. Note that the index in this array is important, as the response will refer to it.","items":{"properties":{"text":{"description":"One of the provided context content","minLength":1,"type":"string"}},"type":"object"},"type":"array"},"query":{"description":"A query you wish to perform against the provided contexts.","minLength":1,"type":"string"},"top_k":{"description":"Number of returned results starting with the best score.","minimum":1,"type":"integer"}},"required":["query","contexts"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/baai/bge-reranker-base model.","tags":["Workers AI Text Classification"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/baai/bge-small-en-v1.5":{"post":{"operationId":"workers-ai-post-run-cf-baai-bge-small-en-v1-5","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},{"properties":{"requests":{"description":"Batch of the embeddings requests to run using async-queue","items":{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},"type":"array"}},"required":["requests"]}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/baai/bge-small-en-v1.5 model.","tags":["Workers AI Text Embeddings"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/baai/omni-bge-base-en-v1.5":{"post":{"operationId":"workers-ai-post-run-cf-baai-omni-bge-base-en-v1-5","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},{"properties":{"requests":{"description":"Batch of the embeddings requests to run using async-queue","items":{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},"type":"array"}},"required":["requests"]}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/baai/omni-bge-base-en-v1.5 model.","tags":["Workers AI Text Embeddings"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/baai/omni-bge-large-en-v1.5":{"post":{"operationId":"workers-ai-post-run-cf-baai-omni-bge-large-en-v1-5","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},{"properties":{"requests":{"description":"Batch of the embeddings requests to run using async-queue","items":{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},"type":"array"}},"required":["requests"]}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/baai/omni-bge-large-en-v1.5 model.","tags":["Workers AI Text Embeddings"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/baai/omni-bge-m3":{"post":{"operationId":"workers-ai-post-run-cf-baai-omni-bge-m3","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"contexts":{"description":"List of provided contexts. Note that the index in this array is important, as the response will refer to it.","items":{"properties":{"text":{"description":"One of the provided context content","minLength":1,"type":"string"}},"type":"object"},"type":"array"},"query":{"description":"A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts","minLength":1,"type":"string"},"truncate_inputs":{"default":false,"description":"When provided with too long context should the model error out or truncate the context to fit?","type":"boolean"}},"required":["contexts"],"title":"BGE M3 Input Query and Contexts"},{"properties":{"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]},"truncate_inputs":{"default":false,"description":"When provided with too long context should the model error out or truncate the context to fit?","type":"boolean"}},"required":["text"],"title":"BGE M3 Input Embedding"},{"properties":{"requests":{"description":"Batch of the embeddings requests to run using async-queue","items":{"oneOf":[{"properties":{"contexts":{"description":"List of provided contexts. Note that the index in this array is important, as the response will refer to it.","items":{"properties":{"text":{"description":"One of the provided context content","minLength":1,"type":"string"}},"type":"object"},"type":"array"},"query":{"description":"A query you wish to perform against the provided contexts. If no query is provided the model with respond with embeddings for contexts","minLength":1,"type":"string"},"truncate_inputs":{"default":false,"description":"When provided with too long context should the model error out or truncate the context to fit?","type":"boolean"}},"required":["contexts"],"title":"BGE M3 Input Query and Contexts"},{"properties":{"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]},"truncate_inputs":{"default":false,"description":"When provided with too long context should the model error out or truncate the context to fit?","type":"boolean"}},"required":["text"],"title":"BGE M3 Input Embedding"}],"type":"object"},"type":"array"}},"required":["requests"]}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/baai/omni-bge-m3 model.","tags":["Workers AI Text Embeddings"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/baai/omni-bge-small-en-v1.5":{"post":{"operationId":"workers-ai-post-run-cf-baai-omni-bge-small-en-v1-5","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},{"properties":{"requests":{"description":"Batch of the embeddings requests to run using async-queue","items":{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},"type":"array"}},"required":["requests"]}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/baai/omni-bge-small-en-v1.5 model.","tags":["Workers AI Text Embeddings"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/baai/ray-bge-large-en-v1.5":{"post":{"operationId":"workers-ai-post-run-cf-baai-ray-bge-large-en-v1-5","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},{"properties":{"requests":{"description":"Batch of the embeddings requests to run using async-queue","items":{"properties":{"pooling":{"default":"mean","description":"The pooling method used in the embedding process. `cls` pooling will generate more accurate embeddings on larger inputs - however, embeddings created with cls pooling are not compatible with embeddings generated with mean pooling. The default pooling method is `mean` in order for this to not be a breaking change, but we highly suggest using the new `cls` pooling for better accuracy.","enum":["mean","cls"],"type":"string"},"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"]},"type":"array"}},"required":["requests"]}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/baai/ray-bge-large-en-v1.5 model.","tags":["Workers AI Text Embeddings"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/black-forest-labs/flux-1-schnell":{"post":{"operationId":"workers-ai-post-run-cf-black-forest-labs-flux-1-schnell","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"prompt":{"description":"A text description of the image you want to generate.","maxLength":2048,"minLength":1,"type":"string"},"steps":{"default":4,"description":"The number of diffusion steps; higher values can improve quality but take longer.","maximum":8,"type":"integer"}},"required":["prompt"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/black-forest-labs/flux-1-schnell model.","tags":["Workers AI Text To Image"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/bytedance/stable-diffusion-xl-lightning":{"post":{"operationId":"workers-ai-post-run-cf-bytedance-stable-diffusion-xl-lightning","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"guidance":{"default":7.5,"description":"Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt","type":"number"},"height":{"description":"The height of the generated image in pixels","maximum":2048,"minimum":256,"type":"integer"},"image":{"description":"For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},"image_b64":{"description":"For use with img2img tasks. A base64-encoded string of the input image","type":"string"},"mask":{"description":"An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},"negative_prompt":{"description":"Text describing elements to avoid in the generated image","type":"string"},"num_steps":{"default":20,"description":"The number of diffusion steps; higher values can improve quality but take longer","maximum":20,"type":"integer"},"prompt":{"description":"A text description of the image you want to generate","minLength":1,"type":"string"},"seed":{"description":"Random seed for reproducibility of the image generation","type":"integer"},"strength":{"default":1,"description":"A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image","type":"number"},"width":{"description":"The width of the generated image in pixels","maximum":2048,"minimum":256,"type":"integer"}},"required":["prompt"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/bytedance/stable-diffusion-xl-lightning model.","tags":["Workers AI Text To Image"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/deepgram/aura":{"get":{"operationId":"workers-ai-post-websocket-run-cf-deepgram-aura","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}}],"responses":{"101":{"description":"Returns a websocket connection"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Open Websocket connection with @cf/deepgram/aura model.","tags":["Workers AI Text To Speech"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/deepgram/aura-1":{"get":{"operationId":"workers-ai-post-websocket-run-cf-deepgram-aura-1","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}}],"responses":{"101":{"description":"Returns a websocket connection"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Open Websocket connection with @cf/deepgram/aura-1 model.","tags":["Workers AI Text To Speech"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"workers-ai-post-run-cf-deepgram-aura-1","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"bit_rate":{"description":"The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type.","type":"number"},"container":{"description":"Container specifies the file format wrapper for the output audio. The available options depend on the encoding type..","enum":["none","wav","ogg"],"type":"string"},"encoding":{"description":"Encoding of the output audio.","enum":["linear16","flac","mulaw","alaw","mp3","opus","aac"],"type":"string"},"sample_rate":{"description":"Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable","type":"number"},"speaker":{"default":"angus","description":"Speaker used to produce the audio.","enum":["angus","asteria","arcas","orion","orpheus","athena","luna","zeus","perseus","helios","hera","stella"],"type":"string"},"text":{"description":"The text content to be converted to speech","type":"string"}},"required":["text"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/deepgram/aura-1 model.","tags":["Workers AI Text To Speech"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/deepgram/aura-1-internal":{"get":{"operationId":"workers-ai-post-websocket-run-cf-deepgram-aura-1-internal","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}}],"responses":{"101":{"description":"Returns a websocket connection"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Open Websocket connection with @cf/deepgram/aura-1-internal model.","tags":["Workers AI Text To Speech"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/deepgram/aura-2":{"get":{"operationId":"workers-ai-post-websocket-run-cf-deepgram-aura-2","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}}],"responses":{"101":{"description":"Returns a websocket connection"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Open Websocket connection with @cf/deepgram/aura-2 model.","tags":["Workers AI Text To Speech"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/deepgram/aura-2-en":{"get":{"operationId":"workers-ai-post-websocket-run-cf-deepgram-aura-2-en","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}}],"responses":{"101":{"description":"Returns a websocket connection"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Open Websocket connection with @cf/deepgram/aura-2-en model.","tags":["Workers AI Text To Speech"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"workers-ai-post-run-cf-deepgram-aura-2-en","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"bit_rate":{"description":"The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type.","type":"number"},"container":{"description":"Container specifies the file format wrapper for the output audio. The available options depend on the encoding type..","enum":["none","wav","ogg"],"type":"string"},"encoding":{"description":"Encoding of the output audio.","enum":["linear16","flac","mulaw","alaw","mp3","opus","aac"],"type":"string"},"sample_rate":{"description":"Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable","type":"number"},"speaker":{"default":"luna","description":"Speaker used to produce the audio.","enum":["amalthea","andromeda","apollo","arcas","aries","asteria","athena","atlas","aurora","callista","cora","cordelia","delia","draco","electra","harmonia","helena","hera","hermes","hyperion","iris","janus","juno","jupiter","luna","mars","minerva","neptune","odysseus","ophelia","orion","orpheus","pandora","phoebe","pluto","saturn","thalia","theia","vesta","zeus"],"type":"string"},"text":{"description":"The text content to be converted to speech","type":"string"}},"required":["text"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/deepgram/aura-2-en model.","tags":["Workers AI Text To Speech"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/deepgram/aura-2-es":{"get":{"operationId":"workers-ai-post-websocket-run-cf-deepgram-aura-2-es","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}}],"responses":{"101":{"description":"Returns a websocket connection"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Open Websocket connection with @cf/deepgram/aura-2-es model.","tags":["Workers AI Text To Speech"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"workers-ai-post-run-cf-deepgram-aura-2-es","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"bit_rate":{"description":"The bitrate of the audio in bits per second. Choose from predefined ranges or specific values based on the encoding type.","type":"number"},"container":{"description":"Container specifies the file format wrapper for the output audio. The available options depend on the encoding type..","enum":["none","wav","ogg"],"type":"string"},"encoding":{"description":"Encoding of the output audio.","enum":["linear16","flac","mulaw","alaw","mp3","opus","aac"],"type":"string"},"sample_rate":{"description":"Sample Rate specifies the sample rate for the output audio. Based on the encoding, different sample rates are supported. For some encodings, the sample rate is not configurable","type":"number"},"speaker":{"default":"aquila","description":"Speaker used to produce the audio.","enum":["sirio","nestor","carina","celeste","alvaro","diana","aquila","selena","estrella","javier"],"type":"string"},"text":{"description":"The text content to be converted to speech","type":"string"}},"required":["text"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/deepgram/aura-2-es model.","tags":["Workers AI Text To Speech"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/deepgram/flux":{"get":{"operationId":"workers-ai-post-websocket-run-cf-deepgram-flux","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}}],"responses":{"101":{"description":"Returns a websocket connection"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Open Websocket connection with @cf/deepgram/flux model.","tags":["Workers AI Automatic Speech Recognition"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"workers-ai-post-run-cf-deepgram-flux","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"eager_eot_threshold":{"description":"End-of-turn confidence required to fire an eager end-of-turn event. When set, enables EagerEndOfTurn and TurnResumed events. Valid Values 0.3 - 0.9.","type":"string"},"encoding":{"description":"Encoding of the audio stream. Currently only supports raw signed little-endian 16-bit PCM.","enum":["linear16"],"type":"string"},"eot_threshold":{"default":"0.7","description":"End-of-turn confidence required to finish a turn. Valid Values 0.5 - 0.9.","type":"string"},"eot_timeout_ms":{"default":"5000","description":"A turn will be finished when this much time has passed after speech, regardless of EOT confidence.","pattern":"^[0-9]+$","type":"string"},"keyterm":{"description":"Keyterm prompting can improve recognition of specialized terminology. Pass multiple keyterm query parameters to boost multiple keyterms.","type":"string"},"mip_opt_out":{"default":"false","description":"Opts out requests from the Deepgram Model Improvement Program. Refer to Deepgram Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip","enum":["true","false"],"type":"string"},"sample_rate":{"description":"Sample rate of the audio stream in Hz.","pattern":"^[0-9]+$","type":"string"},"tag":{"description":"Label your requests for the purpose of identification during usage reporting","type":"string"}},"required":["sample_rate","encoding"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/deepgram/flux model.","tags":["Workers AI Automatic Speech Recognition"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/deepgram/nova-3":{"get":{"operationId":"workers-ai-post-websocket-run-cf-deepgram-nova-3","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}}],"responses":{"101":{"description":"Returns a websocket connection"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Open Websocket connection with @cf/deepgram/nova-3 model.","tags":["Workers AI Automatic Speech Recognition"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"workers-ai-post-run-cf-deepgram-nova-3","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"audio":{"properties":{"body":{"type":"object"},"contentType":{"type":"string"}},"required":["body","contentType"],"type":"object"},"channels":{"description":"The number of channels in the submitted audio","type":"number"},"custom_intent":{"description":"Custom intents you want the model to detect within your input audio if present","type":"string"},"custom_intent_mode":{"description":"Sets how the model will interpret intents submitted to the custom_intent param. When strict, the model will only return intents submitted using the custom_intent param. When extended, the model will return its own detected intents in addition those submitted using the custom_intents param","enum":["extended","strict"],"type":"string"},"custom_topic":{"description":"Custom topics you want the model to detect within your input audio or text if present Submit up to 100","type":"string"},"custom_topic_mode":{"description":"Sets how the model will interpret strings submitted to the custom_topic param. When strict, the model will only return topics submitted using the custom_topic param. When extended, the model will return its own detected topics in addition to those submitted using the custom_topic param.","enum":["extended","strict"],"type":"string"},"detect_entities":{"description":"Identifies and extracts key entities from content in submitted audio","type":"boolean"},"detect_language":{"description":"Identifies the dominant language spoken in submitted audio","type":"boolean"},"diarize":{"description":"Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0","type":"boolean"},"dictation":{"description":"Identify and extract key entities from content in submitted audio","type":"boolean"},"encoding":{"description":"Specify the expected encoding of your submitted audio","enum":["linear16","flac","mulaw","amr-nb","amr-wb","opus","speex","g729"],"type":"string"},"endpointing":{"description":"Indicates how long model will wait to detect whether a speaker has finished speaking or pauses for a significant period of time. When set to a value, the streaming endpoint immediately finalizes the transcription for the processed time range and returns the transcript with a speech_final parameter set to true. Can also be set to false to disable endpointing","type":"string"},"extra":{"description":"Arbitrary key-value pairs that are attached to the API response for usage in downstream processing","type":"string"},"filler_words":{"description":"Filler Words can help transcribe interruptions in your audio, like 'uh' and 'um'","type":"boolean"},"interim_results":{"description":"Specifies whether the streaming endpoint should provide ongoing transcription updates as more audio is received. When set to true, the endpoint sends continuous updates, meaning transcription results may evolve over time. Note: Supported only for webosockets.","type":"boolean"},"keyterm":{"description":"Key term prompting can boost or suppress specialized terminology and brands.","type":"string"},"keywords":{"description":"Keywords can boost or suppress specialized terminology and brands.","type":"string"},"language":{"description":"The BCP-47 language tag that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available.","type":"string"},"measurements":{"description":"Spoken measurements will be converted to their corresponding abbreviations.","type":"boolean"},"mip_opt_out":{"description":"Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip.","type":"boolean"},"mode":{"description":"Mode of operation for the model representing broad area of topic that will be talked about in the supplied audio","enum":["general","medical","finance"],"type":"string"},"multichannel":{"description":"Transcribe each audio channel independently.","type":"boolean"},"numerals":{"description":"Numerals converts numbers from written format to numerical format.","type":"boolean"},"paragraphs":{"description":"Splits audio into paragraphs to improve transcript readability.","type":"boolean"},"profanity_filter":{"description":"Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely.","type":"boolean"},"punctuate":{"description":"Add punctuation and capitalization to the transcript.","type":"boolean"},"redact":{"description":"Redaction removes sensitive information from your transcripts.","type":"string"},"replace":{"description":"Search for terms or phrases in submitted audio and replaces them.","type":"string"},"search":{"description":"Search for terms or phrases in submitted audio.","type":"string"},"sentiment":{"description":"Recognizes the sentiment throughout a transcript or text.","type":"boolean"},"smart_format":{"description":"Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability.","type":"boolean"},"topics":{"description":"Detect topics throughout a transcript or text.","type":"boolean"},"utt_split":{"description":"Seconds to wait before detecting a pause between words in submitted audio.","type":"number"},"utterance_end_ms":{"description":"Indicates how long model will wait to send an UtteranceEnd message after a word has been transcribed. Use with interim_results. Note: Supported only for webosockets.","type":"boolean"},"utterances":{"description":"Segments speech into meaningful semantic units.","type":"boolean"},"vad_events":{"description":"Indicates that speech has started. You'll begin receiving Speech Started messages upon speech starting. Note: Supported only for webosockets.","type":"boolean"}},"required":["audio"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/deepgram/nova-3 model.","tags":["Workers AI Automatic Speech Recognition"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/deepgram/nova-3-internal":{"get":{"operationId":"workers-ai-post-websocket-run-cf-deepgram-nova-3-internal","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}}],"responses":{"101":{"description":"Returns a websocket connection"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Open Websocket connection with @cf/deepgram/nova-3-internal model.","tags":["Workers AI Automatic Speech Recognition"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/deepseek-ai/deepseek-math-7b-instruct":{"post":{"operationId":"workers-ai-post-run-cf-deepseek-ai-deepseek-math-7b-instruct","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/deepseek-ai/deepseek-math-7b-instruct model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/deepseek-ai/deepseek-r1-distill-qwen-32b":{"post":{"operationId":"workers-ai-post-run-cf-deepseek-ai-deepseek-r1-distill-qwen-32b","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/deepseek-ai/deepseek-r1-distill-qwen-32b model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/defog/sqlcoder-7b-2":{"post":{"operationId":"workers-ai-post-run-cf-defog-sqlcoder-7b-2","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/defog/sqlcoder-7b-2 model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/facebook/bart-large-cnn":{"post":{"operationId":"workers-ai-post-run-cf-facebook-bart-large-cnn","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"input_text":{"description":"The text that you want the model to summarize","minLength":1,"type":"string"},"max_length":{"default":1024,"description":"The maximum length of the generated summary in tokens","type":"integer"}},"required":["input_text"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/facebook/bart-large-cnn model.","tags":["Workers AI Summarization"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/facebook/omni-bart-large-cnn":{"post":{"operationId":"workers-ai-post-run-cf-facebook-omni-bart-large-cnn","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"input_text":{"description":"The text that you want the model to summarize","minLength":1,"type":"string"},"max_length":{"default":1024,"description":"The maximum length of the generated summary in tokens","type":"integer"}},"required":["input_text"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/facebook/omni-bart-large-cnn model.","tags":["Workers AI Summarization"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/facebook/omni-detr-resnet-50":{"post":{"operationId":"workers-ai-post-run-cf-facebook-omni-detr-resnet-50","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/facebook/omni-detr-resnet-50 model.","tags":["Workers AI Object Detection"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/fblgit/una-cybertron-7b-v2-bf16":{"post":{"operationId":"workers-ai-post-run-cf-fblgit-una-cybertron-7b-v2-bf16","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/fblgit/una-cybertron-7b-v2-bf16 model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/google/embeddinggemma-300m":{"post":{"operationId":"workers-ai-post-run-cf-google-embeddinggemma-300m","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/google/embeddinggemma-300m model.","tags":["Workers AI Text Embeddings"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/google/gemma-2b-it-lora":{"post":{"operationId":"workers-ai-post-run-cf-google-gemma-2b-it-lora","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/google/gemma-2b-it-lora model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/google/gemma-3-12b-it":{"post":{"operationId":"workers-ai-post-run-cf-google-gemma-3-12b-it","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"guided_json":{"description":"JSON schema that should be fufilled for the response.","type":"object"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["prompt"],"title":"Google_Gemma_3_12B_It_Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"guided_json":{"description":"JSON schema that should be fufilled for the response.","type":"object"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"oneOf":[{"description":"The content of the message as a string.","type":"string"},{"items":{"properties":{"image_url":{"properties":{"url":{"description":"image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted","pattern":"^data:*","type":"string"}},"type":"object"},"text":{"type":"string"},"type":{"description":"Type of the content provided","type":"string"}},"type":"object"},"type":"array"}]},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["messages"],"title":"Google_Gemma_3_12B_It_Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/google/gemma-3-12b-it model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/google/gemma-7b-it-lora":{"post":{"operationId":"workers-ai-post-run-cf-google-gemma-7b-it-lora","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/google/gemma-7b-it-lora model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/google/omni-embeddinggemma-300m":{"post":{"operationId":"workers-ai-post-run-cf-google-omni-embeddinggemma-300m","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"text":{"description":"Input text to embed. Can be a single string or a list of strings.","oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]}},"required":["text"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/google/omni-embeddinggemma-300m model.","tags":["Workers AI Text Embeddings"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/huggingface/distilbert-sst-2-int8":{"post":{"operationId":"workers-ai-post-run-cf-huggingface-distilbert-sst-2-int8","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"text":{"description":"The text that you want to classify","minLength":1,"type":"string"}},"required":["text"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/huggingface/distilbert-sst-2-int8 model.","tags":["Workers AI Text Classification"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/huggingface/omni-distilbert-sst-2-int8":{"post":{"operationId":"workers-ai-post-run-cf-huggingface-omni-distilbert-sst-2-int8","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"text":{"description":"The text that you want to classify","minLength":1,"type":"string"}},"required":["text"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/huggingface/omni-distilbert-sst-2-int8 model.","tags":["Workers AI Text Classification"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/ibm-granite/granite-4.0-h-micro":{"post":{"operationId":"workers-ai-post-run-cf-ibm-granite-granite-4-0-h-micro","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/ibm-granite/granite-4.0-h-micro model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/leonardo/lucid-origin":{"post":{"operationId":"workers-ai-post-run-cf-leonardo-lucid-origin","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"guidance":{"default":4.5,"description":"Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt","maximum":10,"minimum":0,"type":"number"},"height":{"default":1120,"description":"The height of the generated image in pixels","maximum":2500,"minimum":0,"type":"integer"},"num_steps":{"description":"The number of diffusion steps; higher values can improve quality but take longer","maximum":40,"minimum":1,"type":"integer"},"prompt":{"description":"A text description of the image you want to generate.","minLength":1,"type":"string"},"seed":{"description":"Random seed for reproducibility of the image generation","minimum":0,"type":"integer"},"steps":{"description":"The number of diffusion steps; higher values can improve quality but take longer","maximum":40,"minimum":1,"type":"integer"},"width":{"default":1120,"description":"The width of the generated image in pixels","maximum":2500,"minimum":0,"type":"integer"}},"required":["prompt"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/leonardo/lucid-origin model.","tags":["Workers AI Text To Image"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/leonardo/phoenix-1.0":{"post":{"operationId":"workers-ai-post-run-cf-leonardo-phoenix-1-0","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"guidance":{"default":2,"description":"Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt","maximum":10,"minimum":2,"type":"number"},"height":{"default":1024,"description":"The height of the generated image in pixels","maximum":2048,"minimum":0,"type":"integer"},"negative_prompt":{"description":"Specify what to exclude from the generated images","minLength":1,"type":"string"},"num_steps":{"default":25,"description":"The number of diffusion steps; higher values can improve quality but take longer","maximum":50,"minimum":1,"type":"integer"},"prompt":{"description":"A text description of the image you want to generate.","minLength":1,"type":"string"},"seed":{"description":"Random seed for reproducibility of the image generation","minimum":0,"type":"integer"},"width":{"default":1024,"description":"The width of the generated image in pixels","maximum":2048,"minimum":0,"type":"integer"}},"required":["prompt"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/leonardo/phoenix-1.0 model.","tags":["Workers AI Text To Image"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/lykon/dreamshaper-8-lcm":{"post":{"operationId":"workers-ai-post-run-cf-lykon-dreamshaper-8-lcm","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"guidance":{"default":7.5,"description":"Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt","type":"number"},"height":{"description":"The height of the generated image in pixels","maximum":2048,"minimum":256,"type":"integer"},"image":{"description":"For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},"image_b64":{"description":"For use with img2img tasks. A base64-encoded string of the input image","type":"string"},"mask":{"description":"An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},"negative_prompt":{"description":"Text describing elements to avoid in the generated image","type":"string"},"num_steps":{"default":20,"description":"The number of diffusion steps; higher values can improve quality but take longer","maximum":20,"type":"integer"},"prompt":{"description":"A text description of the image you want to generate","minLength":1,"type":"string"},"seed":{"description":"Random seed for reproducibility of the image generation","type":"integer"},"strength":{"default":1,"description":"A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image","type":"number"},"width":{"description":"The width of the generated image in pixels","maximum":2048,"minimum":256,"type":"integer"}},"required":["prompt"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/lykon/dreamshaper-8-lcm model.","tags":["Workers AI Text To Image"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta-llama/llama-2-7b-chat-hf-lora":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-llama-2-7b-chat-hf-lora","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta-llama/llama-2-7b-chat-hf-lora model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-2-7b-chat-fp16":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-2-7b-chat-fp16","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-2-7b-chat-fp16 model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-2-7b-chat-int8":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-2-7b-chat-int8","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-2-7b-chat-int8 model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-3-8b-instruct":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-3-8b-instruct","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-3-8b-instruct model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-3-8b-instruct-awq":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-3-8b-instruct-awq","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-3-8b-instruct-awq model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-3.1-70b-instruct-fp8-fast":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-3-1-70b-instruct-fp8-fast","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-3.1-70b-instruct-fp8-fast model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-3.1-8b-instruct-awq":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-3-1-8b-instruct-awq","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-3.1-8b-instruct-awq model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-3.1-8b-instruct-fp8":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-3-1-8b-instruct-fp8","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-3.1-8b-instruct-fp8 model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-3.1-8b-instruct-fp8-fast":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-3-1-8b-instruct-fp8-fast","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-3.1-8b-instruct-fp8-fast model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-3.2-11b-vision-instruct":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-3-2-11b-vision-instruct","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"image":{"oneOf":[{"description":"An array of integers that represent the image data constrained to 8-bit unsigned integer values.  Deprecated, use image as a part of messages now.","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},{"description":"Binary string representing the image contents.  Deprecated, use image as a part of messages now.","format":"binary","type":"string"}]},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","maxLength":131072,"minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"image":{"oneOf":[{"description":"An array of integers that represent the image data constrained to 8-bit unsigned integer values. Deprecated, use image as a part of messages now.","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},{"description":"Binary string representing the image contents. Deprecated, use image as a part of messages now.","format":"binary","type":"string"}]},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"oneOf":[{"description":"The content of the message as a string.","type":"string"},{"items":{"properties":{"image_url":{"properties":{"url":{"description":"image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted","pattern":"^data:*","type":"string"}},"type":"object"},"text":{"type":"string"},"type":{"description":"Type of the content provided","type":"string"}},"type":"object"},"type":"array"},{"properties":{"image_url":{"properties":{"url":{"description":"image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted","pattern":"^data:*","type":"string"}},"type":"object"},"text":{"type":"string"},"type":{"description":"Type of the content provided","type":"string"}},"type":"object"}]},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"},"tool_call_id":{"description":"The tool call id. Must be supplied for tool calls for Mistral-3. If you don't know what to put here you can fall back to 000000001","pattern":"[a-zA-Z0-9]{9}","type":"string"}},"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Controls the creativity of the AI's responses by adjusting how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-3.2-11b-vision-instruct model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-3.2-1b-instruct":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-3-2-1b-instruct","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-3.2-1b-instruct model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-3.2-3b-instruct":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-3-2-3b-instruct","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-3.2-3b-instruct model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-3.3-70b-instruct-fp8-fast":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-3-3-70b-instruct-fp8-fast","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Meta_Llama_3_3_70B_Instruct_Fp8_Fast_Messages"},{"properties":{"requests":{"items":{"properties":{"external_reference":{"description":"User-supplied reference. This field will be present in the response as well it can be used to reference the request and response. It's NOT validated to be unique.","type":"string"},"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"prompt":{"description":"Prompt for the text generation model","minLength":1,"type":"string"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"type":"object"},"type":"array"}},"title":"Async Batch","type":"object"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-3.3-70b-instruct-fp8-fast model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-4-scout-17b-16e-instruct":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-4-scout-17b-16e-instruct","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"guided_json":{"description":"JSON schema that should be fulfilled for the response.","type":"object"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.15,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["prompt"],"title":"Ai_Cf_Meta_Llama_4_Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"guided_json":{"description":"JSON schema that should be fufilled for the response.","type":"object"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"oneOf":[{"description":"The content of the message as a string.","type":"string"},{"items":{"properties":{"image_url":{"properties":{"url":{"description":"image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted","pattern":"^data:*","type":"string"}},"type":"object"},"text":{"type":"string"},"type":{"description":"Type of the content provided","type":"string"}},"type":"object"},"type":"array"},{"properties":{"image_url":{"properties":{"url":{"description":"image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted","pattern":"^data:*","type":"string"}},"type":"object"},"text":{"type":"string"},"type":{"description":"Type of the content provided","type":"string"}},"type":"object"}]},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"},"tool_call_id":{"description":"The tool call id. If you don't know what to put here you can fall back to 000000001","pattern":"[a-zA-Z0-9]{9}","type":"string"}},"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.15,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["messages"],"title":"Ai_Cf_Meta_Llama_4_Messages"},{"properties":{"requests":{"items":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"guided_json":{"description":"JSON schema that should be fulfilled for the response.","type":"object"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.15,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["prompt"],"title":"Ai_Cf_Meta_Llama_4_Prompt_Inner"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"guided_json":{"description":"JSON schema that should be fufilled for the response.","type":"object"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"oneOf":[{"description":"The content of the message as a string.","type":"string"},{"items":{"properties":{"image_url":{"properties":{"url":{"description":"image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted","pattern":"^data:*","type":"string"}},"type":"object"},"text":{"type":"string"},"type":{"description":"Type of the content provided","type":"string"}},"type":"object"},"type":"array"},{"properties":{"image_url":{"properties":{"url":{"description":"image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted","pattern":"^data:*","type":"string"}},"type":"object"},"text":{"type":"string"},"type":{"description":"Type of the content provided","type":"string"}},"type":"object"}]},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"},"tool_call_id":{"description":"The tool call id. If you don't know what to put here you can fall back to 000000001","pattern":"[a-zA-Z0-9]{9}","type":"string"}},"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.15,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["messages"],"title":"Ai_Cf_Meta_Llama_4_Messages_Inner"}],"type":"object"},"type":"array"}},"required":["requests"],"title":"Ai_Cf_Meta_Llama_4_Async_Batch","type":"object"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-4-scout-17b-16e-instruct model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/llama-guard-3-8b":{"post":{"operationId":"workers-ai-post-run-cf-meta-llama-guard-3-8b","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender must alternate between 'user' and 'assistant'.","enum":["user","assistant"]}},"required":["role","content"],"type":"object"},"type":"array"},"response_format":{"description":"Dictate the output format of the generated response.","properties":{"type":{"description":"Set to json_object to process and output generated text as JSON.","type":"string"}},"type":"object"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"}},"required":["messages"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/llama-guard-3-8b model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/meta/m2m100-1.2b":{"post":{"operationId":"workers-ai-post-run-cf-meta-m2m100-1-2b","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"source_lang":{"default":"en","description":"The language code of the source text (e.g., 'en' for English). Defaults to 'en' if not specified","type":"string"},"target_lang":{"description":"The language code to translate the text into (e.g., 'es' for Spanish)","type":"string"},"text":{"description":"The text to be translated","minLength":1,"type":"string"}},"required":["text","target_lang"]},{"properties":{"requests":{"description":"Batch of the embeddings requests to run using async-queue","items":{"properties":{"source_lang":{"default":"en","description":"The language code of the source text (e.g., 'en' for English). Defaults to 'en' if not specified","type":"string"},"target_lang":{"description":"The language code to translate the text into (e.g., 'es' for Spanish)","type":"string"},"text":{"description":"The text to be translated","minLength":1,"type":"string"}},"required":["text","target_lang"],"type":"object"},"type":"array"}},"required":["requests"]}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/meta/m2m100-1.2b model.","tags":["Workers AI Translation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/microsoft/phi-2":{"post":{"operationId":"workers-ai-post-run-cf-microsoft-phi-2","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/microsoft/phi-2 model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/microsoft/resnet-50":{"post":{"operationId":"workers-ai-post-run-cf-microsoft-resnet-50","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/microsoft/resnet-50 model.","tags":["Workers AI Image Classification"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/mistral/mistral-7b-instruct-v0.1":{"post":{"operationId":"workers-ai-post-run-cf-mistral-mistral-7b-instruct-v0-1","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/mistral/mistral-7b-instruct-v0.1 model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/mistral/mistral-7b-instruct-v0.2-lora":{"post":{"operationId":"workers-ai-post-run-cf-mistral-mistral-7b-instruct-v0-2-lora","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/mistral/mistral-7b-instruct-v0.2-lora model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/mistralai/mistral-small-3.1-24b-instruct":{"post":{"operationId":"workers-ai-post-run-cf-mistralai-mistral-small-3-1-24b-instruct","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"guided_json":{"description":"JSON schema that should be fulfilled for the response.","type":"object"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.15,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["prompt"],"title":"Mistral_Small_3_1_24B_Instruct_Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"guided_json":{"description":"JSON schema that should be fufilled for the response.","type":"object"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"oneOf":[{"description":"The content of the message as a string.","type":"string"},{"items":{"properties":{"image_url":{"properties":{"url":{"description":"image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted","pattern":"^data:*","type":"string"}},"type":"object"},"text":{"type":"string"},"type":{"description":"Type of the content provided","type":"string"}},"type":"object"},"type":"array"},{"properties":{"image_url":{"properties":{"url":{"description":"image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted","pattern":"^data:*","type":"string"}},"type":"object"},"text":{"type":"string"},"type":{"description":"Type of the content provided","type":"string"}},"type":"object"}]},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"},"tool_call_id":{"description":"The tool call id. Must be supplied for tool calls for Mistral-3. If you don't know what to put here you can fall back to 000000001","pattern":"[a-zA-Z0-9]{9}","type":"string"}},"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.15,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["messages"],"title":"Mistral_Small_3_1_24B_Instruct_Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/mistralai/mistral-small-3.1-24b-instruct model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/myshell-ai/melotts":{"post":{"operationId":"workers-ai-post-run-cf-myshell-ai-melotts","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"lang":{"default":"en","description":"The speech language (e.g., 'en' for English, 'fr' for French). Defaults to 'en' if not specified","type":"string"},"prompt":{"description":"A text description of the audio you want to generate","minLength":1,"type":"string"}},"required":["prompt"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/myshell-ai/melotts model.","tags":["Workers AI Text To Speech"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/openai/gpt-oss-120b":{"post":{"operationId":"workers-ai-post-run-cf-openai-gpt-oss-120b","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"input":{"anyOf":[{"type":"string"},{"items":{},"type":"array"}],"description":"Responses API Input messages. Refer to OpenAI Responses API docs to learn more about supported content types"},"reasoning":{"properties":{"effort":{"description":"Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.","enum":["low","medium","high"],"type":"string"},"summary":{"description":"A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.","enum":["auto","concise","detailed"],"type":"string"}},"type":"object"}},"required":["input"],"title":"GPT_OSS_120B_Responses","type":"object"},{"properties":{"requests":{"items":{"properties":{"input":{"anyOf":[{"type":"string"},{"items":{},"type":"array"}],"description":"Responses API Input messages. Refer to OpenAI Responses API docs to learn more about supported content types"},"reasoning":{"properties":{"effort":{"description":"Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.","enum":["low","medium","high"],"type":"string"},"summary":{"description":"A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.","enum":["auto","concise","detailed"],"type":"string"}},"type":"object"}},"required":["input"],"type":"object"},"type":"array"}},"required":["requests"],"title":"GPT_OSS_120B_Responses_Async","type":"object"}]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/openai/gpt-oss-120b model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/openai/gpt-oss-20b":{"post":{"operationId":"workers-ai-post-run-cf-openai-gpt-oss-20b","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"input":{"anyOf":[{"type":"string"},{"items":{},"type":"array"}],"description":"Responses API Input messages. Refer to OpenAI Responses API docs to learn more about supported content types"},"reasoning":{"properties":{"effort":{"description":"Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.","enum":["low","medium","high"],"type":"string"},"summary":{"description":"A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.","enum":["auto","concise","detailed"],"type":"string"}},"type":"object"}},"required":["input"],"title":"GPT_OSS_20B_Responses","type":"object"},{"properties":{"requests":{"items":{"properties":{"input":{"anyOf":[{"type":"string"},{"items":{},"type":"array"}],"description":"Responses API Input messages. Refer to OpenAI Responses API docs to learn more about supported content types"},"reasoning":{"properties":{"effort":{"description":"Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.","enum":["low","medium","high"],"type":"string"},"summary":{"description":"A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.","enum":["auto","concise","detailed"],"type":"string"}},"type":"object"}},"required":["input"],"type":"object"},"type":"array"}},"required":["requests"],"title":"GPT_OSS_20B_Responses_Async","type":"object"}]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/openai/gpt-oss-20b model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/openai/whisper":{"post":{"operationId":"workers-ai-post-run-cf-openai-whisper","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/openai/whisper model.","tags":["Workers AI Automatic Speech Recognition"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/openai/whisper-large-v3-turbo":{"post":{"operationId":"workers-ai-post-run-cf-openai-whisper-large-v3-turbo","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"audio":{"description":"Base64 encoded value of the audio data.","type":"string"},"initial_prompt":{"description":"A text prompt to help provide context to the model on the contents of the audio.","type":"string"},"language":{"description":"The language of the audio being transcribed or translated.","type":"string"},"prefix":{"description":"The prefix it appended the the beginning of the output of the transcription and can guide the transcription result.","type":"string"},"task":{"default":"transcribe","description":"Supported tasks are 'translate' or 'transcribe'.","type":"string"},"vad_filter":{"default":false,"description":"Preprocess the audio with a voice activity detection model.","type":"boolean"}},"required":["audio"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/openai/whisper-large-v3-turbo model.","tags":["Workers AI Automatic Speech Recognition"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/openai/whisper-tiny-en":{"post":{"operationId":"workers-ai-post-run-cf-openai-whisper-tiny-en","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/openai/whisper-tiny-en model.","tags":["Workers AI Automatic Speech Recognition"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/openchat/openchat-3.5-0106":{"post":{"operationId":"workers-ai-post-run-cf-openchat-openchat-3-5-0106","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/openchat/openchat-3.5-0106 model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/pfnet/plamo-embedding-1b":{"post":{"operationId":"workers-ai-post-run-cf-pfnet-plamo-embedding-1b","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"text":{"description":"Input text to embed. Can be a single string or a list of strings.","oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]}},"required":["text"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/pfnet/plamo-embedding-1b model.","tags":["Workers AI Text Embeddings"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/pipecat-ai/smart-turn-v2":{"get":{"operationId":"workers-ai-post-websocket-run-cf-pipecat-ai-smart-turn-v2","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}}],"responses":{"101":{"description":"Returns a websocket connection"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Open Websocket connection with @cf/pipecat-ai/smart-turn-v2 model.","tags":["Workers AI Dumb Pipe"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/pipecat-ai/smart-turn-v3":{"get":{"operationId":"workers-ai-post-websocket-run-cf-pipecat-ai-smart-turn-v3","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}}],"responses":{"101":{"description":"Returns a websocket connection"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Open Websocket connection with @cf/pipecat-ai/smart-turn-v3 model.","tags":["Workers AI Dumb Pipe"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-0.5b-chat":{"post":{"operationId":"workers-ai-post-run-cf-qwen-qwen1-5-0-5b-chat","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/qwen/qwen1.5-0.5b-chat model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-1.8b-chat":{"post":{"operationId":"workers-ai-post-run-cf-qwen-qwen1-5-1-8b-chat","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/qwen/qwen1.5-1.8b-chat model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-14b-chat-awq":{"post":{"operationId":"workers-ai-post-run-cf-qwen-qwen1-5-14b-chat-awq","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/qwen/qwen1.5-14b-chat-awq model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/qwen/qwen1.5-7b-chat-awq":{"post":{"operationId":"workers-ai-post-run-cf-qwen-qwen1-5-7b-chat-awq","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/qwen/qwen1.5-7b-chat-awq model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/qwen/qwen2.5-coder-32b-instruct":{"post":{"operationId":"workers-ai-post-run-cf-qwen-qwen2-5-coder-32b-instruct","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["prompt"],"title":"Qwen2_5_Coder_32B_Instruct_Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["messages"],"title":"Qwen2_5_Coder_32B_Instruct_Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/qwen/qwen2.5-coder-32b-instruct model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/qwen/qwen3-30b-a3b-fp8":{"post":{"operationId":"workers-ai-post-run-cf-qwen-qwen3-30b-a3b-fp8","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":2000,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":2000,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"},{"properties":{"requests":{"items":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"},"type":"array"}},"required":["requests"],"title":"Async Batch","type":"object"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/qwen/qwen3-30b-a3b-fp8 model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/qwen/qwen3-embedding-0.6b":{"post":{"operationId":"workers-ai-post-run-cf-qwen-qwen3-embedding-0-6b","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"documents":{"oneOf":[{"description":"A single document string","minLength":1,"type":"string"},{"description":"An array of document strings","items":{"minLength":1,"type":"string"},"maxItems":32,"type":"array"}]},"instruction":{"default":"Given a web search query, retrieve relevant passages that answer the query","description":"Optional instruction for the task","type":"string"},"queries":{"oneOf":[{"description":"A single query string","minLength":1,"type":"string"},{"description":"An array of query strings","items":{"minLength":1,"type":"string"},"maxItems":32,"type":"array"}]},"text":{"oneOf":[{"description":"Alias for documents: a single text string","minLength":1,"type":"string"},{"description":"Alias for documents: an array of text strings","items":{"minLength":1,"type":"string"},"maxItems":32,"type":"array"}]}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/qwen/qwen3-embedding-0.6b model.","tags":["Workers AI Text Embeddings"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/qwen/qwq-32b":{"post":{"operationId":"workers-ai-post-run-cf-qwen-qwq-32b","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"guided_json":{"description":"JSON schema that should be fulfilled for the response.","type":"object"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.15,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["prompt"],"title":"Qwen_Qwq_32B_Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":0,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"guided_json":{"description":"JSON schema that should be fufilled for the response.","type":"object"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"oneOf":[{"description":"The content of the message as a string.","type":"string"},{"items":{"properties":{"image_url":{"properties":{"url":{"description":"image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted","pattern":"^data:*","type":"string"}},"type":"object"},"text":{"type":"string"},"type":{"description":"Type of the content provided","type":"string"}},"type":"object"},"type":"array"},{"properties":{"image_url":{"properties":{"url":{"description":"image uri with data (e.g. data:image/jpeg;base64,/9j/...). HTTP URL will not be accepted","pattern":"^data:*","type":"string"}},"type":"object"},"text":{"type":"string"},"type":{"description":"Type of the content provided","type":"string"}},"type":"object"}]},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"},"tool_call_id":{"description":"The tool call id. Must be supplied for tool calls for Mistral-3. If you don't know what to put here you can fall back to 000000001","pattern":"[a-zA-Z0-9]{9}","type":"string"}},"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":0,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.15,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":2,"minimum":0,"type":"number"}},"required":["messages"],"title":"Qwen_Qwq_32B_Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/qwen/qwq-32b model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/runwayml/stable-diffusion-v1-5-img2img":{"post":{"operationId":"workers-ai-post-run-cf-runwayml-stable-diffusion-v1-5-img2img","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"guidance":{"default":7.5,"description":"Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt","type":"number"},"height":{"description":"The height of the generated image in pixels","maximum":2048,"minimum":256,"type":"integer"},"image":{"description":"For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},"image_b64":{"description":"For use with img2img tasks. A base64-encoded string of the input image","type":"string"},"mask":{"description":"An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},"negative_prompt":{"description":"Text describing elements to avoid in the generated image","type":"string"},"num_steps":{"default":20,"description":"The number of diffusion steps; higher values can improve quality but take longer","maximum":20,"type":"integer"},"prompt":{"description":"A text description of the image you want to generate","minLength":1,"type":"string"},"seed":{"description":"Random seed for reproducibility of the image generation","type":"integer"},"strength":{"default":1,"description":"A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image","type":"number"},"width":{"description":"The width of the generated image in pixels","maximum":2048,"minimum":256,"type":"integer"}},"required":["prompt"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/runwayml/stable-diffusion-v1-5-img2img model.","tags":["Workers AI Text To Image"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/runwayml/stable-diffusion-v1-5-inpainting":{"post":{"operationId":"workers-ai-post-run-cf-runwayml-stable-diffusion-v1-5-inpainting","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"guidance":{"default":7.5,"description":"Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt","type":"number"},"height":{"description":"The height of the generated image in pixels","maximum":2048,"minimum":256,"type":"integer"},"image":{"description":"For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},"image_b64":{"description":"For use with img2img tasks. A base64-encoded string of the input image","type":"string"},"mask":{"description":"An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},"negative_prompt":{"description":"Text describing elements to avoid in the generated image","type":"string"},"num_steps":{"default":20,"description":"The number of diffusion steps; higher values can improve quality but take longer","maximum":20,"type":"integer"},"prompt":{"description":"A text description of the image you want to generate","minLength":1,"type":"string"},"seed":{"description":"Random seed for reproducibility of the image generation","type":"integer"},"strength":{"default":1,"description":"A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image","type":"number"},"width":{"description":"The width of the generated image in pixels","maximum":2048,"minimum":256,"type":"integer"}},"required":["prompt"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/runwayml/stable-diffusion-v1-5-inpainting model.","tags":["Workers AI Text To Image"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/stabilityai/stable-diffusion-xl-base-1.0":{"post":{"operationId":"workers-ai-post-run-cf-stabilityai-stable-diffusion-xl-base-1-0","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"guidance":{"default":7.5,"description":"Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt","type":"number"},"height":{"description":"The height of the generated image in pixels","maximum":2048,"minimum":256,"type":"integer"},"image":{"description":"For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},"image_b64":{"description":"For use with img2img tasks. A base64-encoded string of the input image","type":"string"},"mask":{"description":"An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},"negative_prompt":{"description":"Text describing elements to avoid in the generated image","type":"string"},"num_steps":{"default":20,"description":"The number of diffusion steps; higher values can improve quality but take longer","maximum":20,"type":"integer"},"prompt":{"description":"A text description of the image you want to generate","minLength":1,"type":"string"},"seed":{"description":"Random seed for reproducibility of the image generation","type":"integer"},"strength":{"default":1,"description":"A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image","type":"number"},"width":{"description":"The width of the generated image in pixels","maximum":2048,"minimum":256,"type":"integer"}},"required":["prompt"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/stabilityai/stable-diffusion-xl-base-1.0 model.","tags":["Workers AI Text To Image"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/sven/test-pipe-http":{"get":{"operationId":"workers-ai-post-websocket-run-cf-sven-test-pipe-http","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}}],"responses":{"101":{"description":"Returns a websocket connection"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Open Websocket connection with @cf/sven/test-pipe-http model.","tags":["Workers AI Text To Image"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/thebloke/discolm-german-7b-v1-awq":{"post":{"operationId":"workers-ai-post-run-cf-thebloke-discolm-german-7b-v1-awq","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/thebloke/discolm-german-7b-v1-awq model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/tiiuae/falcon-7b-instruct":{"post":{"operationId":"workers-ai-post-run-cf-tiiuae-falcon-7b-instruct","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/tiiuae/falcon-7b-instruct model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@cf/tinyllama/tinyllama-1.1b-chat-v1.0":{"post":{"operationId":"workers-ai-post-run-cf-tinyllama-tinyllama-1-1b-chat-v1-0","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @cf/tinyllama/tinyllama-1.1b-chat-v1.0 model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@hf/google/gemma-7b-it":{"post":{"operationId":"workers-ai-post-run-hf-google-gemma-7b-it","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @hf/google/gemma-7b-it model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@hf/mistral/mistral-7b-instruct-v0.2":{"post":{"operationId":"workers-ai-post-run-hf-mistral-mistral-7b-instruct-v0-2","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @hf/mistral/mistral-7b-instruct-v0.2 model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@hf/nexusflow/starling-lm-7b-beta":{"post":{"operationId":"workers-ai-post-run-hf-nexusflow-starling-lm-7b-beta","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @hf/nexusflow/starling-lm-7b-beta model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@hf/nousresearch/hermes-2-pro-mistral-7b":{"post":{"operationId":"workers-ai-post-run-hf-nousresearch-hermes-2-pro-mistral-7b","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @hf/nousresearch/hermes-2-pro-mistral-7b model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@hf/thebloke/deepseek-coder-6.7b-base-awq":{"post":{"operationId":"workers-ai-post-run-hf-thebloke-deepseek-coder-6-7b-base-awq","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @hf/thebloke/deepseek-coder-6.7b-base-awq model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@hf/thebloke/deepseek-coder-6.7b-instruct-awq":{"post":{"operationId":"workers-ai-post-run-hf-thebloke-deepseek-coder-6-7b-instruct-awq","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @hf/thebloke/deepseek-coder-6.7b-instruct-awq model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@hf/thebloke/llama-2-13b-chat-awq":{"post":{"operationId":"workers-ai-post-run-hf-thebloke-llama-2-13b-chat-awq","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @hf/thebloke/llama-2-13b-chat-awq model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@hf/thebloke/llamaguard-7b-awq":{"post":{"operationId":"workers-ai-post-run-hf-thebloke-llamaguard-7b-awq","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @hf/thebloke/llamaguard-7b-awq model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@hf/thebloke/mistral-7b-instruct-v0.1-awq":{"post":{"operationId":"workers-ai-post-run-hf-thebloke-mistral-7b-instruct-v0-1-awq","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @hf/thebloke/mistral-7b-instruct-v0.1-awq model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@hf/thebloke/neural-chat-7b-v3-1-awq":{"post":{"operationId":"workers-ai-post-run-hf-thebloke-neural-chat-7b-v3-1-awq","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @hf/thebloke/neural-chat-7b-v3-1-awq model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@hf/thebloke/openhermes-2.5-mistral-7b-awq":{"post":{"operationId":"workers-ai-post-run-hf-thebloke-openhermes-2-5-mistral-7b-awq","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @hf/thebloke/openhermes-2.5-mistral-7b-awq model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/@hf/thebloke/zephyr-7b-beta-awq":{"post":{"operationId":"workers-ai-post-run-hf-thebloke-zephyr-7b-beta-awq","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string","x-auditable":true}},{"in":"query","name":"queueRequest","schema":{"example":"true","type":"string","x-auditable":true}},{"in":"query","name":"tags","schema":{"example":"tag1,tag2,tag3","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/event-stream":{"schema":{"type":"object"}}},"description":"Object with user data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["errors","success","result"],"type":"object"}}},"description":"Bad request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute @hf/thebloke/zephyr-7b-beta-awq model.","tags":["Workers AI Text Generation"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/run/{model_name}":{"post":{"description":"This endpoint provides users with the capability to run specific AI models on-demand.\n\nBy submitting the required input data, users can receive real-time predictions or results generated by the chosen AI\nmodel. The endpoint supports various AI model types, ensuring flexibility and adaptability for diverse use cases.\n\nModel specific inputs available in [Cloudflare Docs](https://developers.cloudflare.com/workers-ai/models/).","operationId":"workers-ai-post-run-model","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string"}},{"in":"path","name":"model_name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"text":{"description":"The text that you want to classify","minLength":1,"type":"string"}},"required":["text"],"title":"Text Classification","type":"object"},{"properties":{"guidance":{"default":7.5,"description":"Controls how closely the generated image should adhere to the prompt; higher values make the image more aligned with the prompt","type":"number"},"height":{"description":"The height of the generated image in pixels","maximum":2048,"minimum":256,"type":"integer"},"image":{"description":"For use with img2img tasks. An array of integers that represent the image data constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},"image_b64":{"description":"For use with img2img tasks. A base64-encoded string of the input image","type":"string"},"mask":{"description":"An array representing An array of integers that represent mask image data for inpainting constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},"negative_prompt":{"description":"Text describing elements to avoid in the generated image","type":"string"},"num_steps":{"default":20,"description":"The number of diffusion steps; higher values can improve quality but take longer","maximum":20,"type":"integer"},"prompt":{"description":"A text description of the image you want to generate","minLength":1,"type":"string"},"seed":{"description":"Random seed for reproducibility of the image generation","type":"integer"},"strength":{"default":1,"description":"A value between 0 and 1 indicating how strongly to apply the transformation during img2img tasks; lower values make the output closer to the input image","type":"number"},"width":{"description":"The width of the generated image in pixels","maximum":2048,"minimum":256,"type":"integer"}},"required":["prompt"],"title":"Text To Image","type":"object"},{"properties":{"lang":{"default":"en","description":"The speech language (e.g., 'en' for English, 'fr' for French). Defaults to 'en' if not specified","type":"string"},"prompt":{"description":"A text description of the audio you want to generate","minLength":1,"type":"string"}},"required":["prompt"],"title":"Text To Speech","type":"object"},{"properties":{"text":{"oneOf":[{"description":"The text to embed","minLength":1,"type":"string"},{"description":"Batch of text values to embed","items":{"description":"The text to embed","minLength":1,"type":"string"},"maxItems":100,"type":"array"}]}},"required":["text"],"title":"Text Embeddings","type":"object"},{"oneOf":[{"format":"binary","type":"string"},{"properties":{"audio":{"description":"An array of integers that represent the audio data constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},"source_lang":{"description":"The language of the recorded audio","type":"string"},"target_lang":{"description":"The language to translate the transcription into. Currently only English is supported.","type":"string"}},"required":["audio"],"type":"object"}],"title":"Automatic Speech Recognition","type":"object"},{"oneOf":[{"description":"The image to classify","format":"binary","type":"string"},{"properties":{"image":{"description":"An array of integers that represent the image data constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255 (unsigned 8bit)","type":"number"},"type":"array"}},"required":["image"],"type":"object"}],"title":"Image Classification","type":"object"},{"oneOf":[{"description":"The image to use for detection","format":"binary","type":"string"},{"properties":{"image":{"description":"An array of integers that represent the image data constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255 (unsigned 8bit)","type":"number"},"type":"array"}},"type":"object"}],"title":"Object Detection","type":"object"},{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"lora":{"description":"Name of the LoRA (Low-Rank Adaptation) model to fine-tune the base model.","type":"string"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["prompt"],"title":"Prompt"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","maximum":2,"minimum":-2,"type":"number"},"functions":{"items":{"properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["name","code"],"type":"object"},"type":"array"},"max_tokens":{"default":256,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","maximum":2,"minimum":-2,"type":"number"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","maximum":2,"minimum":0,"type":"number"},"response_format":{"properties":{"json_schema":{},"type":{"enum":["json_object","json_schema"],"type":"string"}},"title":"JSON Mode","type":"object"},"seed":{"description":"Random seed for reproducibility of the generation.","maximum":9999999999,"minimum":1,"type":"integer"},"stream":{"default":false,"description":"If true, the response will be streamed back incrementally using SSE, Server Sent Events.","type":"boolean"},"temperature":{"default":0.6,"description":"Controls the randomness of the output; higher values produce more random results.","maximum":5,"minimum":0,"type":"number"},"tools":{"description":"A list of tools available for the assistant to use.","items":{"oneOf":[{"properties":{"description":{"description":"A brief description of what the tool does.","type":"string"},"name":{"description":"The name of the tool. More descriptive the better.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the tool.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"]},{"properties":{"function":{"description":"Details of the function tool.","properties":{"description":{"description":"A brief description of what the function does.","type":"string"},"name":{"description":"The name of the function.","type":"string"},"parameters":{"description":"Schema defining the parameters accepted by the function.","properties":{"properties":{"additionalProperties":{"properties":{"description":{"description":"A description of the expected parameter.","type":"string"},"type":{"description":"The data type of the parameter.","type":"string"}},"required":["type","description"],"type":"object"},"description":"Definitions of each parameter.","type":"object"},"required":{"description":"List of required parameter names.","items":{"type":"string"},"type":"array"},"type":{"description":"The type of the parameters object (usually 'object').","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["name","description","parameters"],"type":"object"},"type":{"description":"Specifies the type of tool (e.g., 'function').","type":"string"}},"required":["type","function"]}],"type":"object"},"type":"array"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","maximum":50,"minimum":1,"type":"integer"},"top_p":{"description":"Adjusts the creativity of the AI's responses by controlling how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","maximum":1,"minimum":0.001,"type":"number"}},"required":["messages"],"title":"Messages"}],"title":"Text Generation","type":"object"},{"properties":{"source_lang":{"default":"en","description":"The language code of the source text (e.g., 'en' for English). Defaults to 'en' if not specified","type":"string"},"target_lang":{"description":"The language code to translate the text into (e.g., 'es' for Spanish)","type":"string"},"text":{"description":"The text to be translated","minLength":1,"type":"string"}},"required":["text","target_lang"],"title":"Translation","type":"object"},{"properties":{"input_text":{"description":"The text that you want the model to summarize","minLength":1,"type":"string"},"max_length":{"default":1024,"description":"The maximum length of the generated summary in tokens","type":"integer"}},"required":["input_text"],"title":"Summarization","type":"object"},{"oneOf":[{"description":"Binary string representing the image contents.","format":"binary","type":"string"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","type":"number"},"image":{"oneOf":[{"description":"An array of integers that represent the image data constrained to 8-bit unsigned integer values","items":{"description":"A value between 0 and 255","type":"number"},"type":"array"},{"description":"Binary string representing the image contents.","format":"binary","type":"string"}]},"max_tokens":{"default":512,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","type":"string"},"raw":{"default":false,"description":"If true, a chat template is not applied and you must adhere to the specific model's expected formatting.","type":"boolean"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","type":"number"},"seed":{"description":"Random seed for reproducibility of the generation.","type":"number"},"temperature":{"description":"Controls the randomness of the output; higher values produce more random results.","type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","type":"number"},"top_p":{"description":"Controls the creativity of the AI's responses by adjusting how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","type":"number"}},"required":["image"],"type":"object"}],"title":"Image To Text","type":"object"},{"oneOf":[{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","type":"number"},"ignore_eos":{"description":"Whether to ignore the EOS token and continue generating tokens after the EOS token is generated.","type":"boolean"},"image":{"description":"Image in base64 encoded format.","type":"string"},"max_tokens":{"default":512,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","type":"number"},"prompt":{"description":"The input text prompt for the model to generate a response.","minLength":1,"type":"string"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","type":"number"},"seed":{"description":"Random seed for reproducibility of the generation.","type":"number"},"temperature":{"description":"Controls the randomness of the output; higher values produce more random results.","type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","type":"number"},"top_p":{"description":"Controls the creativity of the AI's responses by adjusting how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","type":"number"}},"required":["prompt","image"],"type":"object"},{"properties":{"frequency_penalty":{"description":"Decreases the likelihood of the model repeating the same lines verbatim.","type":"number"},"ignore_eos":{"description":"Whether to ignore the EOS token and continue generating tokens after the EOS token is generated.","type":"boolean"},"image":{"description":"Image in base64 encoded format.","type":"string"},"max_tokens":{"default":512,"description":"The maximum number of tokens to generate in the response.","type":"integer"},"messages":{"description":"An array of message objects representing the conversation history.","items":{"properties":{"content":{"description":"The content of the message as a string.","type":"string"},"role":{"description":"The role of the message sender (e.g., 'user', 'assistant', 'system', 'tool').","type":"string"}},"required":["role","content"],"type":"object"},"type":"array"},"presence_penalty":{"description":"Increases the likelihood of the model introducing new topics.","type":"number"},"repetition_penalty":{"description":"Penalty for repeated tokens; higher values discourage repetition.","type":"number"},"seed":{"description":"Random seed for reproducibility of the generation.","type":"number"},"temperature":{"description":"Controls the randomness of the output; higher values produce more random results.","type":"number"},"top_k":{"description":"Limits the AI to choose from the top 'k' most probable words. Lower values make responses more focused; higher values introduce more variety and potential surprises.","type":"number"},"top_p":{"description":"Controls the creativity of the AI's responses by adjusting how many possible words it considers. Lower values make outputs more predictable; higher values allow for more varied and creative responses.","type":"number"}},"required":["messages","image"],"type":"object"}],"title":"Image Text To Text","type":"object"},{"properties":{"image":{"description":"Image in base64 encoded format.","minLength":1,"type":"string"},"text":{"items":{"minLength":1,"type":"string"},"type":"array"}},"title":"Multimodal Embeddings","type":"object"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"oneOf":[{"description":"An array of classification results for the input text","items":{"properties":{"label":{"description":"The classification label assigned to the text (e.g., 'POSITIVE' or 'NEGATIVE')","type":"string"},"score":{"description":"Confidence score indicating the likelihood that the text belongs to the specified label","type":"number"}},"type":"object"},"title":"Text Classification","type":"array"},{"description":"The generated image in PNG format","format":"binary","title":"Text To Image","type":"string"},{"oneOf":[{"properties":{"audio":{"description":"The generated audio in MP3 format, base64-encoded","type":"string"}},"type":"object"},{"description":"The generated audio in MP3 format","format":"binary","type":"string"}],"title":"Text To Speech","type":"object"},{"properties":{"data":{"description":"Embeddings of the requested text values","items":{"description":"Floating point embedding representation shaped by the embedding model","items":{"type":"number"},"type":"array"},"type":"array"},"shape":{"items":{"type":"number"},"type":"array"}},"title":"Text Embeddings","type":"object"},{"properties":{"text":{"description":"The transcription","type":"string"},"vtt":{"type":"string"},"word_count":{"type":"number"},"words":{"items":{"properties":{"end":{"description":"The ending second when the word completes","type":"number"},"start":{"description":"The second this word begins in the recording","type":"number"},"word":{"type":"string"}},"type":"object"},"type":"array"}},"required":["text"],"title":"Automatic Speech Recognition","type":"object"},{"items":{"properties":{"label":{"description":"The predicted category or class for the input image based on analysis","type":"string"},"score":{"description":"A confidence value, between 0 and 1, indicating how certain the model is about the predicted label","type":"number"}},"type":"object"},"title":"Image Classification","type":"array"},{"description":"An array of detected objects within the input image","items":{"properties":{"box":{"description":"Coordinates defining the bounding box around the detected object","properties":{"xmax":{"description":"The x-coordinate of the bottom-right corner of the bounding box","type":"number"},"xmin":{"description":"The x-coordinate of the top-left corner of the bounding box","type":"number"},"ymax":{"description":"The y-coordinate of the bottom-right corner of the bounding box","type":"number"},"ymin":{"description":"The y-coordinate of the top-left corner of the bounding box","type":"number"}},"type":"object"},"label":{"description":"The class label or name of the detected object","type":"string"},"score":{"description":"Confidence score indicating the likelihood that the detection is correct","type":"number"}},"type":"object"},"title":"Object Detection","type":"array"},{"oneOf":[{"properties":{"response":{"description":"The generated text response from the model","type":"string"},"tool_calls":{"description":"An array of tool calls requests made during the response generation","items":{"properties":{"arguments":{"description":"The arguments passed to be passed to the tool call request","type":"object"},"name":{"description":"The name of the tool to be called","type":"string"}},"type":"object"},"type":"array"},"usage":{"description":"Usage statistics for the inference request","properties":{"completion_tokens":{"default":0,"description":"Total number of tokens in output","type":"number"},"prompt_tokens":{"default":0,"description":"Total number of tokens in input","type":"number"},"total_tokens":{"default":0,"description":"Total number of input and output tokens","type":"number"}},"type":"object"}},"required":["response"],"type":"object"},{"format":"binary","type":"string"}],"title":"Text Generation","type":"object"},{"properties":{"translated_text":{"description":"The translated text in the target language","type":"string"}},"title":"Translation","type":"object"},{"properties":{"summary":{"description":"The summarized version of the input text","type":"string"}},"title":"Summarization","type":"object"},{"properties":{"description":{"type":"string"}},"title":"Image To Text","type":"object"},{"properties":{"description":{"type":"string"}},"title":"Image Text To Text","type":"object"},{"properties":{"data":{"items":{"items":{"type":"number"},"type":"array"},"type":"array"},"shape":{"items":{"type":"number"},"type":"array"}},"title":"Multimodal Embeddings","type":"object"}],"type":"object"}},"type":"object"}}},"description":"Model response"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Execute AI model","tags":["Workers AI"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/tasks/search":{"get":{"operationId":"workers-ai-search-task","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"items":{"type":"object"},"type":"array"},"success":{"type":"boolean","x-auditable":true}},"required":["success","result","errors","messages"],"type":"object"}}},"description":"Returns a list of tasks"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Object not found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Task Search","tags":["Workers AI"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/tomarkdown":{"post":{"operationId":"workers-ai-post-to-markdown","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"data":{"type":"string","x-auditable":true},"format":{"type":"string","x-auditable":true},"mimeType":{"type":"string","x-auditable":true},"name":{"type":"string","x-auditable":true},"tokens":{"type":"string","x-auditable":true}},"required":["name","mimeType","format","tokens","data"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Model Schema"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Convert Files into Markdown","tags":["Workers AI"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/ai/tomarkdown/supported":{"get":{"operationId":"workers-ai-get-to-markdown-supported","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"extension":{"type":"string","x-auditable":true},"mimeType":{"type":"string","x-auditable":true}},"required":["extension","mimeType"],"type":"object"},"type":"array"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get all converted formats supported","tags":["Workers AI"],"x-api-token-group":["Workers AI Write","Workers AI Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.ai"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/alerting/v3/available_alerts":{"get":{"description":"Gets a list of all alert types for which an account is eligible.","operationId":"notification-alert-types-get-alert-types","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_alerts-response_collection"}}},"description":"Get Alert Types response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Get Alert Types response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Alert Types","tags":["Notification Alert Types"],"x-api-token-group":["Zero Trust: PII Read","Notifications Write","Notifications Read","Account Settings Write","Account Settings Read"]}},"/accounts/{account_id}/alerting/v3/destinations/eligible":{"get":{"description":"Get a list of all delivery mechanism types for which an account is eligible.","operationId":"notification-mechanism-eligibility-get-delivery-mechanism-eligibility","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_schemas-response_collection"}}},"description":"Get delivery mechanism eligibility response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Get delivery mechanism eligibility response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get delivery mechanism eligibility","tags":["Notification Mechanism Eligibility"]}},"/accounts/{account_id}/alerting/v3/destinations/pagerduty":{"delete":{"description":"Deletes all the PagerDuty Services connected to the account.","operationId":"notification-destinations-with-pager-duty-delete-pager-duty-services","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_schemas-api-response-common"}}},"description":"Delete PagerDuty Services response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Delete PagerDuty Services response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete PagerDuty Services","tags":["Notification destinations with PagerDuty"],"x-api-token-group":["Notifications Write","Account Settings Write"]},"get":{"description":"Get a list of all configured PagerDuty services.","operationId":"notification-destinations-with-pager-duty-list-pager-duty-services","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_components-schemas-response_collection"}}},"description":"List PagerDuty services response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"List PagerDuty services response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List PagerDuty services","tags":["Notification destinations with PagerDuty"],"x-api-token-group":["Zero Trust: PII Read","Notifications Write","Notifications Read","Account Settings Write","Account Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/alerting/v3/destinations/pagerduty/connect":{"post":{"description":"Creates a new token for integrating with PagerDuty.","operationId":"notification-destinations-with-pager-duty-connect-pager-duty","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_sensitive_id_response"}}},"description":"Token for PagerDuty integration"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_id_response"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Create a token for PagerDuty integration failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create PagerDuty integration token","tags":["Notification destinations with PagerDuty"],"x-api-token-group":["Notifications Write","Account Settings Write"]}},"/accounts/{account_id}/alerting/v3/destinations/pagerduty/connect/{token_id}":{"get":{"description":"Links PagerDuty with the account using the integration token.","operationId":"notification-destinations-with-pager-duty-connect-pager-duty-token","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}},{"in":"path","name":"token_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_integration-token"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_id_response"}}},"description":"Create a Notification policy response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_id_response"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Create a Notification policy response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Connect PagerDuty","tags":["Notification destinations with PagerDuty"],"x-api-token-group":["Notifications Write","Account Settings Write"]}},"/accounts/{account_id}/alerting/v3/destinations/webhooks":{"get":{"description":"Gets a list of all configured webhook destinations.","operationId":"notification-webhooks-list-webhooks","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_webhooks_components-schemas-response_collection"}}},"description":"List webhooks response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_webhooks_components-schemas-response_collection"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"List webhooks response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List webhooks","tags":["Notification webhooks"],"x-api-token-group":["Zero Trust: PII Read","Notifications Write","Notifications Read","Account Settings Write","Account Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"post":{"description":"Creates a new webhook destination.","operationId":"notification-webhooks-create-a-webhook","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/aaa_components-schemas-name"},"secret":{"$ref":"#/components/schemas/aaa_secret"},"url":{"$ref":"#/components/schemas/aaa_url"}},"required":["name","url"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_id_response"}}},"description":"Create a webhook response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_id_response"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Create a webhook response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a webhook","tags":["Notification webhooks"],"x-api-token-group":["Notifications Write","Account Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}":{"delete":{"description":"Delete a configured webhook destination.","operationId":"notification-webhooks-delete-a-webhook","parameters":[{"in":"path","name":"webhook_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_webhook-id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_schemas-api-response-common"}}},"description":"Delete a webhook response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Delete a webhook response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a webhook","tags":["Notification webhooks"],"x-api-token-group":["Notifications Write","Account Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Get details for a single webhooks destination.","operationId":"notification-webhooks-get-a-webhook","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}},{"in":"path","name":"webhook_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_webhook-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_schemas-single_response"}}},"description":"Get a webhook response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_schemas-single_response"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Get a webhook response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get a webhook","tags":["Notification webhooks"],"x-api-token-group":["Zero Trust: PII Read","Notifications Write","Notifications Read","Account Settings Write","Account Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Update a webhook destination.","operationId":"notification-webhooks-update-a-webhook","parameters":[{"in":"path","name":"webhook_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_webhook-id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/aaa_components-schemas-name"},"secret":{"$ref":"#/components/schemas/aaa_secret"},"url":{"$ref":"#/components/schemas/aaa_url"}},"required":["name","url"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_id_response"}}},"description":"Update a webhook response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_id_response"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Update a webhook response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update a webhook","tags":["Notification webhooks"],"x-api-token-group":["Notifications Write","Account Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/alerting/v3/history":{"get":{"description":"Gets a list of history records for notifications sent to an account. The records are displayed for last `x` number of days based on the zone plan (free = 30, pro = 30, biz = 30, ent = 90).","operationId":"notification-history-list-history","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/aaa_per_page"}},{"in":"query","name":"before","schema":{"$ref":"#/components/schemas/aaa_before"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"since","schema":{"description":"Limit the returned results to history records newer than the specified date. This must be a timestamp that conforms to RFC3339.","example":"2022-05-19T20:29:58.679897Z","format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_history_components-schemas-response_collection"}}},"description":"List History response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_history_components-schemas-response_collection"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"List History response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List History","tags":["Notification History"],"x-api-token-group":["Zero Trust: PII Read","Notifications Write","Notifications Read","Account Settings Write","Account Settings Read"]}},"/accounts/{account_id}/alerting/v3/policies":{"get":{"description":"Get a list of all Notification policies.","operationId":"notification-policies-list-notification-policies","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_policies_components-schemas-response_collection"}}},"description":"List Notification policies response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"List Notification policies response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Notification policies","tags":["Notification policies"],"x-api-token-group":["Zero Trust: PII Read","Notifications Write","Notifications Read","Account Settings Write","Account Settings Read"]},"post":{"description":"Creates a new Notification policy.","operationId":"notification-policies-create-a-notification-policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"alert_interval":{"$ref":"#/components/schemas/aaa_alert_interval"},"alert_type":{"$ref":"#/components/schemas/aaa_alert_type"},"description":{"$ref":"#/components/schemas/aaa_schemas-description"},"enabled":{"$ref":"#/components/schemas/aaa_enabled"},"filters":{"$ref":"#/components/schemas/aaa_filters"},"mechanisms":{"$ref":"#/components/schemas/aaa_mechanisms"},"name":{"$ref":"#/components/schemas/aaa_schemas-name"}},"required":["name","alert_type","enabled","mechanisms"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_id_response"}}},"description":"Create a Notification policy response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_id_response"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Create a Notification policy response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a Notification policy","tags":["Notification policies"],"x-api-token-group":["Notifications Write","Account Settings Write"]}},"/accounts/{account_id}/alerting/v3/policies/{policy_id}":{"delete":{"description":"Delete a Notification policy.","operationId":"notification-policies-delete-a-notification-policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}},{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_policy-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_api-response-collection"}}},"description":"Delete a Notification policy response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_api-response-collection"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Delete a Notification policy response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a Notification policy","tags":["Notification policies"],"x-api-token-group":["Notifications Write","Account Settings Write"]},"get":{"description":"Get details for a single policy.","operationId":"notification-policies-get-a-notification-policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}},{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_policy-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_single_response"}}},"description":"Get a Notification policy response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_single_response"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Get a Notification policy response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get a Notification policy","tags":["Notification policies"],"x-api-token-group":["Zero Trust: PII Read","Notifications Write","Notifications Read","Account Settings Write","Account Settings Read"]},"put":{"description":"Update a Notification policy.","operationId":"notification-policies-update-a-notification-policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}},{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_policy-id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"alert_interval":{"$ref":"#/components/schemas/aaa_alert_interval"},"alert_type":{"$ref":"#/components/schemas/aaa_alert_type"},"description":{"$ref":"#/components/schemas/aaa_schemas-description"},"enabled":{"$ref":"#/components/schemas/aaa_enabled"},"filters":{"$ref":"#/components/schemas/aaa_filters"},"mechanisms":{"$ref":"#/components/schemas/aaa_mechanisms"},"name":{"$ref":"#/components/schemas/aaa_schemas-name"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_id_response"}}},"description":"Update a Notification policy response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_id_response"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Update a Notification policy response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update a Notification policy","tags":["Notification policies"],"x-api-token-group":["Notifications Write","Account Settings Write"]}},"/accounts/{account_id}/alerting/v3/silences":{"get":{"description":"Gets a list of silences for an account.","operationId":"notification-silences-list-silences","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_silences_components-schemas-response_collection"}}},"description":"List Silences response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_silences_components-schemas-response_collection"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"List Silences response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Silences","tags":["Notification Silences"],"x-api-token-group":["Zero Trust: PII Read","Notifications Write","Notifications Read","Account Settings Write","Account Settings Read"]},"post":{"description":"Creates a new silence for an account.","operationId":"notification-silences-create-silences","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/aaa_silence_create_request"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_schemas-api-response-common"}}},"description":"Create Silences response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_silences_components-schemas-response_collection"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Create Silences response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Silences","tags":["Notification Silences"],"x-api-token-group":["Notifications Write","Account Settings Write"]},"put":{"description":"Updates existing silences for an account.","operationId":"notification-silences-update-silences","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/aaa_silence_update_request"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_silences_components-schemas-response_collection"}}},"description":"Update Silences response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_silences_components-schemas-response_collection"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Update Silences response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Silences","tags":["Notification Silences"],"x-api-token-group":["Notifications Write","Account Settings Write"]}},"/accounts/{account_id}/alerting/v3/silences/{silence_id}":{"delete":{"description":"Deletes an existing silence for an account.","operationId":"notification-silences-delete-silences","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}},{"in":"path","name":"silence_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_silence-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_schemas-api-response-common"}}},"description":"Delete Silence response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_silence_components-schemas-response_collection"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Delete Silence response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Silence","tags":["Notification Silences"],"x-api-token-group":["Notifications Write","Account Settings Write"]},"get":{"description":"Gets a specific silence for an account.","operationId":"notification-silences-get-silence","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_account-id"}},{"in":"path","name":"silence_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_silence-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_silence_components-schemas-response_collection"}}},"description":"Get Silence response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_silence_components-schemas-response_collection"},{"$ref":"#/components/schemas/aaa_components-schemas-api-response-common-failure"}]}}},"description":"Get Silence response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Silence","tags":["Notification Silences"],"x-api-token-group":["Zero Trust: PII Read","Notifications Write","Notifications Read","Account Settings Write","Account Settings Read"]}},"/accounts/{account_id}/audit_logs":{"get":{"description":"Gets a list of audit logs for an account. Can be filtered by who made the change, on which zone, and the timeframe of the change.","operationId":"audit-logs-get-account-audit-logs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/aaa_identifier"}},{"in":"query","name":"id","schema":{"description":"Finds a specific log by its ID.","example":"f174be97-19b1-40d6-954d-70cd5fbd52db","type":"string"}},{"in":"query","name":"export","schema":{"description":"Indicates that this request is an export of logs in CSV format.","example":true,"type":"boolean"}},{"in":"query","name":"action.type","schema":{"description":"Filters by the action type.","example":"add","type":"string"}},{"in":"query","name":"actor.ip","schema":{"description":"Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.","example":"17.168.228.63","type":"string"}},{"in":"query","name":"actor.email","schema":{"description":"Filters by the email address of the actor that made the change.","example":"alice@example.com","format":"email","type":"string"}},{"in":"query","name":"since","schema":{"oneOf":[{"description":"Limits the returned results to logs newer than the specified date. A `full-date` that conforms to RFC3339.","example":"2019-04-30","format":"date","type":"string"},{"description":"Limits the returned results to logs newer than the specified date. A `date-time` that conforms to RFC3339.","example":"2019-04-30T01:12:20Z","format":"date-time","type":"string"}]}},{"in":"query","name":"before","schema":{"oneOf":[{"description":"Limits the returned results to logs older than the specified date. A `full-date` that conforms to RFC3339.","example":"2019-04-30","format":"date","type":"string"},{"description":"Limits the returned results to logs older than the specified date. A `date-time` that conforms to RFC3339.","example":"2019-04-30T01:12:20Z","format":"date-time","type":"string"}]}},{"in":"query","name":"zone.name","schema":{"description":"Filters by the name of the zone associated to the change.","example":"example.com","type":"string"}},{"in":"query","name":"direction","schema":{"default":"desc","description":"Changes the direction of the chronological sorting.","enum":["desc","asc"],"example":"desc","type":"string"}},{"in":"query","name":"per_page","schema":{"default":100,"description":"Sets the number of results to return per page.","example":25,"maximum":1000,"minimum":1,"type":"number"}},{"in":"query","name":"page","schema":{"default":1,"description":"Defines which page of results to return.","example":50,"minimum":1,"type":"number"}},{"in":"query","name":"hide_user_logs","schema":{"default":false,"description":"Indicates whether or not to hide user level audit logs.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_audit_logs_response_collection"}}},"description":"Get account audit logs response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_audit_logs_response_collection"},{"$ref":"#/components/schemas/aaa_api-response-common-failure"}]}}},"description":"Get account audit logs response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get account audit logs","tags":["Audit Logs"],"x-api-token-group":["Account Settings Write","Account Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/autorag/rags/{id}/ai-search":{"post":{"operationId":"autorag-config-ai-search","parameters":[{"description":"rag id","in":"path","name":"id","required":true,"schema":{"description":"rag id","example":"my-rag","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"example":"c3dc5f0b34a14ff8e1b3ec04895e1b22","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"filters":{"anyOf":[{"properties":{"key":{"type":"string"},"type":{"enum":["eq","ne","gt","gte","lt","lte"],"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","type","value"],"type":"object"},{"properties":{"filters":{"items":{"properties":{"key":{"type":"string"},"type":{"enum":["eq","ne","gt","gte","lt","lte"],"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","type","value"],"type":"object"},"type":"array"},"type":{"enum":["and","or"],"type":"string"}},"required":["type","filters"],"type":"object"}]},"max_num_results":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"model":{"anyOf":[{"enum":["@cf/meta/llama-3.3-70b-instruct-fp8-fast","@cf/meta/llama-3.1-8b-instruct-fast","@cf/meta/llama-3.1-8b-instruct-fp8","@cf/meta/llama-4-scout-17b-16e-instruct","@cf/qwen/qwen3-30b-a3b-fp8","@cf/deepseek-ai/deepseek-r1-distill-qwen-32b","@cf/moonshotai/kimi-k2-instruct","anthropic/claude-3-7-sonnet","anthropic/claude-sonnet-4","anthropic/claude-opus-4","anthropic/claude-3-5-haiku","cerebras/qwen-3-235b-a22b-instruct","cerebras/qwen-3-235b-a22b-thinking","cerebras/llama-3.3-70b","cerebras/llama-4-maverick-17b-128e-instruct","cerebras/llama-4-scout-17b-16e-instruct","cerebras/gpt-oss-120b","google-ai-studio/gemini-2.5-flash","google-ai-studio/gemini-2.5-pro","grok/grok-4","groq/llama-3.3-70b-versatile","groq/llama-3.1-8b-instant","openai/gpt-5","openai/gpt-5-mini","openai/gpt-5-nano"],"type":"string"},{"enum":[""],"type":"string"}]},"query":{"type":"string"},"ranking_options":{"default":{},"properties":{"ranker":{"type":"string"},"score_threshold":{"default":0.4,"maximum":1,"minimum":0,"type":"number"}},"type":"object"},"reranking":{"properties":{"enabled":{"default":false,"type":"boolean"},"model":{"anyOf":[{"enum":["@cf/baai/bge-reranker-base"],"type":"string"},{"enum":[""],"type":"string"}]}},"type":"object"},"rewrite_query":{"default":false,"type":"boolean"},"stream":{"default":false,"type":"boolean"},"system_prompt":{"type":"string"}},"required":["query"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"data":{"items":{"properties":{"attributes":{"type":"object"},"content":{"items":{"properties":{"text":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"file_id":{"type":"string"},"filename":{"type":"string"},"score":{"type":"number"}},"required":["score"],"type":"object"},"type":"array"},"has_more":{"default":false,"type":"boolean"},"next_page":{"nullable":true,"type":"string"},"object":{"type":"string"},"response":{"type":"string"},"search_query":{"type":"string"}},"required":["search_query","response"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the log details"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"AI Search","tags":["AutoRAG RAG Search"],"x-api-token-group":["Auto Rag Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.rag"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/autorag/rags/{id}/files":{"get":{"operationId":"autorag-config-files","parameters":[{"description":"rag id","in":"path","name":"id","required":true,"schema":{"description":"rag id","example":"my-rag","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"example":"c3dc5f0b34a14ff8e1b3ec04895e1b22","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"default":20,"maximum":50,"minimum":0,"type":"integer"}},{"in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"status","schema":{"enum":["completed","queued","running","error"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"error":{"type":"string"},"key":{"type":"string"}},"required":["key","error"],"type":"object"},"type":"array"},"result_info":{"properties":{"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"default":20,"maximum":50,"minimum":5,"type":"integer"},"total_count":{"type":"integer"}},"required":["count","page","total_count"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result","result_info"],"type":"object"}}},"description":"Returns the AI Search files"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"autorag_not_found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"autorag_not_found"},"503":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7017,"type":"number"},"message":{"example":"unable_to_connect_to_autorag","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"unable_to_connect_to_autorag"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Files","tags":["AutoRAG RAG"],"x-api-token-group":["Auto Rag Write","Auto Rag Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.rag"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/autorag/rags/{id}/jobs":{"get":{"operationId":"autorag-config-list-jobs","parameters":[{"description":"rag id","in":"path","name":"id","required":true,"schema":{"description":"rag id","example":"my-rag","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"example":"c3dc5f0b34a14ff8e1b3ec04895e1b22","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"default":20,"maximum":50,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"end_reason":{"type":"string"},"ended_at":{"type":"string"},"id":{"type":"string"},"last_seen_at":{"type":"string"},"source":{"enum":["user","schedule"],"type":"string"},"started_at":{"type":"string"}},"required":["id","source"],"type":"object"},"type":"array"},"result_info":{"properties":{"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_count":{"type":"integer"}},"required":["count","page","per_page","total_count"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result","result_info"],"type":"object"}}},"description":"Returns a list of AutoRAG Jobs"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"autorag_not_found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"autorag_not_found"},"503":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7017,"type":"number"},"message":{"example":"unable_to_connect_to_autorag","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"unable_to_connect_to_autorag"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Jobs","tags":["AutoRAG Jobs"],"x-api-token-group":["Auto Rag Write","Auto Rag Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.rag"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/autorag/rags/{id}/jobs/{job_id}":{"get":{"operationId":"autorag-config-get-job","parameters":[{"description":"rag id","in":"path","name":"id","required":true,"schema":{"description":"rag id","example":"my-rag","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}},{"in":"path","name":"job_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"example":"c3dc5f0b34a14ff8e1b3ec04895e1b22","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"end_reason":{"type":"string"},"ended_at":{"type":"string"},"id":{"type":"string"},"last_seen_at":{"type":"string"},"source":{"enum":["user","schedule"],"type":"string"},"started_at":{"type":"string"}},"required":["id","source"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns a AutoRAG Job Details"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7021,"type":"number"},"message":{"example":"job_not_found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"job_not_found"},"503":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7017,"type":"number"},"message":{"example":"unable_to_connect_to_autorag","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"unable_to_connect_to_autorag"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get a Job Details","tags":["AutoRAG Jobs"],"x-api-token-group":["Auto Rag Write","Auto Rag Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.rag"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/autorag/rags/{id}/jobs/{job_id}/logs":{"get":{"operationId":"autorag-config-list-job-logs","parameters":[{"description":"rag id","in":"path","name":"id","required":true,"schema":{"description":"rag id","example":"my-rag","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}},{"in":"path","name":"job_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"example":"c3dc5f0b34a14ff8e1b3ec04895e1b22","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"default":20,"maximum":500,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"created_at":{"type":"number"},"id":{"type":"integer"},"message":{"type":"string"},"message_type":{"type":"integer"}},"required":["id","message","message_type","created_at"],"type":"object"},"type":"array"},"result_info":{"properties":{"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_count":{"type":"integer"}},"required":["count","page","per_page","total_count"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result","result_info"],"type":"object"}}},"description":"Returns a list of AutoRAG Job Logs"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"autorag_not_found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"autorag_not_found"},"503":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7017,"type":"number"},"message":{"example":"unable_to_connect_to_autorag","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"unable_to_connect_to_autorag"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Job Logs","tags":["AutoRAG Jobs"],"x-api-token-group":["Auto Rag Write","Auto Rag Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.rag"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/autorag/rags/{id}/search":{"post":{"operationId":"autorag-config-search","parameters":[{"description":"rag id","in":"path","name":"id","required":true,"schema":{"description":"rag id","example":"my-rag","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"example":"c3dc5f0b34a14ff8e1b3ec04895e1b22","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"filters":{"anyOf":[{"properties":{"key":{"type":"string"},"type":{"enum":["eq","ne","gt","gte","lt","lte"],"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","type","value"],"type":"object"},{"properties":{"filters":{"items":{"properties":{"key":{"type":"string"},"type":{"enum":["eq","ne","gt","gte","lt","lte"],"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","type","value"],"type":"object"},"type":"array"},"type":{"enum":["and","or"],"type":"string"}},"required":["type","filters"],"type":"object"}]},"max_num_results":{"default":10,"maximum":50,"minimum":1,"type":"integer"},"query":{"type":"string"},"ranking_options":{"default":{},"properties":{"ranker":{"type":"string"},"score_threshold":{"default":0.4,"maximum":1,"minimum":0,"type":"number"}},"type":"object"},"reranking":{"properties":{"enabled":{"default":false,"type":"boolean"},"model":{"anyOf":[{"enum":["@cf/baai/bge-reranker-base"],"type":"string"},{"enum":[""],"type":"string"}]}},"type":"object"},"rewrite_query":{"default":false,"type":"boolean"}},"required":["query"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"data":{"items":{"properties":{"attributes":{"type":"object"},"content":{"items":{"properties":{"text":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"file_id":{"type":"string"},"filename":{"type":"string"},"score":{"type":"number"}},"required":["score"],"type":"object"},"type":"array"},"has_more":{"default":false,"type":"boolean"},"next_page":{"nullable":true,"type":"string"},"object":{"type":"string"},"search_query":{"type":"string"}},"required":["search_query"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the log details"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"Not Found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"Not Found"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Search","tags":["AutoRAG RAG Search"],"x-api-token-group":["Auto Rag Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.rag"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/autorag/rags/{id}/sync":{"patch":{"operationId":"autorag-config-sync","parameters":[{"description":"rag id","in":"path","name":"id","required":true,"schema":{"description":"rag id","example":"my-rag","maxLength":32,"minLength":1,"pattern":"^[a-z0-9_]+(?:-[a-z0-9_]+)*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"example":"c3dc5f0b34a14ff8e1b3ec04895e1b22","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"job_id":{"type":"string"}},"required":["job_id"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns the autorag sync status"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7032,"type":"number"},"message":{"example":"autorag_is_paused","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"autorag_is_paused"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7002,"type":"number"},"message":{"example":"autorag_not_found","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"autorag_not_found"},"429":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7020,"type":"number"},"message":{"example":"sync_in_cooldown","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"sync_in_cooldown"},"503":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"example":7017,"type":"number"},"message":{"example":"unable_to_connect_to_autorag","type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["success","errors"],"type":"object"}}},"description":"unable_to_connect_to_autorag"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Sync","tags":["AutoRAG RAG"],"x-api-token-group":["Auto Rag Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.rag"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/billing/profile":{"get":{"deprecated":true,"description":"Gets the current billing profile for the account.","operationId":"account-billing-profile-(-deprecated)-billing-profile-details","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_billing_response_single"}}},"description":"Billing Profile Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_billing_response_single"},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"Billing Profile Details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Billing Profile Details","tags":["Account Billing Profile"],"x-api-token-group":["Billing Write","Billing Read"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/botnet_feed/asn/{asn_id}/day_report":{"get":{"description":"Gets all the data the botnet tracking database has for a given ASN registered to user account for given date. If no date is given, it will return results for the previous day.","operationId":"botnet-threat-feed-get-day-report","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"in":"path","name":"asn_id","required":true,"schema":{"$ref":"#/components/schemas/dos_asn"}},{"in":"query","name":"date","schema":{"$ref":"#/components/schemas/dos_timestamp"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-common"},{"properties":{"result":{"properties":{"cidr":{"example":"1.1.1.1/32","type":"string"},"date":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string"},"offense_count":{"example":1000,"type":"integer"}},"type":"object"}},"type":"object"}],"type":"object"}}},"description":"Get botnet feed report for day"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Get botnet feed report for day response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get daily report","tags":["Botnet Threat Feed"],"x-api-token-group":["DDoS Botnet Feed Write","DDoS Botnet Feed Read"]}},"/accounts/{account_id}/botnet_feed/asn/{asn_id}/full_report":{"get":{"description":"Gets all the data the botnet threat feed tracking database has for a given ASN registered to user account.","operationId":"botnet-threat-feed-get-full-report","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"in":"path","name":"asn_id","required":true,"schema":{"$ref":"#/components/schemas/dos_asn"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-common"},{"properties":{"result":{"properties":{"cidr":{"example":"1.1.1.1/32","type":"string"},"date":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string"},"offense_count":{"example":1000,"type":"integer"}},"type":"object"}},"type":"object"}],"type":"object"}}},"description":"Get full botnet feed report"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Get full botnet feed report response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get full report","tags":["Botnet Threat Feed"],"x-api-token-group":["DDoS Botnet Feed Write","DDoS Botnet Feed Read"]}},"/accounts/{account_id}/botnet_feed/configs/asn":{"get":{"description":"Gets a list of all ASNs registered for a user for the DDoS Botnet Feed API.","operationId":"botnet-threat-feed-list-asn","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-common"},{"properties":{"result":{"properties":{"asn":{"example":13335,"type":"integer"}},"type":"object"}},"type":"object"}],"type":"object"}}},"description":"Get list of ASNs response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Get list of ASNs response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get list of ASNs","tags":["Botnet Threat Feed"],"x-api-token-group":["DDoS Botnet Feed Write","DDoS Botnet Feed Read"]}},"/accounts/{account_id}/botnet_feed/configs/asn/{asn_id}":{"delete":{"description":"Delete an ASN from botnet threat feed for a given user.","operationId":"botnet-threat-feed-delete-asn","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"in":"path","name":"asn_id","required":true,"schema":{"$ref":"#/components/schemas/dos_asn"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dos_api-response-common"},{"properties":{"result":{"properties":{"asn":{"example":13335,"type":"integer"}},"type":"object"}},"type":"object"}],"type":"object"}}},"description":"Delete ASN response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete ASN response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an ASN","tags":["Botnet Threat Feed"],"x-api-token-group":["DDoS Botnet Feed Write"]}},"/accounts/{account_id}/brand-protection/alerts":{"get":{"description":"Return all alerts on submitted domains","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read all alerts on submitted domains","tags":["brand_protection"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"patch":{"description":"Return a success message after updating alerts on submitted domains by ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Update alerts on submitted domains by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/alerts/clear":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"patch":{"description":"Return a success message after updating verification statuses of tracked URLs to awaiting by ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Update verification statuses of tracked URLs to awaiting by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/alerts/refute":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"patch":{"description":"Return a success message after updating verification statuses of tracked URLs to disproven by ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Update verification statuses of tracked URLs to disproven by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/alerts/verify":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"patch":{"description":"Return a success message after updating verification statuses of tracked URLs to confirmed by ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Update verification statuses of tracked URLs to confirmed by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/brands":{"delete":{"description":"Return a success message after deleting brands by ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Delete brands by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write"]},"get":{"description":"Return all brands","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read all brands","tags":["brand_protection"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"post":{"description":"Return new brands","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Create new brands","tags":["brand_protection"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/brands/patterns":{"delete":{"description":"Return a success message after deleting patterns for brands by ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Delete patterns for brands by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write"]},"get":{"description":"Return patterns for brands based on ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read patterns for brands by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"post":{"description":"Return a success message after creating new patterns for brands by ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Create new patterns for brands by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/clear":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"patch":{"description":"Return a success message after updating verification statuses of submitted URLs to awaiting by ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Update verification statuses of submitted URLs to awaiting by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/domain-info":{"get":{"description":"Return submitted domains based on ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read submitted domains by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}]},"/accounts/{account_id}/brand-protection/logo-matches":{"get":{"description":"Return matches for logo queries based on ID","parameters":[{"explode":true,"in":"query","name":"logo_id","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"in":"query","name":"offset","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand-protection-api_LogoMatch"}}},"description":"OK"},"422":{"$ref":"#/components/responses/brand-protection-api_UNPROCESSABLE_CONTENT"},"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read matches for logo queries by ID","tags":["logo_match"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}]},"/accounts/{account_id}/brand-protection/logo-matches/download":{"get":{"description":"Return matches as CSV for logo queries based on ID","parameters":[{"explode":true,"in":"query","name":"logo_id","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"in":"query","name":"offset","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand-protection-api_LogoMatch"}}},"description":"OK"},"422":{"$ref":"#/components/responses/brand-protection-api_UNPROCESSABLE_CONTENT"},"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Download matches for logo queries by ID","tags":["logo_match"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}]},"/accounts/{account_id}/brand-protection/logos":{"get":{"description":"Return all saved logo queries","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read all saved logo queries","tags":["logo_match"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"post":{"description":"Return new saved logo queries created from image files","parameters":[{"in":"query","name":"tag","schema":{"type":"string"}},{"in":"query","name":"match_type","schema":{"type":"string"}},{"in":"query","name":"threshold","schema":{"type":"number"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/brand-protection-api_ImageFile"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand-protection-api_Logo"}}},"description":"Created"},"422":{"$ref":"#/components/responses/brand-protection-api_UNPROCESSABLE_CONTENT"},"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Create new saved logo queries from image files","tags":["logo_match"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/logos/{logo_id}":{"delete":{"description":"Return a success message after deleting saved logo queries by ID","responses":{"204":{"description":"No Content"},"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Delete saved logo queries by ID","tags":["logo_match"],"x-api-token-group":["Intel Write"]},"get":{"description":"Return saved logo queries based on ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read saved logo queries by ID","tags":["logo_match"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}},{"in":"path","name":"logo_id","required":true,"schema":{"minLength":1,"type":"string"}}]},"/accounts/{account_id}/brand-protection/matches":{"get":{"description":"Return matches for string queries based on ID","parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"offset","schema":{"type":"integer"}},{"in":"query","name":"limit","schema":{"type":"integer"}},{"in":"query","name":"include_domain_id","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand-protection-api_QueryMatch"}}},"description":"OK"},"422":{"$ref":"#/components/responses/brand-protection-api_UNPROCESSABLE_CONTENT"},"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read matches for string queries by ID","tags":["domain_search"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}]},"/accounts/{account_id}/brand-protection/matches/download":{"get":{"description":"Return matches as CSV for string queries based on ID","parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"offset","schema":{"type":"integer"}},{"in":"query","name":"limit","schema":{"type":"integer"}},{"in":"query","name":"include_domain_id","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand-protection-api_QueryMatch"}}},"description":"OK"},"422":{"$ref":"#/components/responses/brand-protection-api_UNPROCESSABLE_CONTENT"},"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Download matches for string queries by ID","tags":["domain_search"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}]},"/accounts/{account_id}/brand-protection/queries":{"delete":{"description":"Return a success message after deleting saved string queries by ID","parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"tag","schema":{"type":"string"}},{"in":"query","name":"scan","schema":{"type":"boolean"}}],"responses":{"204":{"description":"No Content"},"422":{"$ref":"#/components/responses/brand-protection-api_UNPROCESSABLE_CONTENT"},"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Delete saved string queries by ID","tags":["domain_search"],"x-api-token-group":["Intel Write"]},"get":{"description":"Return string queries based on ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read string queries by ID","tags":["domain_search"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"patch":{"description":"Return a success message after updating saved string queries by ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Update saved string queries by ID","tags":["domain_search"],"x-api-token-group":["Intel Write"]},"post":{"description":"Return a success message after creating new saved string queries","parameters":[{"in":"query","name":"id","schema":{"type":"string"}},{"in":"query","name":"tag","schema":{"type":"string"}},{"in":"query","name":"scan","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand-protection-api_Query"}}},"required":true},"responses":{"204":{"description":"No Content"},"422":{"$ref":"#/components/responses/brand-protection-api_UNPROCESSABLE_CONTENT"},"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Create new saved string queries","tags":["domain_search"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/queries/bulk":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"post":{"description":"Return a success message after creating new saved string queries in bulk","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand-protection-api_QueryBulk"}}},"required":true},"responses":{"204":{"description":"No Content"},"422":{"$ref":"#/components/responses/brand-protection-api_UNPROCESSABLE_CONTENT"},"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Create new saved string queries in bulk","tags":["domain_search"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/recent-submissions":{"get":{"description":"Return recent URL submissions","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read recent URL submissions","tags":["brand_protection"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}]},"/accounts/{account_id}/brand-protection/refute":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"patch":{"description":"Return a success message after updating verification statuses of submitted URLs to disproven by ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Update verification statuses of submitted URLs to disproven by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/scan-logo":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"post":{"description":"Return new logo queries created from image files","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Create new logo queries from image files","tags":["logo_match"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/scan-page":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"post":{"description":"Return new logo queries created from URLs","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Create new logo queries from URLs","tags":["logo_match"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/search":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"post":{"description":"Return new string queries","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Create new string queries","tags":["domain_search"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/submission-info":{"get":{"description":"Return URL submissions based on ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read URL submissions by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}]},"/accounts/{account_id}/brand-protection/submit":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"post":{"description":"Return new URL submissions","responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand-protection-api_URLSubmit"}}},"description":"Created"},"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Create new URL submissions","tags":["brand_protection"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/brand-protection/total-queries":{"get":{"description":"Return the total number of saved string queries","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read the total number of saved string queries","tags":["domain_search"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}]},"/accounts/{account_id}/brand-protection/tracked-domains":{"get":{"description":"Return submitted domains based on pattern","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read submitted domains by pattern","tags":["brand_protection"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}]},"/accounts/{account_id}/brand-protection/url-info":{"get":{"description":"Return submitted URLs based on ID","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/brand-protection-api_URLInfo"}}},"description":"OK"},"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Read submitted URLs by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write","Intel Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}]},"/accounts/{account_id}/brand-protection/verify":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"minLength":1,"type":"string"}}],"patch":{"description":"Return a success message after updating verification statuses of submitted URLs to confirmed by ID","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Update verification statuses of submitted URLs to confirmed by ID","tags":["brand_protection"],"x-api-token-group":["Intel Write"]}},"/accounts/{account_id}/browser-rendering/content":{"post":{"description":"Fetches rendered HTML content from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour.","operationId":"brapi-post_Content","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Cache TTL default is 5s. Set to 0 to disable.","in":"query","name":"cacheTTL","schema":{"default":5,"description":"Cache TTL default is 5s. Set to 0 to disable.","maximum":86400,"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"properties":{"actionTimeout":{"description":"The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.","maximum":120000,"type":"number"},"addScriptTag":{"description":"Adds a `\u003cscript\u003e` tag into the page with the desired URL or content.","items":{"properties":{"content":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"addStyleTag":{"description":"Adds a `\u003clink rel=\"stylesheet\"\u003e` tag into the page with the desired URL or a `\u003cstyle type=\"text/css\"\u003e` tag with the content.","items":{"properties":{"content":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"allowRequestPattern":{"description":"Only allow requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"allowResourceTypes":{"description":"Only allow requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"authenticate":{"description":"Provide credentials for HTTP authentication.","properties":{"password":{"minLength":1,"type":"string","x-sensitive":true},"username":{"minLength":1,"type":"string"}},"required":["username","password"],"type":"object"},"bestAttempt":{"description":"Attempt to proceed when 'awaited' events fail or timeout.","type":"boolean"},"cookies":{"description":"Check [options](https://pptr.dev/api/puppeteer.page.setcookie).","items":{"properties":{"domain":{"type":"string"},"expires":{"type":"number"},"httpOnly":{"type":"boolean"},"name":{"type":"string"},"partitionKey":{"type":"string"},"path":{"type":"string"},"priority":{"anyOf":[{"enum":["Low"],"type":"string"},{"enum":["Medium"],"type":"string"},{"enum":["High"],"type":"string"}]},"sameParty":{"type":"boolean"},"sameSite":{"anyOf":[{"enum":["Strict"],"type":"string"},{"enum":["Lax"],"type":"string"},{"enum":["None"],"type":"string"}]},"secure":{"type":"boolean"},"sourcePort":{"type":"number"},"sourceScheme":{"anyOf":[{"enum":["Unset"],"type":"string"},{"enum":["NonSecure"],"type":"string"},{"enum":["Secure"],"type":"string"}]},"url":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"emulateMediaType":{"type":"string"},"gotoOptions":{"default":{},"description":"Check [options](https://pptr.dev/api/puppeteer.gotooptions).","properties":{"referer":{"type":"string"},"referrerPolicy":{"type":"string"},"timeout":{"default":30000,"maximum":60000,"type":"number"},"waitUntil":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"},{"items":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"}]},"type":"array"}],"default":"domcontentloaded"}},"type":"object"},"html":{"description":"Set the content of the page, eg: `\u003ch1\u003eHello World!!\u003c/h1\u003e`. Either `html` or `url` must be set.","minLength":1,"type":"string"},"rejectRequestPattern":{"description":"Block undesired requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"rejectResourceTypes":{"description":"Block undesired requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"setExtraHTTPHeaders":{"additionalProperties":{"type":"string"},"type":"object"},"setJavaScriptEnabled":{"type":"boolean"},"url":{"description":"URL to navigate to, eg. `https://example.com`.","format":"uri","type":"string"},"userAgent":{"default":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36","type":"string"},"viewport":{"default":{"height":1080,"width":1920},"description":"Check [options](https://pptr.dev/api/puppeteer.page.setviewport).","properties":{"deviceScaleFactor":{"type":"number"},"hasTouch":{"type":"boolean"},"height":{"type":"number"},"isLandscape":{"type":"boolean"},"isMobile":{"type":"boolean"},"width":{"type":"number"}},"required":["width","height"],"type":"object"},"waitForSelector":{"description":"Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).","properties":{"hidden":{"enum":[true],"type":"boolean"},"selector":{"type":"string"},"timeout":{"maximum":120000,"type":"number"},"visible":{"enum":[true],"type":"boolean"}},"required":["selector"],"type":"object"},"waitForTimeout":{"description":"Waits for a specified timeout before continuing.","maximum":120000,"type":"number"}},"type":"object"}]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"meta":{"properties":{"status":{"type":"number"},"title":{"type":"string"}},"type":"object"},"result":{"description":"HTML content","type":"string"},"status":{"description":"Response status","type":"boolean"}},"required":["status","meta"],"type":"object"}}},"description":"Returns the page's content"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"The request contains errors or didn't properly encode content."},"422":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content."},"429":{"content":{"application/json":{"example":{"errors":[{"code":2001,"message":"Rate limit exceeded"}],"success":false},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request","required":true,"schema":{"description":"Number of seconds to wait before retrying the request","example":60,"type":"number"}}}},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTML content.","tags":["brapi"],"x-api-token-group":["Browser Rendering Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.brapi.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/browser-rendering/json":{"post":{"description":"Gets json from a webpage from a provided URL or HTML. Pass `prompt` or `schema` in the body. Control page loading with `gotoOptions` and `waitFor*` options.","operationId":"brapi-post_Json","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Cache TTL default is 5s. Set to 0 to disable.","in":"query","name":"cacheTTL","schema":{"default":5,"description":"Cache TTL default is 5s. Set to 0 to disable.","maximum":86400,"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"properties":{"actionTimeout":{"description":"The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.","maximum":120000,"type":"number"},"addScriptTag":{"description":"Adds a `\u003cscript\u003e` tag into the page with the desired URL or content.","items":{"properties":{"content":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"addStyleTag":{"description":"Adds a `\u003clink rel=\"stylesheet\"\u003e` tag into the page with the desired URL or a `\u003cstyle type=\"text/css\"\u003e` tag with the content.","items":{"properties":{"content":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"allowRequestPattern":{"description":"Only allow requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"allowResourceTypes":{"description":"Only allow requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"authenticate":{"description":"Provide credentials for HTTP authentication.","properties":{"password":{"minLength":1,"type":"string","x-sensitive":true},"username":{"minLength":1,"type":"string"}},"required":["username","password"],"type":"object"},"bestAttempt":{"description":"Attempt to proceed when 'awaited' events fail or timeout.","type":"boolean"},"cookies":{"description":"Check [options](https://pptr.dev/api/puppeteer.page.setcookie).","items":{"properties":{"domain":{"type":"string"},"expires":{"type":"number"},"httpOnly":{"type":"boolean"},"name":{"type":"string"},"partitionKey":{"type":"string"},"path":{"type":"string"},"priority":{"anyOf":[{"enum":["Low"],"type":"string"},{"enum":["Medium"],"type":"string"},{"enum":["High"],"type":"string"}]},"sameParty":{"type":"boolean"},"sameSite":{"anyOf":[{"enum":["Strict"],"type":"string"},{"enum":["Lax"],"type":"string"},{"enum":["None"],"type":"string"}]},"secure":{"type":"boolean"},"sourcePort":{"type":"number"},"sourceScheme":{"anyOf":[{"enum":["Unset"],"type":"string"},{"enum":["NonSecure"],"type":"string"},{"enum":["Secure"],"type":"string"}]},"url":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"custom_ai":{"description":"Optional list of custom AI models to use for the request. The models will be tried in the order provided, and in case a model returns an error, the next one will be used as fallback.","items":{"properties":{"authorization":{"description":"Authorization token for the AI model: `Bearer \u003ctoken\u003e`.","type":"string"},"model":{"description":"AI model to use for the request. Must be formed as `\u003cprovider\u003e/\u003cmodel_name\u003e`, e.g. `workers-ai/@cf/meta/llama-3.3-70b-instruct-fp8-fast`","type":"string"}},"required":["model","authorization"],"type":"object"},"type":"array"},"emulateMediaType":{"type":"string"},"gotoOptions":{"default":{},"description":"Check [options](https://pptr.dev/api/puppeteer.gotooptions).","properties":{"referer":{"type":"string"},"referrerPolicy":{"type":"string"},"timeout":{"default":30000,"maximum":60000,"type":"number"},"waitUntil":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"},{"items":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"}]},"type":"array"}],"default":"domcontentloaded"}},"type":"object"},"html":{"description":"Set the content of the page, eg: `\u003ch1\u003eHello World!!\u003c/h1\u003e`. Either `html` or `url` must be set.","minLength":1,"type":"string"},"prompt":{"type":"string"},"rejectRequestPattern":{"description":"Block undesired requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"rejectResourceTypes":{"description":"Block undesired requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"response_format":{"properties":{"json_schema":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"items":{"type":"string"},"type":"array"}]},"description":"Schema for the response format. More information here: https://developers.cloudflare.com/workers-ai/json-mode/","nullable":true,"type":"object"},"type":{"type":"string"}},"required":["type"],"type":"object"},"setExtraHTTPHeaders":{"additionalProperties":{"type":"string"},"type":"object"},"setJavaScriptEnabled":{"type":"boolean"},"url":{"description":"URL to navigate to, eg. `https://example.com`.","format":"uri","type":"string"},"userAgent":{"default":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36","type":"string"},"viewport":{"default":{"height":1080,"width":1920},"description":"Check [options](https://pptr.dev/api/puppeteer.page.setviewport).","properties":{"deviceScaleFactor":{"type":"number"},"hasTouch":{"type":"boolean"},"height":{"type":"number"},"isLandscape":{"type":"boolean"},"isMobile":{"type":"boolean"},"width":{"type":"number"}},"required":["width","height"],"type":"object"},"waitForSelector":{"description":"Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).","properties":{"hidden":{"enum":[true],"type":"boolean"},"selector":{"type":"string"},"timeout":{"maximum":120000,"type":"number"},"visible":{"enum":[true],"type":"boolean"}},"required":["selector"],"type":"object"},"waitForTimeout":{"description":"Waits for a specified timeout before continuing.","maximum":120000,"type":"number"}},"type":"object"}]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"result":{"additionalProperties":{"nullable":true,"type":"object"},"type":"object"},"status":{"description":"Response status","type":"boolean"}},"required":["status","result"],"type":"object"}}},"description":"Returns the JSON based on a user prompt or json schema"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"The request contains errors or didn't properly encode content."},"422":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content."},"429":{"content":{"application/json":{"example":{"errors":[{"code":2001,"message":"Rate limit exceeded"}],"success":false},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request","required":true,"schema":{"description":"Number of seconds to wait before retrying the request","example":60,"type":"number"}}}},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get json.","tags":["brapi"],"x-api-token-group":["Browser Rendering Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.brapi.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/browser-rendering/links":{"post":{"description":"Get links from a web page.","operationId":"brapi-post_Links","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Cache TTL default is 5s. Set to 0 to disable.","in":"query","name":"cacheTTL","schema":{"default":5,"description":"Cache TTL default is 5s. Set to 0 to disable.","maximum":86400,"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"properties":{"actionTimeout":{"description":"The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.","maximum":120000,"type":"number"},"addScriptTag":{"description":"Adds a `\u003cscript\u003e` tag into the page with the desired URL or content.","items":{"properties":{"content":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"addStyleTag":{"description":"Adds a `\u003clink rel=\"stylesheet\"\u003e` tag into the page with the desired URL or a `\u003cstyle type=\"text/css\"\u003e` tag with the content.","items":{"properties":{"content":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"allowRequestPattern":{"description":"Only allow requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"allowResourceTypes":{"description":"Only allow requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"authenticate":{"description":"Provide credentials for HTTP authentication.","properties":{"password":{"minLength":1,"type":"string","x-sensitive":true},"username":{"minLength":1,"type":"string"}},"required":["username","password"],"type":"object"},"bestAttempt":{"description":"Attempt to proceed when 'awaited' events fail or timeout.","type":"boolean"},"cookies":{"description":"Check [options](https://pptr.dev/api/puppeteer.page.setcookie).","items":{"properties":{"domain":{"type":"string"},"expires":{"type":"number"},"httpOnly":{"type":"boolean"},"name":{"type":"string"},"partitionKey":{"type":"string"},"path":{"type":"string"},"priority":{"anyOf":[{"enum":["Low"],"type":"string"},{"enum":["Medium"],"type":"string"},{"enum":["High"],"type":"string"}]},"sameParty":{"type":"boolean"},"sameSite":{"anyOf":[{"enum":["Strict"],"type":"string"},{"enum":["Lax"],"type":"string"},{"enum":["None"],"type":"string"}]},"secure":{"type":"boolean"},"sourcePort":{"type":"number"},"sourceScheme":{"anyOf":[{"enum":["Unset"],"type":"string"},{"enum":["NonSecure"],"type":"string"},{"enum":["Secure"],"type":"string"}]},"url":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"emulateMediaType":{"type":"string"},"excludeExternalLinks":{"default":false,"type":"boolean"},"gotoOptions":{"default":{},"description":"Check [options](https://pptr.dev/api/puppeteer.gotooptions).","properties":{"referer":{"type":"string"},"referrerPolicy":{"type":"string"},"timeout":{"default":30000,"maximum":60000,"type":"number"},"waitUntil":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"},{"items":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"}]},"type":"array"}],"default":"domcontentloaded"}},"type":"object"},"html":{"description":"Set the content of the page, eg: `\u003ch1\u003eHello World!!\u003c/h1\u003e`. Either `html` or `url` must be set.","minLength":1,"type":"string"},"rejectRequestPattern":{"description":"Block undesired requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"rejectResourceTypes":{"description":"Block undesired requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"setExtraHTTPHeaders":{"additionalProperties":{"type":"string"},"type":"object"},"setJavaScriptEnabled":{"type":"boolean"},"url":{"description":"URL to navigate to, eg. `https://example.com`.","format":"uri","type":"string"},"userAgent":{"default":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36","type":"string"},"viewport":{"default":{"height":1080,"width":1920},"description":"Check [options](https://pptr.dev/api/puppeteer.page.setviewport).","properties":{"deviceScaleFactor":{"type":"number"},"hasTouch":{"type":"boolean"},"height":{"type":"number"},"isLandscape":{"type":"boolean"},"isMobile":{"type":"boolean"},"width":{"type":"number"}},"required":["width","height"],"type":"object"},"visibleLinksOnly":{"default":false,"type":"boolean"},"waitForSelector":{"description":"Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).","properties":{"hidden":{"enum":[true],"type":"boolean"},"selector":{"type":"string"},"timeout":{"maximum":120000,"type":"number"},"visible":{"enum":[true],"type":"boolean"}},"required":["selector"],"type":"object"},"waitForTimeout":{"description":"Waits for a specified timeout before continuing.","maximum":120000,"type":"number"}},"type":"object"}]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"result":{"items":{"type":"string"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status","result"],"type":"object"}}},"description":"Returns the links"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"The request contains errors or didn't properly encode content."},"422":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content."},"429":{"content":{"application/json":{"example":{"errors":[{"code":2001,"message":"Rate limit exceeded"}],"success":false},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request","required":true,"schema":{"description":"Number of seconds to wait before retrying the request","example":60,"type":"number"}}}},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Links.","tags":["brapi"],"x-api-token-group":["Browser Rendering Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.brapi.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/browser-rendering/markdown":{"post":{"description":"Gets markdown of a webpage from provided URL or HTML. Control page loading with `gotoOptions` and `waitFor*` options.","operationId":"brapi-post_Markdown","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Cache TTL default is 5s. Set to 0 to disable.","in":"query","name":"cacheTTL","schema":{"default":5,"description":"Cache TTL default is 5s. Set to 0 to disable.","maximum":86400,"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"properties":{"actionTimeout":{"description":"The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.","maximum":120000,"type":"number"},"addScriptTag":{"description":"Adds a `\u003cscript\u003e` tag into the page with the desired URL or content.","items":{"properties":{"content":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"addStyleTag":{"description":"Adds a `\u003clink rel=\"stylesheet\"\u003e` tag into the page with the desired URL or a `\u003cstyle type=\"text/css\"\u003e` tag with the content.","items":{"properties":{"content":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"allowRequestPattern":{"description":"Only allow requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"allowResourceTypes":{"description":"Only allow requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"authenticate":{"description":"Provide credentials for HTTP authentication.","properties":{"password":{"minLength":1,"type":"string","x-sensitive":true},"username":{"minLength":1,"type":"string"}},"required":["username","password"],"type":"object"},"bestAttempt":{"description":"Attempt to proceed when 'awaited' events fail or timeout.","type":"boolean"},"cookies":{"description":"Check [options](https://pptr.dev/api/puppeteer.page.setcookie).","items":{"properties":{"domain":{"type":"string"},"expires":{"type":"number"},"httpOnly":{"type":"boolean"},"name":{"type":"string"},"partitionKey":{"type":"string"},"path":{"type":"string"},"priority":{"anyOf":[{"enum":["Low"],"type":"string"},{"enum":["Medium"],"type":"string"},{"enum":["High"],"type":"string"}]},"sameParty":{"type":"boolean"},"sameSite":{"anyOf":[{"enum":["Strict"],"type":"string"},{"enum":["Lax"],"type":"string"},{"enum":["None"],"type":"string"}]},"secure":{"type":"boolean"},"sourcePort":{"type":"number"},"sourceScheme":{"anyOf":[{"enum":["Unset"],"type":"string"},{"enum":["NonSecure"],"type":"string"},{"enum":["Secure"],"type":"string"}]},"url":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"emulateMediaType":{"type":"string"},"gotoOptions":{"default":{},"description":"Check [options](https://pptr.dev/api/puppeteer.gotooptions).","properties":{"referer":{"type":"string"},"referrerPolicy":{"type":"string"},"timeout":{"default":30000,"maximum":60000,"type":"number"},"waitUntil":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"},{"items":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"}]},"type":"array"}],"default":"domcontentloaded"}},"type":"object"},"html":{"description":"Set the content of the page, eg: `\u003ch1\u003eHello World!!\u003c/h1\u003e`. Either `html` or `url` must be set.","minLength":1,"type":"string"},"rejectRequestPattern":{"description":"Block undesired requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"rejectResourceTypes":{"description":"Block undesired requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"setExtraHTTPHeaders":{"additionalProperties":{"type":"string"},"type":"object"},"setJavaScriptEnabled":{"type":"boolean"},"url":{"description":"URL to navigate to, eg. `https://example.com`.","format":"uri","type":"string"},"userAgent":{"default":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36","type":"string"},"viewport":{"default":{"height":1080,"width":1920},"description":"Check [options](https://pptr.dev/api/puppeteer.page.setviewport).","properties":{"deviceScaleFactor":{"type":"number"},"hasTouch":{"type":"boolean"},"height":{"type":"number"},"isLandscape":{"type":"boolean"},"isMobile":{"type":"boolean"},"width":{"type":"number"}},"required":["width","height"],"type":"object"},"waitForSelector":{"description":"Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).","properties":{"hidden":{"enum":[true],"type":"boolean"},"selector":{"type":"string"},"timeout":{"maximum":120000,"type":"number"},"visible":{"enum":[true],"type":"boolean"}},"required":["selector"],"type":"object"},"waitForTimeout":{"description":"Waits for a specified timeout before continuing.","maximum":120000,"type":"number"}},"type":"object"}]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"result":{"description":"Markdown","type":"string"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Returns the page markdown"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"The request contains errors or didn't properly encode content."},"422":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content."},"429":{"content":{"application/json":{"example":{"errors":[{"code":2001,"message":"Rate limit exceeded"}],"success":false},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request","required":true,"schema":{"description":"Number of seconds to wait before retrying the request","example":60,"type":"number"}}}},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get markdown.","tags":["brapi"],"x-api-token-group":["Browser Rendering Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.brapi.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/browser-rendering/pdf":{"post":{"description":"Fetches rendered PDF from provided URL or HTML. Check available options like `gotoOptions` and `waitFor*` to control page load behaviour.","operationId":"brapi-post_Pdf","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Cache TTL default is 5s. Set to 0 to disable.","in":"query","name":"cacheTTL","schema":{"default":5,"description":"Cache TTL default is 5s. Set to 0 to disable.","maximum":86400,"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"properties":{"actionTimeout":{"description":"The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.","maximum":120000,"type":"number"},"addScriptTag":{"description":"Adds a `\u003cscript\u003e` tag into the page with the desired URL or content.","items":{"properties":{"content":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"addStyleTag":{"description":"Adds a `\u003clink rel=\"stylesheet\"\u003e` tag into the page with the desired URL or a `\u003cstyle type=\"text/css\"\u003e` tag with the content.","items":{"properties":{"content":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"allowRequestPattern":{"description":"Only allow requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"allowResourceTypes":{"description":"Only allow requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"authenticate":{"description":"Provide credentials for HTTP authentication.","properties":{"password":{"minLength":1,"type":"string","x-sensitive":true},"username":{"minLength":1,"type":"string"}},"required":["username","password"],"type":"object"},"bestAttempt":{"description":"Attempt to proceed when 'awaited' events fail or timeout.","type":"boolean"},"cookies":{"description":"Check [options](https://pptr.dev/api/puppeteer.page.setcookie).","items":{"properties":{"domain":{"type":"string"},"expires":{"type":"number"},"httpOnly":{"type":"boolean"},"name":{"type":"string"},"partitionKey":{"type":"string"},"path":{"type":"string"},"priority":{"anyOf":[{"enum":["Low"],"type":"string"},{"enum":["Medium"],"type":"string"},{"enum":["High"],"type":"string"}]},"sameParty":{"type":"boolean"},"sameSite":{"anyOf":[{"enum":["Strict"],"type":"string"},{"enum":["Lax"],"type":"string"},{"enum":["None"],"type":"string"}]},"secure":{"type":"boolean"},"sourcePort":{"type":"number"},"sourceScheme":{"anyOf":[{"enum":["Unset"],"type":"string"},{"enum":["NonSecure"],"type":"string"},{"enum":["Secure"],"type":"string"}]},"url":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"emulateMediaType":{"type":"string"},"gotoOptions":{"default":{},"description":"Check [options](https://pptr.dev/api/puppeteer.gotooptions).","properties":{"referer":{"type":"string"},"referrerPolicy":{"type":"string"},"timeout":{"default":30000,"maximum":60000,"type":"number"},"waitUntil":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"},{"items":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"}]},"type":"array"}],"default":"domcontentloaded"}},"type":"object"},"html":{"description":"Set the content of the page, eg: `\u003ch1\u003eHello World!!\u003c/h1\u003e`. Either `html` or `url` must be set.","minLength":1,"type":"string"},"pdfOptions":{"additionalProperties":false,"default":{},"description":"Check [options](https://pptr.dev/api/puppeteer.pdfoptions).","properties":{"displayHeaderFooter":{"default":false,"description":"Whether to show the header and footer.","type":"boolean"},"footerTemplate":{"description":"HTML template for the print footer.","type":"string"},"format":{"default":"letter","description":"Paper format. Takes priority over width and height if set.","enum":["letter","legal","tabloid","ledger","a0","a1","a2","a3","a4","a5","a6"],"type":"string"},"headerTemplate":{"description":"HTML template for the print header.","type":"string"},"height":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"Sets the height of paper. Can be a number or string with unit."},"landscape":{"default":false,"description":"Whether to print in landscape orientation.","type":"boolean"},"margin":{"description":"Set the PDF margins. Useful when setting header and footer.","properties":{"bottom":{"anyOf":[{"type":"string"},{"type":"number"}]},"left":{"anyOf":[{"type":"string"},{"type":"number"}]},"right":{"anyOf":[{"type":"string"},{"type":"number"}]},"top":{"anyOf":[{"type":"string"},{"type":"number"}]}},"type":"object"},"omitBackground":{"default":false,"description":"Hides default white background and allows generating pdfs with transparency.","type":"boolean"},"outline":{"default":false,"description":"Generate document outline.","type":"boolean"},"pageRanges":{"description":"Paper ranges to print, e.g. '1-5, 8, 11-13'.","type":"string"},"preferCSSPageSize":{"default":false,"description":"Give CSS @page size priority over other size declarations.","type":"boolean"},"printBackground":{"default":false,"description":"Set to true to print background graphics.","type":"boolean"},"scale":{"default":1,"description":"Scales the rendering of the web page. Amount must be between 0.1 and 2.","maximum":2,"minimum":0.1,"type":"number"},"tagged":{"default":true,"description":"Generate tagged (accessible) PDF.","type":"boolean"},"timeout":{"default":30000,"description":"Timeout in milliseconds.","type":"number"},"width":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"Sets the width of paper. Can be a number or string with unit."}},"type":"object"},"rejectRequestPattern":{"description":"Block undesired requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"rejectResourceTypes":{"description":"Block undesired requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"setExtraHTTPHeaders":{"additionalProperties":{"type":"string"},"type":"object"},"setJavaScriptEnabled":{"type":"boolean"},"url":{"description":"URL to navigate to, eg. `https://example.com`.","format":"uri","type":"string"},"userAgent":{"default":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36","type":"string"},"viewport":{"default":{"height":1080,"width":1920},"description":"Check [options](https://pptr.dev/api/puppeteer.page.setviewport).","properties":{"deviceScaleFactor":{"type":"number"},"hasTouch":{"type":"boolean"},"height":{"type":"number"},"isLandscape":{"type":"boolean"},"isMobile":{"type":"boolean"},"width":{"type":"number"}},"required":["width","height"],"type":"object"},"waitForSelector":{"description":"Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).","properties":{"hidden":{"enum":[true],"type":"boolean"},"selector":{"type":"string"},"timeout":{"maximum":120000,"type":"number"},"visible":{"enum":[true],"type":"boolean"}},"required":["selector"],"type":"object"},"waitForTimeout":{"description":"Waits for a specified timeout before continuing.","maximum":120000,"type":"number"}},"type":"object"}]}}}},"responses":{"200":{"content":{"application/pdf":{"schema":{"description":"Pdf binary","type":"string"}}},"description":"Returns the pdf"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"The request contains errors or didn't properly encode content."},"422":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content."},"429":{"content":{"application/json":{"example":{"errors":[{"code":2001,"message":"Rate limit exceeded"}],"success":false},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request","required":true,"schema":{"description":"Number of seconds to wait before retrying the request","example":60,"type":"number"}}}},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get PDF.","tags":["brapi"],"x-api-token-group":["Browser Rendering Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.brapi.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/browser-rendering/scrape":{"post":{"description":"Get meta attributes like height, width, text and others of selected elements.","operationId":"brapi-post_Scrape","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Cache TTL default is 5s. Set to 0 to disable.","in":"query","name":"cacheTTL","schema":{"default":5,"description":"Cache TTL default is 5s. Set to 0 to disable.","maximum":86400,"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"properties":{"actionTimeout":{"description":"The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.","maximum":120000,"type":"number"},"addScriptTag":{"description":"Adds a `\u003cscript\u003e` tag into the page with the desired URL or content.","items":{"properties":{"content":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"addStyleTag":{"description":"Adds a `\u003clink rel=\"stylesheet\"\u003e` tag into the page with the desired URL or a `\u003cstyle type=\"text/css\"\u003e` tag with the content.","items":{"properties":{"content":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"allowRequestPattern":{"description":"Only allow requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"allowResourceTypes":{"description":"Only allow requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"authenticate":{"description":"Provide credentials for HTTP authentication.","properties":{"password":{"minLength":1,"type":"string","x-sensitive":true},"username":{"minLength":1,"type":"string"}},"required":["username","password"],"type":"object"},"bestAttempt":{"description":"Attempt to proceed when 'awaited' events fail or timeout.","type":"boolean"},"cookies":{"description":"Check [options](https://pptr.dev/api/puppeteer.page.setcookie).","items":{"properties":{"domain":{"type":"string"},"expires":{"type":"number"},"httpOnly":{"type":"boolean"},"name":{"type":"string"},"partitionKey":{"type":"string"},"path":{"type":"string"},"priority":{"anyOf":[{"enum":["Low"],"type":"string"},{"enum":["Medium"],"type":"string"},{"enum":["High"],"type":"string"}]},"sameParty":{"type":"boolean"},"sameSite":{"anyOf":[{"enum":["Strict"],"type":"string"},{"enum":["Lax"],"type":"string"},{"enum":["None"],"type":"string"}]},"secure":{"type":"boolean"},"sourcePort":{"type":"number"},"sourceScheme":{"anyOf":[{"enum":["Unset"],"type":"string"},{"enum":["NonSecure"],"type":"string"},{"enum":["Secure"],"type":"string"}]},"url":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"elements":{"items":{"properties":{"selector":{"type":"string"}},"required":["selector"],"type":"object"},"minItems":1,"type":"array"},"emulateMediaType":{"type":"string"},"gotoOptions":{"default":{},"description":"Check [options](https://pptr.dev/api/puppeteer.gotooptions).","properties":{"referer":{"type":"string"},"referrerPolicy":{"type":"string"},"timeout":{"default":30000,"maximum":60000,"type":"number"},"waitUntil":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"},{"items":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"}]},"type":"array"}],"default":"domcontentloaded"}},"type":"object"},"html":{"description":"Set the content of the page, eg: `\u003ch1\u003eHello World!!\u003c/h1\u003e`. Either `html` or `url` must be set.","minLength":1,"type":"string"},"rejectRequestPattern":{"description":"Block undesired requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"rejectResourceTypes":{"description":"Block undesired requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"setExtraHTTPHeaders":{"additionalProperties":{"type":"string"},"type":"object"},"setJavaScriptEnabled":{"type":"boolean"},"url":{"description":"URL to navigate to, eg. `https://example.com`.","format":"uri","type":"string"},"userAgent":{"default":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36","type":"string"},"viewport":{"default":{"height":1080,"width":1920},"description":"Check [options](https://pptr.dev/api/puppeteer.page.setviewport).","properties":{"deviceScaleFactor":{"type":"number"},"hasTouch":{"type":"boolean"},"height":{"type":"number"},"isLandscape":{"type":"boolean"},"isMobile":{"type":"boolean"},"width":{"type":"number"}},"required":["width","height"],"type":"object"},"waitForSelector":{"description":"Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).","properties":{"hidden":{"enum":[true],"type":"boolean"},"selector":{"type":"string"},"timeout":{"maximum":120000,"type":"number"},"visible":{"enum":[true],"type":"boolean"}},"required":["selector"],"type":"object"},"waitForTimeout":{"description":"Waits for a specified timeout before continuing.","maximum":120000,"type":"number"}},"required":["elements"],"type":"object"}]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"result":{"items":{"properties":{"results":{"properties":{"attributes":{"items":{"properties":{"name":{"description":"Attribute name","type":"string"},"value":{"description":"Attribute value","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"height":{"description":"Element height","type":"number"},"html":{"description":"Html content","type":"string"},"left":{"description":"Element left","type":"number"},"text":{"description":"Text content","type":"string"},"top":{"description":"Element top","type":"number"},"width":{"description":"Element width","type":"number"}},"required":["attributes","height","html","left","text","top","width"],"type":"object"},"selector":{"description":"Selector","type":"string"}},"required":["results","selector"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status","result"],"type":"object"}}},"description":"Returns the scraped elements"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"The request contains errors or didn't properly encode content."},"422":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content."},"429":{"content":{"application/json":{"example":{"errors":[{"code":2001,"message":"Rate limit exceeded"}],"success":false},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request","required":true,"schema":{"description":"Number of seconds to wait before retrying the request","example":60,"type":"number"}}}},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Scrape elements.","tags":["brapi"],"x-api-token-group":["Browser Rendering Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.brapi.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/browser-rendering/screenshot":{"post":{"description":"Takes a screenshot of a webpage from provided URL or HTML. Control page loading with `gotoOptions` and `waitFor*` options. Customize screenshots with `viewport`, `fullPage`, `clip` and others.","operationId":"brapi-post_Screenshot","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Cache TTL default is 5s. Set to 0 to disable.","in":"query","name":"cacheTTL","schema":{"default":5,"description":"Cache TTL default is 5s. Set to 0 to disable.","maximum":86400,"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"properties":{"actionTimeout":{"description":"The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.","maximum":120000,"type":"number"},"addScriptTag":{"description":"Adds a `\u003cscript\u003e` tag into the page with the desired URL or content.","items":{"properties":{"content":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"addStyleTag":{"description":"Adds a `\u003clink rel=\"stylesheet\"\u003e` tag into the page with the desired URL or a `\u003cstyle type=\"text/css\"\u003e` tag with the content.","items":{"properties":{"content":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"allowRequestPattern":{"description":"Only allow requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"allowResourceTypes":{"description":"Only allow requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"authenticate":{"description":"Provide credentials for HTTP authentication.","properties":{"password":{"minLength":1,"type":"string","x-sensitive":true},"username":{"minLength":1,"type":"string"}},"required":["username","password"],"type":"object"},"bestAttempt":{"description":"Attempt to proceed when 'awaited' events fail or timeout.","type":"boolean"},"cookies":{"description":"Check [options](https://pptr.dev/api/puppeteer.page.setcookie).","items":{"properties":{"domain":{"type":"string"},"expires":{"type":"number"},"httpOnly":{"type":"boolean"},"name":{"type":"string"},"partitionKey":{"type":"string"},"path":{"type":"string"},"priority":{"anyOf":[{"enum":["Low"],"type":"string"},{"enum":["Medium"],"type":"string"},{"enum":["High"],"type":"string"}]},"sameParty":{"type":"boolean"},"sameSite":{"anyOf":[{"enum":["Strict"],"type":"string"},{"enum":["Lax"],"type":"string"},{"enum":["None"],"type":"string"}]},"secure":{"type":"boolean"},"sourcePort":{"type":"number"},"sourceScheme":{"anyOf":[{"enum":["Unset"],"type":"string"},{"enum":["NonSecure"],"type":"string"},{"enum":["Secure"],"type":"string"}]},"url":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"emulateMediaType":{"type":"string"},"gotoOptions":{"default":{},"description":"Check [options](https://pptr.dev/api/puppeteer.gotooptions).","properties":{"referer":{"type":"string"},"referrerPolicy":{"type":"string"},"timeout":{"default":30000,"maximum":60000,"type":"number"},"waitUntil":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"},{"items":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"}]},"type":"array"}],"default":"domcontentloaded"}},"type":"object"},"html":{"description":"Set the content of the page, eg: `\u003ch1\u003eHello World!!\u003c/h1\u003e`. Either `html` or `url` must be set.","minLength":1,"type":"string"},"rejectRequestPattern":{"description":"Block undesired requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"rejectResourceTypes":{"description":"Block undesired requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"screenshotOptions":{"additionalProperties":false,"default":{},"description":"Check [options](https://pptr.dev/api/puppeteer.screenshotoptions).","properties":{"captureBeyondViewport":{"type":"boolean"},"clip":{"properties":{"height":{"type":"number"},"scale":{"type":"number"},"width":{"type":"number"},"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y","width","height"],"type":"object"},"encoding":{"anyOf":[{"enum":["binary"],"type":"string"},{"enum":["base64"],"type":"string"}],"default":"binary"},"fromSurface":{"type":"boolean"},"fullPage":{"type":"boolean"},"omitBackground":{"type":"boolean"},"optimizeForSpeed":{"type":"boolean"},"quality":{"type":"number"},"type":{"anyOf":[{"enum":["png"],"type":"string"},{"enum":["jpeg"],"type":"string"},{"enum":["webp"],"type":"string"}],"default":"png"}},"type":"object"},"scrollPage":{"type":"boolean"},"selector":{"type":"string"},"setExtraHTTPHeaders":{"additionalProperties":{"type":"string"},"type":"object"},"setJavaScriptEnabled":{"type":"boolean"},"url":{"description":"URL to navigate to, eg. `https://example.com`.","format":"uri","type":"string"},"userAgent":{"default":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36","type":"string"},"viewport":{"default":{"height":1080,"width":1920},"description":"Check [options](https://pptr.dev/api/puppeteer.page.setviewport).","properties":{"deviceScaleFactor":{"type":"number"},"hasTouch":{"type":"boolean"},"height":{"type":"number"},"isLandscape":{"type":"boolean"},"isMobile":{"type":"boolean"},"width":{"type":"number"}},"required":["width","height"],"type":"object"},"waitForSelector":{"description":"Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).","properties":{"hidden":{"enum":[true],"type":"boolean"},"selector":{"type":"string"},"timeout":{"maximum":120000,"type":"number"},"visible":{"enum":[true],"type":"boolean"}},"required":["selector"],"type":"object"},"waitForTimeout":{"description":"Waits for a specified timeout before continuing.","maximum":120000,"type":"number"}},"type":"object"}],"default":{}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}},"image/jpg":{"schema":{"description":"Jpeg binary","type":"string"}},"image/png":{"schema":{"description":"Png binary","type":"string"}},"image/webp":{"schema":{"description":"Webp binary","type":"string"}},"text/plain":{"schema":{"description":"Base64 encoded","type":"string"}}},"description":"Returns the screenshot"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"The request contains errors or didn't properly encode content."},"422":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content."},"429":{"content":{"application/json":{"example":{"errors":[{"code":2001,"message":"Rate limit exceeded"}],"success":false},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request","required":true,"schema":{"description":"Number of seconds to wait before retrying the request","example":60,"type":"number"}}}},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get screenshot.","tags":["brapi"],"x-api-token-group":["Browser Rendering Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.brapi.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/browser-rendering/snapshot":{"post":{"description":"Returns the page's HTML content and screenshot. Control page loading with `gotoOptions` and `waitFor*` options. Customize screenshots with `viewport`, `fullPage`, `clip` and others.","operationId":"brapi-post_Snapshot","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Cache TTL default is 5s. Set to 0 to disable.","in":"query","name":"cacheTTL","schema":{"default":5,"description":"Cache TTL default is 5s. Set to 0 to disable.","maximum":86400,"type":"number"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"additionalProperties":false,"properties":{"actionTimeout":{"description":"The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.","maximum":120000,"type":"number"},"addScriptTag":{"description":"Adds a `\u003cscript\u003e` tag into the page with the desired URL or content.","items":{"properties":{"content":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"addStyleTag":{"description":"Adds a `\u003clink rel=\"stylesheet\"\u003e` tag into the page with the desired URL or a `\u003cstyle type=\"text/css\"\u003e` tag with the content.","items":{"properties":{"content":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"allowRequestPattern":{"description":"Only allow requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"allowResourceTypes":{"description":"Only allow requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"authenticate":{"description":"Provide credentials for HTTP authentication.","properties":{"password":{"minLength":1,"type":"string","x-sensitive":true},"username":{"minLength":1,"type":"string"}},"required":["username","password"],"type":"object"},"bestAttempt":{"description":"Attempt to proceed when 'awaited' events fail or timeout.","type":"boolean"},"cookies":{"description":"Check [options](https://pptr.dev/api/puppeteer.page.setcookie).","items":{"properties":{"domain":{"type":"string"},"expires":{"type":"number"},"httpOnly":{"type":"boolean"},"name":{"type":"string"},"partitionKey":{"type":"string"},"path":{"type":"string"},"priority":{"anyOf":[{"enum":["Low"],"type":"string"},{"enum":["Medium"],"type":"string"},{"enum":["High"],"type":"string"}]},"sameParty":{"type":"boolean"},"sameSite":{"anyOf":[{"enum":["Strict"],"type":"string"},{"enum":["Lax"],"type":"string"},{"enum":["None"],"type":"string"}]},"secure":{"type":"boolean"},"sourcePort":{"type":"number"},"sourceScheme":{"anyOf":[{"enum":["Unset"],"type":"string"},{"enum":["NonSecure"],"type":"string"},{"enum":["Secure"],"type":"string"}]},"url":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"emulateMediaType":{"type":"string"},"gotoOptions":{"default":{},"description":"Check [options](https://pptr.dev/api/puppeteer.gotooptions).","properties":{"referer":{"type":"string"},"referrerPolicy":{"type":"string"},"timeout":{"default":30000,"maximum":60000,"type":"number"},"waitUntil":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"},{"items":{"anyOf":[{"enum":["load"],"type":"string"},{"enum":["domcontentloaded"],"type":"string"},{"enum":["networkidle0"],"type":"string"},{"enum":["networkidle2"],"type":"string"}]},"type":"array"}],"default":"domcontentloaded"}},"type":"object"},"html":{"description":"Set the content of the page, eg: `\u003ch1\u003eHello World!!\u003c/h1\u003e`. Either `html` or `url` must be set.","minLength":1,"type":"string"},"rejectRequestPattern":{"description":"Block undesired requests that match the provided regex patterns, eg. '/^.*\\.(css)'.","items":{"type":"string"},"type":"array"},"rejectResourceTypes":{"description":"Block undesired requests that match the provided resource types, eg. 'image' or 'script'.","items":{"anyOf":[{"enum":["document"],"type":"string"},{"enum":["stylesheet"],"type":"string"},{"enum":["image"],"type":"string"},{"enum":["media"],"type":"string"},{"enum":["font"],"type":"string"},{"enum":["script"],"type":"string"},{"enum":["texttrack"],"type":"string"},{"enum":["xhr"],"type":"string"},{"enum":["fetch"],"type":"string"},{"enum":["prefetch"],"type":"string"},{"enum":["eventsource"],"type":"string"},{"enum":["websocket"],"type":"string"},{"enum":["manifest"],"type":"string"},{"enum":["signedexchange"],"type":"string"},{"enum":["ping"],"type":"string"},{"enum":["cspviolationreport"],"type":"string"},{"enum":["preflight"],"type":"string"},{"enum":["other"],"type":"string"}]},"type":"array"},"screenshotOptions":{"additionalProperties":false,"default":{},"properties":{"captureBeyondViewport":{"type":"boolean"},"clip":{"properties":{"height":{"type":"number"},"scale":{"type":"number"},"width":{"type":"number"},"x":{"type":"number"},"y":{"type":"number"}},"required":["x","y","width","height"],"type":"object"},"fromSurface":{"type":"boolean"},"fullPage":{"type":"boolean"},"omitBackground":{"type":"boolean"},"optimizeForSpeed":{"type":"boolean"},"quality":{"type":"number"},"type":{"anyOf":[{"enum":["png"],"type":"string"},{"enum":["jpeg"],"type":"string"},{"enum":["webp"],"type":"string"}],"default":"png"}},"type":"object"},"setExtraHTTPHeaders":{"additionalProperties":{"type":"string"},"type":"object"},"setJavaScriptEnabled":{"type":"boolean"},"url":{"description":"URL to navigate to, eg. `https://example.com`.","format":"uri","type":"string"},"userAgent":{"default":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36","type":"string"},"viewport":{"default":{"height":1080,"width":1920},"description":"Check [options](https://pptr.dev/api/puppeteer.page.setviewport).","properties":{"deviceScaleFactor":{"type":"number"},"hasTouch":{"type":"boolean"},"height":{"type":"number"},"isLandscape":{"type":"boolean"},"isMobile":{"type":"boolean"},"width":{"type":"number"}},"required":["width","height"],"type":"object"},"waitForSelector":{"description":"Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).","properties":{"hidden":{"enum":[true],"type":"boolean"},"selector":{"type":"string"},"timeout":{"maximum":120000,"type":"number"},"visible":{"enum":[true],"type":"boolean"}},"required":["selector"],"type":"object"},"waitForTimeout":{"description":"Waits for a specified timeout before continuing.","maximum":120000,"type":"number"}},"type":"object"}]}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"meta":{"properties":{"status":{"type":"number"},"title":{"type":"string"}},"type":"object"},"result":{"properties":{"content":{"description":"HTML content","type":"string"},"screenshot":{"description":"Base64 encoded image","type":"string"}},"required":["screenshot","content"],"type":"object"},"status":{"description":"Response status","type":"boolean"}},"required":["status","meta"],"type":"object"}}},"description":"Returns the screenshot"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"The request contains errors or didn't properly encode content."},"422":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to site-related issues such as timeouts, SSL errors, or inaccessible content."},"429":{"content":{"application/json":{"example":{"errors":[{"code":2001,"message":"Rate limit exceeded"}],"success":false},"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Request failed due to rate limiting. The Retry-After header indicates when the client should retry the request.","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request","required":true,"schema":{"description":"Number of seconds to wait before retrying the request","example":60,"type":"number"}}}},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"description":"Error code","type":"number"},"message":{"description":"Error Message","type":"string"}},"required":["message","code"],"type":"object"},"type":"array"},"status":{"description":"Response status","type":"boolean"}},"required":["status"],"type":"object"}}},"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTML content and screenshot.","tags":["brapi"],"x-api-token-group":["Browser Rendering Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.brapi.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/builds/account/limits":{"get":{"description":"Retrieve account limits and usage information","operationId":"getAccountLimits","parameters":[{"$ref":"#/components/parameters/builds_AccountId"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_GetAccountLimitResponse"}},"type":"object"}]}}},"description":"Account limits retrieved successfully"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get account limits","tags":["Account"],"x-api-token-group":["Workers CI Write","Workers CI Read"]}},"/accounts/{account_id}/builds/builds":{"get":{"description":"Retrieve builds for specific version IDs","operationId":"getBuildsByVersionIds","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"description":"Comma-separated list of version UUIDs (max 20)","in":"query","name":"version_ids","required":true,"schema":{"example":"123e4567-e89b-12d3-a456-426614174000,223e4567-e89b-12d3-a456-426614174001","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_BuildsByVersionResponse"}},"type":"object"}]}}},"description":"Builds retrieved successfully"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get builds by version IDs","tags":["Builds"],"x-api-token-group":["Workers CI Write","Workers CI Read"]}},"/accounts/{account_id}/builds/builds/latest":{"get":{"description":"Retrieve the most recent builds for multiple worker scripts","operationId":"getLatestBuildsByScripts","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"description":"Comma-separated list of external script IDs (max 20)","in":"query","name":"external_script_ids","required":true,"schema":{"example":"worker1,worker2,worker3","pattern":"^[\\w]+([,][\\w]+)*$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_LatestBuildsResponse"}},"type":"object"}]}}},"description":"Latest builds retrieved successfully"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get latest builds by script IDs","tags":["Builds"],"x-api-token-group":["Workers CI Write","Workers CI Read"]}},"/accounts/{account_id}/builds/builds/{build_uuid}":{"get":{"description":"Retrieve detailed information about a specific build","operationId":"getBuildByUuid","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"$ref":"#/components/parameters/builds_BuildUuid"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_BuildResponse"}},"type":"object"}]}}},"description":"Build retrieved successfully"},"404":{"$ref":"#/components/responses/builds_NotFound"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get build by UUID","tags":["Builds"],"x-api-token-group":["Workers CI Write","Workers CI Read"]}},"/accounts/{account_id}/builds/builds/{build_uuid}/cancel":{"put":{"description":"Cancel a running or queued build","operationId":"cancelBuildByUuid","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"$ref":"#/components/parameters/builds_BuildUuid"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_CanceledBuildResponse"}},"type":"object"}]}}},"description":"Build canceled successfully"},"404":{"$ref":"#/components/responses/builds_NotFound"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Cancel build","tags":["Builds"],"x-api-token-group":["Workers CI Write"]}},"/accounts/{account_id}/builds/builds/{build_uuid}/logs":{"get":{"description":"Retrieve logs for a specific build with cursor-based pagination","operationId":"getBuildLogs","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"$ref":"#/components/parameters/builds_BuildUuid"},{"description":"Pagination cursor for log retrieval","in":"query","name":"cursor","schema":{"example":"eyJsaW5lIjoxMDAsInRpbWVzdGFtcCI6MTYzNjQ3MjQwMH0","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_BuildLogsResponse"}},"type":"object"}]}}},"description":"Build logs retrieved successfully"},"404":{"$ref":"#/components/responses/builds_NotFound"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get build logs","tags":["Builds"],"x-api-token-group":["Workers CI Write","Workers CI Read"]}},"/accounts/{account_id}/builds/repos/connections":{"put":{"description":"Upsert a repository connection for CI/CD integration","operationId":"upsertRepoConnection","parameters":[{"$ref":"#/components/parameters/builds_AccountId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/builds_UpsertRepoConnectionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_UpsertRepoConnectionResponse"}},"type":"object"}]}}},"description":"Repository connection upserted successfully"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create or update repository connection","tags":["Repository Connections"],"x-api-token-group":["Workers CI Write"]}},"/accounts/{account_id}/builds/repos/connections/{repo_connection_uuid}":{"delete":{"description":"Remove a repository connection","operationId":"deleteRepoConnection","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"$ref":"#/components/parameters/builds_RepoConnectionUuid"}],"responses":{"200":{"$ref":"#/components/responses/builds_SuccessEmpty"},"404":{"$ref":"#/components/responses/builds_NotFound"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete repository connection","tags":["Repository Connections"],"x-api-token-group":["Workers CI Write"]}},"/accounts/{account_id}/builds/repos/{provider_type}/{provider_account_id}/{repo_id}/config_autofill":{"get":{"description":"Analyze repository for automatic configuration detection","operationId":"getWorkerConfigAutofill","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"description":"SCM provider type","in":"path","name":"provider_type","required":true,"schema":{"$ref":"#/components/schemas/builds_SCMProviderType"}},{"description":"Provider account identifier","in":"path","name":"provider_account_id","required":true,"schema":{"example":"cloudflare","type":"string"}},{"description":"Repository identifier","in":"path","name":"repo_id","required":true,"schema":{"example":"workers-sdk","type":"string"}},{"description":"Git branch to analyze","in":"query","name":"branch","required":true,"schema":{"example":"main","type":"string"}},{"description":"Root directory path","in":"query","name":"root_directory","schema":{"example":"/","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_ConfigAutofillResponse"}},"type":"object"}]}}},"description":"Configuration autofill data retrieved successfully"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get repository configuration autofill","tags":["GitHub Integration"],"x-api-token-group":["Workers CI Write","Workers CI Read"]}},"/accounts/{account_id}/builds/tokens":{"get":{"description":"Get all build tokens with pagination","operationId":"listBuildTokens","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"$ref":"#/components/parameters/builds_Page"},{"$ref":"#/components/parameters/builds_PerPage"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/builds_ListTokensResponse"},"type":"array"},"result_info":{"$ref":"#/components/schemas/builds_PaginationInfo"}},"type":"object"}]}}},"description":"Build tokens retrieved successfully"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List build tokens","tags":["Build Tokens"],"x-api-token-group":["Workers CI Write","Workers CI Read"]},"post":{"description":"Create a new build authentication token","operationId":"createBuildToken","parameters":[{"$ref":"#/components/parameters/builds_AccountId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/builds_CreateBuildTokenRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_CreateBuildTokenResponse"}},"type":"object"}]}}},"description":"Build token created successfully"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create build token","tags":["Build Tokens"],"x-api-token-group":["Workers CI Write"]}},"/accounts/{account_id}/builds/tokens/{build_token_uuid}":{"delete":{"description":"Remove a build authentication token","operationId":"deleteBuildToken","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"description":"Build token UUID","in":"path","name":"build_token_uuid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/builds_SuccessEmpty"},"404":{"$ref":"#/components/responses/builds_NotFound"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete build token","tags":["Build Tokens"],"x-api-token-group":["Workers CI Write"]}},"/accounts/{account_id}/builds/triggers":{"post":{"description":"Create a new CI/CD trigger","operationId":"createTrigger","parameters":[{"$ref":"#/components/parameters/builds_AccountId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/builds_CreateTriggerRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_TriggerResponse"}},"type":"object"}]}}},"description":"Trigger created successfully"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create trigger","tags":["Triggers"],"x-api-token-group":["Workers CI Write"]}},"/accounts/{account_id}/builds/triggers/{trigger_uuid}":{"delete":{"description":"Remove a CI/CD trigger","operationId":"deleteTrigger","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"$ref":"#/components/parameters/builds_TriggerUuid"}],"responses":{"200":{"$ref":"#/components/responses/builds_SuccessEmpty"},"404":{"$ref":"#/components/responses/builds_NotFound"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete trigger","tags":["Triggers"],"x-api-token-group":["Workers CI Write"]},"patch":{"description":"Update an existing CI/CD trigger","operationId":"updateTrigger","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"$ref":"#/components/parameters/builds_TriggerUuid"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/builds_UpdateTriggerRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_TriggerResponse"}},"type":"object"}]}}},"description":"Trigger updated successfully"},"404":{"$ref":"#/components/responses/builds_NotFound"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update trigger","tags":["Triggers"],"x-api-token-group":["Workers CI Write"]}},"/accounts/{account_id}/builds/triggers/{trigger_uuid}/builds":{"post":{"description":"Trigger a manual build for a specific trigger","operationId":"createManualBuild","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"$ref":"#/components/parameters/builds_TriggerUuid"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/builds_CreateBuildRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_InsertBuildResponse"}},"type":"object"}]}}},"description":"Build created successfully"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create manual build","tags":["Triggers"],"x-api-token-group":["Workers CI Write"]}},"/accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables":{"get":{"description":"Get all environment variables for a trigger","operationId":"listEnvironmentVariables","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"$ref":"#/components/parameters/builds_TriggerUuid"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_EnvironmentVariablesResponse"}},"type":"object"}]}}},"description":"Environment variables retrieved successfully"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List environment variables","tags":["Environment Variables"],"x-api-token-group":["Workers CI Write","Workers CI Read"]},"patch":{"description":"Create or update environment variables for a trigger","operationId":"upsertEnvironmentVariables","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"$ref":"#/components/parameters/builds_TriggerUuid"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/builds_EnvironmentVariablesRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"$ref":"#/components/schemas/builds_EnvironmentVariablesResponse"}},"type":"object"}]}}},"description":"Environment variables updated successfully"},"404":{"$ref":"#/components/responses/builds_NotFound"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Upsert environment variables","tags":["Environment Variables"],"x-api-token-group":["Workers CI Write"]}},"/accounts/{account_id}/builds/triggers/{trigger_uuid}/environment_variables/{environment_variable_key}":{"delete":{"description":"Remove a specific environment variable from a trigger","operationId":"deleteEnvironmentVariable","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"$ref":"#/components/parameters/builds_TriggerUuid"},{"description":"Environment variable key","in":"path","name":"environment_variable_key","required":true,"schema":{"example":"NODE_ENV","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/builds_SuccessEmpty"},"404":{"$ref":"#/components/responses/builds_NotFound"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete environment variable","tags":["Environment Variables"],"x-api-token-group":["Workers CI Write"]}},"/accounts/{account_id}/builds/triggers/{trigger_uuid}/purge_build_cache":{"post":{"description":"Clear the build cache for a specific trigger","operationId":"purgeBuildCache","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"$ref":"#/components/parameters/builds_TriggerUuid"}],"responses":{"200":{"$ref":"#/components/responses/builds_SuccessEmpty"},"404":{"$ref":"#/components/responses/builds_NotFound"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Purge build cache","tags":["Triggers"],"x-api-token-group":["Workers CI Write"]}},"/accounts/{account_id}/builds/workers/{external_script_id}/builds":{"get":{"description":"Get all builds for a specific worker script with pagination","operationId":"listBuildsByScript","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"description":"External script identifier","in":"path","name":"external_script_id","required":true,"schema":{"example":"my-worker","type":"string"}},{"$ref":"#/components/parameters/builds_Page"},{"$ref":"#/components/parameters/builds_PerPage"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/builds_BuildResponse"},"type":"array"},"result_info":{"$ref":"#/components/schemas/builds_PaginationInfo"}},"type":"object"}]}}},"description":"Builds retrieved successfully"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List builds by script","tags":["Workers"],"x-api-token-group":["Workers CI Write","Workers CI Read"]}},"/accounts/{account_id}/builds/workers/{external_script_id}/triggers":{"get":{"description":"Get all triggers for a specific worker script","operationId":"listTriggersByScript","parameters":[{"$ref":"#/components/parameters/builds_AccountId"},{"description":"External script identifier","in":"path","name":"external_script_id","required":true,"schema":{"example":"my-worker","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/builds_APIResponse"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/builds_TriggerResponse"},"type":"array"}},"type":"object"}]}}},"description":"Triggers retrieved successfully"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List triggers by script","tags":["Workers"],"x-api-token-group":["Workers CI Write","Workers CI Read"]}},"/accounts/{account_id}/calls/apps":{"get":{"description":"Lists all apps in the Cloudflare account","operationId":"calls-apps-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/calls_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_app_response_collection"}}},"description":"List apps response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_api-response-common-failure"}}},"description":"List apps response failure"}},"security":[{"api_token":[]}],"summary":"List apps","tags":["Calls Apps"],"x-api-token-group":["Calls Write","Calls Read"]},"post":{"description":"Creates a new Cloudflare calls app. An app is an unique enviroment where each Session can access all Tracks within the app.","operationId":"calls-apps-create-a-new-app","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/calls_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_app_editable_fields"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_app_response_single_with_secret"}}},"description":"Created a new app"}},"security":[{"api_token":[]}],"summary":"Create a new app","tags":["Calls Apps"],"x-api-token-group":["Calls Write"]}},"/accounts/{account_id}/calls/apps/{app_id}":{"delete":{"description":"Deletes an app from Cloudflare Calls","operationId":"calls-apps-delete-app","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/calls_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/calls_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_app_response_single"}}},"description":"Delete app response"},"4XX":{"content":{"application/json":{}},"description":"Delete app response failure"}},"security":[{"api_token":[]}],"summary":"Delete app","tags":["Calls Apps"],"x-api-token-group":["Calls Write"]},"get":{"description":"Fetches details for a single Calls app.","operationId":"calls-apps-retrieve-app-details","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/calls_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/calls_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_app_response_single"}}},"description":"Retrieve app details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_api-response-common-failure"}}},"description":"Retrieve app details response failure"}},"security":[{"api_token":[]}],"summary":"Retrieve app details","tags":["Calls Apps"],"x-api-token-group":["Calls Write","Calls Read"]},"put":{"description":"Edit details for a single app.","operationId":"calls-apps-update-app-details","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/calls_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/calls_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_app_editable_fields"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_app_response_single"}}},"description":"Edit app details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_api-response-common-failure"}}},"description":"Edit app details response failure"}},"security":[{"api_token":[]}],"summary":"Edit app details","tags":["Calls Apps"],"x-api-token-group":["Calls Write"]}},"/accounts/{account_id}/calls/turn_keys":{"get":{"description":"Lists all TURN keys in the Cloudflare account","operationId":"calls-turn-key-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/calls_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_turn_key_collection"}}},"description":"List TURN key response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_api-response-common-failure"}}},"description":"List TURN key response failure"}},"security":[{"api_token":[]}],"summary":"List TURN Keys","tags":["Calls TURN Keys"],"x-api-token-group":["Calls Write","Calls Read"]},"post":{"description":"Creates a new Cloudflare Calls TURN key.","operationId":"calls-turn-key-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/calls_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_turn_key_editable_fields"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_turn_key_single_with_secret"}}},"description":"Created a new TURN key"}},"security":[{"api_token":[]}],"summary":"Create a new TURN key","tags":["Calls TURN Keys"],"x-api-token-group":["Calls Write"]}},"/accounts/{account_id}/calls/turn_keys/{key_id}":{"delete":{"description":"Deletes a TURN key from Cloudflare Calls","operationId":"calls-delete-turn-key","parameters":[{"in":"path","name":"key_id","required":true,"schema":{"$ref":"#/components/schemas/calls_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/calls_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_turn_key_response_single"}}},"description":"Delete TURN key response"},"4XX":{"content":{"application/json":{}},"description":"Delete TURN key response failure"}},"security":[{"api_token":[]}],"summary":"Delete TURN key","tags":["Calls TURN Keys"],"x-api-token-group":["Calls Write"]},"get":{"description":"Fetches details for a single TURN key.","operationId":"calls-retrieve-turn-key-details","parameters":[{"in":"path","name":"key_id","required":true,"schema":{"$ref":"#/components/schemas/calls_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/calls_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_turn_key_response_single"}}},"description":"Retrieve TURN key details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_api-response-common-failure"}}},"description":"Retrieve TURN key details failure"}},"security":[{"api_token":[]}],"summary":"Retrieve TURN key details","tags":["Calls TURN Keys"],"x-api-token-group":["Calls Write","Calls Read"]},"put":{"description":"Edit details for a single TURN key.","operationId":"calls-update-turn-key","parameters":[{"in":"path","name":"key_id","required":true,"schema":{"$ref":"#/components/schemas/calls_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/calls_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_turn_key_editable_fields"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_turn_key_response_single"}}},"description":"Edit TURN key details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calls_api-response-common-failure"}}},"description":"Edit TURN key details response failure"}},"security":[{"api_token":[]}],"summary":"Edit TURN key details","tags":["Calls TURN Keys"],"x-api-token-group":["Calls Write"]}},"/accounts/{account_id}/cfd_tunnel":{"get":{"description":"Lists and filters Cloudflare Tunnels in an account.","operationId":"cloudflare-tunnel-list-cloudflare-tunnels","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"query","name":"name","schema":{"$ref":"#/components/schemas/tunnel_tunnel_name"}},{"in":"query","name":"is_deleted","schema":{"description":"If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.","example":true,"type":"boolean"}},{"in":"query","name":"existed_at","schema":{"$ref":"#/components/schemas/tunnel_existed_at"}},{"in":"query","name":"uuid","schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}},{"in":"query","name":"was_active_at","schema":{"example":"2009-11-10T23:00:00Z","format":"date-time","type":"string"}},{"in":"query","name":"was_inactive_at","schema":{"example":"2009-11-10T23:00:00Z","format":"date-time","type":"string"}},{"in":"query","name":"include_prefix","schema":{"example":"vpc1-","type":"string"}},{"in":"query","name":"exclude_prefix","schema":{"example":"vpc1-","type":"string"}},{"in":"query","name":"status","schema":{"$ref":"#/components/schemas/tunnel_status"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/tunnel_per_page"}},{"in":"query","name":"page","schema":{"$ref":"#/components/schemas/tunnel_page_number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_cfd-tunnel-response-collection"}}},"description":"List Cloudflare Tunnels response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_cfd-tunnel-response-collection"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"List Cloudflare Tunnels response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List Cloudflare Tunnels","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connectors Read","Cloudflare One Connector: cloudflared Write","Cloudflare One Connector: cloudflared Read","Cloudflare Tunnel Write","Cloudflare Tunnel Read"]},"post":{"description":"Creates a new Cloudflare Tunnel in an account.","operationId":"cloudflare-tunnel-create-a-cloudflare-tunnel","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config_src":{"$ref":"#/components/schemas/tunnel_config_src"},"name":{"$ref":"#/components/schemas/tunnel_tunnel_name"},"tunnel_secret":{"$ref":"#/components/schemas/tunnel_tunnel_secret"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_cfd-tunnel-response-single"}}},"description":"Create a Cloudflare Tunnel response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_cfd-tunnel-response-single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Create a Cloudflare Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Create a Cloudflare Tunnel","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connector: cloudflared Write","Cloudflare Tunnel Write"]}},"/accounts/{account_id}/cfd_tunnel/{tunnel_id}":{"delete":{"description":"Deletes a Cloudflare Tunnel from an account.","operationId":"cloudflare-tunnel-delete-a-cloudflare-tunnel","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_cfd-tunnel-response-single"}}},"description":"Delete a Cloudflare Tunnel response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_cfd-tunnel-response-single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Delete a Cloudflare Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Delete a Cloudflare Tunnel","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connector: cloudflared Write","Cloudflare Tunnel Write"]},"get":{"description":"Fetches a single Cloudflare Tunnel.","operationId":"cloudflare-tunnel-get-a-cloudflare-tunnel","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_cfd-tunnel-response-single"}}},"description":"Get a Cloudflare Tunnel response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_cfd-tunnel-response-single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Get a Cloudflare Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get a Cloudflare Tunnel","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connectors Read","Cloudflare One Connector: cloudflared Write","Cloudflare One Connector: cloudflared Read","Cloudflare Tunnel Write","Cloudflare Tunnel Read"]},"patch":{"description":"Updates an existing Cloudflare Tunnel.","operationId":"cloudflare-tunnel-update-a-cloudflare-tunnel","parameters":[{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/tunnel_tunnel_name"},"tunnel_secret":{"$ref":"#/components/schemas/tunnel_tunnel_secret"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_cfd-tunnel-response-single"}}},"description":"Update a Cloudflare Tunnel response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_cfd-tunnel-response-single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Update a Cloudflare Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Update a Cloudflare Tunnel","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connector: cloudflared Write","Cloudflare Tunnel Write"]}},"/accounts/{account_id}/cfd_tunnel/{tunnel_id}/configurations":{"get":{"description":"Gets the configuration for a remotely-managed tunnel","operationId":"cloudflare-tunnel-configuration-get-configuration","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_identifier"}},{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_schemas-tunnel_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_configuration_response"}}},"description":"Get configuration response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_schemas-api-response-common-failure"}}},"description":"Get configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get configuration","tags":["Cloudflare Tunnel Configuration"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connectors Read","Cloudflare One Connector: cloudflared Write","Cloudflare One Connector: cloudflared Read","Cloudflare Tunnel Write","Cloudflare Tunnel Read"]},"put":{"description":"Adds or updates the configuration for a remotely-managed tunnel.","operationId":"cloudflare-tunnel-configuration-put-configuration","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_identifier"}},{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_schemas-tunnel_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config":{"$ref":"#/components/schemas/tunnel_config"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_configuration_response"}}},"description":"Put configuration response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_schemas-api-response-common-failure"}}},"description":"Put configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Put configuration","tags":["Cloudflare Tunnel Configuration"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connector: cloudflared Write","Cloudflare Tunnel Write"]}},"/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections":{"delete":{"description":"Removes a connection (aka Cloudflare Tunnel Connector) from a Cloudflare Tunnel independently of its current state. If no connector id (client_id) is provided all connectors will be removed. We recommend running this command after rotating tokens.","operationId":"cloudflare-tunnel-clean-up-cloudflare-tunnel-connections","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}},{"in":"query","name":"client_id","schema":{"$ref":"#/components/schemas/tunnel_client_id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_empty_response"}}},"description":"Clean up Cloudflare Tunnel connections response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_empty_response"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Clean up Cloudflare Tunnel connections response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Clean up Cloudflare Tunnel connections","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connector: cloudflared Write","Cloudflare Tunnel Write"]},"get":{"description":"Fetches connection details for a Cloudflare Tunnel.","operationId":"cloudflare-tunnel-list-cloudflare-tunnel-connections","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_tunnel_connections_response"}}},"description":"List Cloudflare Tunnel connections response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_tunnel_connections_response"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"List Cloudflare Tunnel connections response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List Cloudflare Tunnel connections","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connectors Read","Cloudflare One Connector: cloudflared Write","Cloudflare One Connector: cloudflared Read","Cloudflare Tunnel Write","Cloudflare Tunnel Read"]}},"/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connectors/{connector_id}":{"get":{"description":"Fetches connector and connection details for a Cloudflare Tunnel.","operationId":"cloudflare-tunnel-get-cloudflare-tunnel-connector","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}},{"in":"path","name":"connector_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_client_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_tunnel_client_response"}}},"description":"Get Cloudflare Tunnel connector response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_tunnel_client_response"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Get Cloudflare Tunnel connector response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get Cloudflare Tunnel connector","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connectors Read","Cloudflare One Connector: cloudflared Write","Cloudflare One Connector: cloudflared Read","Cloudflare Tunnel Write","Cloudflare Tunnel Read"]}},"/accounts/{account_id}/cfd_tunnel/{tunnel_id}/management":{"post":{"description":"Gets a management token used to access the management resources (i.e. Streaming Logs) of a tunnel.","operationId":"cloudflare-tunnel-get-a-cloudflare-tunnel-management-token","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"resources":{"items":{"$ref":"#/components/schemas/tunnel_management-resources"},"type":"array"}},"required":["resources"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_tunnel_response_token"}}},"description":"Get a Cloudflare Tunnel management token response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_tunnel_response_token"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Cloudflare API response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get a Cloudflare Tunnel management token","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connector: cloudflared Write","Cloudflare Tunnel Write"]}},"/accounts/{account_id}/cfd_tunnel/{tunnel_id}/token":{"get":{"description":"Gets the token used to associate cloudflared with a specific tunnel.","operationId":"cloudflare-tunnel-get-a-cloudflare-tunnel-token","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_tunnel_response_token"}}},"description":"Get a Cloudflare Tunnel token response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_tunnel_response_token"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Get a Cloudflare Tunnel token response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get a Cloudflare Tunnel token","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connector: cloudflared Write","Cloudflare Tunnel Write"]}},"/accounts/{account_id}/challenges/widgets":{"get":{"description":"Lists all turnstile widgets of an account.","operationId":"accounts-turnstile-widgets-list","responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/turnstile_api-response-common"},{"properties":{"result_info":{"$ref":"#/components/schemas/turnstile_result_info"}},"type":"object"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/turnstile_widget_list"},"type":"array"}},"type":"object"}],"type":"object"}}},"description":"List Turnstile Widgets"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/turnstile_api-response-common-failure"}}},"description":"List Turnstile Widgets Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Turnstile Widgets","tags":["Turnstile"],"x-api-token-group":["Turnstile Sites Write","Turnstile Sites Read","Account Settings Write","Account Settings Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/turnstile_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":25,"description":"Number of items per page.","maximum":1000,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Field to order widgets by.","enum":["id","sitekey","name","created_on","modified_on"],"example":"id","type":"string"}},{"in":"query","name":"direction","schema":{"description":"Direction to order widgets.","enum":["asc","desc"],"example":"asc","type":"string"}}],"post":{"description":"Lists challenge widgets.","operationId":"accounts-turnstile-widget-create","requestBody":{"content":{"application/json":{"schema":{"properties":{"bot_fight_mode":{"$ref":"#/components/schemas/turnstile_bot_fight_mode"},"clearance_level":{"$ref":"#/components/schemas/turnstile_clearance_level"},"domains":{"$ref":"#/components/schemas/turnstile_domains"},"ephemeral_id":{"$ref":"#/components/schemas/turnstile_ephemeral_id"},"mode":{"$ref":"#/components/schemas/turnstile_widget_mode"},"name":{"$ref":"#/components/schemas/turnstile_name"},"offlabel":{"$ref":"#/components/schemas/turnstile_offlabel"},"region":{"$ref":"#/components/schemas/turnstile_region"}},"required":["name","mode","domains"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/turnstile_api-response-common"},{"properties":{"result_info":{"$ref":"#/components/schemas/turnstile_result_info"}},"type":"object"},{"properties":{"result":{"$ref":"#/components/schemas/turnstile_widget_detail"}},"type":"object"}],"type":"object"}}},"description":"Create Turnstile Widget Response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/turnstile_api-response-common-failure"}}},"description":"Create Turnstile Widget Response Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a Turnstile Widget","tags":["Turnstile"],"x-api-token-group":["Turnstile Sites Write","Account Settings Write"]}},"/accounts/{account_id}/challenges/widgets/{sitekey}":{"delete":{"description":"Destroy a Turnstile Widget.","operationId":"accounts-turnstile-widget-delete","responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/turnstile_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/turnstile_widget_detail"}},"type":"object"}],"type":"object"}}},"description":"Delete Turnstile Widget Response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/turnstile_api-response-common-failure"}}},"description":"Delete Turnstile Widget Response Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a Turnstile Widget","tags":["Turnstile"],"x-api-token-group":["Turnstile Sites Write","Account Settings Write"]},"get":{"description":"Show a single challenge widget configuration.","operationId":"accounts-turnstile-widget-get","responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/turnstile_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/turnstile_widget_detail"}},"type":"object"}],"type":"object"}}},"description":"Turnstile Widget Details Response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/turnstile_api-response-common-failure"}}},"description":"Turnstile Widget Details Response Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Turnstile Widget Details","tags":["Turnstile"],"x-api-token-group":["Turnstile Sites Write","Turnstile Sites Read","Account Settings Write","Account Settings Read"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/turnstile_identifier"}},{"in":"path","name":"sitekey","required":true,"schema":{"$ref":"#/components/schemas/turnstile_sitekey"}}],"put":{"description":"Update the configuration of a widget.","operationId":"accounts-turnstile-widget-update","requestBody":{"content":{"application/json":{"schema":{"properties":{"bot_fight_mode":{"$ref":"#/components/schemas/turnstile_bot_fight_mode"},"clearance_level":{"$ref":"#/components/schemas/turnstile_clearance_level"},"domains":{"$ref":"#/components/schemas/turnstile_domains"},"ephemeral_id":{"$ref":"#/components/schemas/turnstile_ephemeral_id"},"mode":{"$ref":"#/components/schemas/turnstile_widget_mode"},"name":{"$ref":"#/components/schemas/turnstile_name"},"offlabel":{"$ref":"#/components/schemas/turnstile_offlabel"},"region":{"$ref":"#/components/schemas/turnstile_region"}},"required":["name","mode","domains"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/turnstile_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/turnstile_widget_detail"}},"type":"object"}],"type":"object"}}},"description":"Update Turnstile Widget Response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/turnstile_api-response-common-failure"}}},"description":"Update Turnstile Widget Response Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update a Turnstile Widget","tags":["Turnstile"],"x-api-token-group":["Turnstile Sites Write","Account Settings Write"]}},"/accounts/{account_id}/challenges/widgets/{sitekey}/rotate_secret":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/turnstile_identifier"}},{"in":"path","name":"sitekey","required":true,"schema":{"$ref":"#/components/schemas/turnstile_sitekey"}}],"post":{"description":"Generate a new secret key for this widget. If `invalidate_immediately`\nis set to `false`, the previous secret remains valid for 2 hours.\n\nNote that secrets cannot be rotated again during the grace period.\n","operationId":"accounts-turnstile-widget-rotate-secret","requestBody":{"content":{"application/json":{"schema":{"properties":{"invalidate_immediately":{"$ref":"#/components/schemas/turnstile_invalidate_immediately"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/turnstile_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/turnstile_widget_detail"}},"type":"object"}],"type":"object"}}},"description":"Rotate Secret Response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/turnstile_api-response-common-failure"}}},"description":"Rotate Secret Response Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Rotate Secret for a Turnstile Widget","tags":["Turnstile"],"x-api-token-group":["Turnstile Sites Write","Account Settings Write"]}},"/accounts/{account_id}/cloudforce-one/binary":{"post":{"operationId":"post_BinDBPost","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"number"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"The binary file content to upload.","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"description":"Binary file to be uploaded to the database.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"content_type":{"example":"text/plain","type":"string"},"md5":{"example":"5d84ade76d2a8387c81175bb0cbe6492","type":"string"},"sha1":{"example":"9aff6879626d957eafadda044e4f879aae1e7278","type":"string"},"sha256":{"example":"0000a7f2692ef479e2e3d02661568882cadec451cc8a64d4e7faca29810cd626","type":"string"}},"required":["md5","sha1","sha256","content_type"],"type":"object"}}},"description":"Returns file information"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Posts a file to Binary Storage","tags":["BinDB"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/binary/{hash}":{"get":{"operationId":"get_BinDBGetBinary","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"number"}},{"description":"hash of the binary","in":"path","name":"hash","required":true,"schema":{"description":"hash of the binary","type":"string"}}],"responses":{"200":{"description":"Returns file information"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Retrieves a file from Binary Storage","tags":["BinDB"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events":{"get":{"description":"When `datasetId` is unspecified, events will be listed from the `Cloudforce One Threat Events` dataset. To list existing datasets (and their IDs), use the [`List Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/) endpoint). Also, must provide query parameters.","operationId":"get_EventListGet","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"in":"query","name":"search","schema":{"default":[],"items":{"properties":{"field":{"example":"attackerCountry","type":"string"},"op":{"enum":["equals","not","gt","gte","lt","lte","like","contains","startsWith","endsWith","in","find"],"example":"equals","type":"string"},"value":{"anyOf":[{"example":"usa","type":"string"},{"example":1,"type":"number"},{"items":{"anyOf":[{"type":"string"},{"type":"number"}]},"type":"array"}]}},"type":"object"},"type":"array"}},{"in":"query","name":"page","schema":{"type":"number"}},{"in":"query","name":"pageSize","schema":{"type":"number"}},{"in":"query","name":"orderBy","schema":{"type":"string"}},{"in":"query","name":"order","schema":{"enum":["asc","desc"],"type":"string"}},{"in":"query","name":"datasetId","schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"forceRefresh","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"attacker":{"example":"Flying Yeti","type":"string"},"attackerCountry":{"example":"CN","type":"string"},"category":{"example":"Domain Resolution","type":"string"},"date":{"example":"2022-04-01T00:00:00Z","type":"string"},"event":{"example":"An attacker registered the domain domain.com","type":"string"},"hasChildren":{"type":"boolean"},"indicator":{"example":"domain.com","type":"string"},"indicatorType":{"example":"domain","type":"string"},"indicatorTypeId":{"example":5,"type":"number"},"insight":{"type":"string"},"killChain":{"type":"number"},"mitreAttack":{"items":{"example":" ","type":"string"},"type":"array"},"numReferenced":{"type":"number"},"numReferences":{"type":"number"},"rawId":{"example":"453gw34w3","type":"string"},"referenced":{"items":{"example":" ","type":"string"},"type":"array"},"referencedIds":{"items":{"type":"number"},"type":"array"},"references":{"items":{"example":" ","type":"string"},"type":"array"},"referencesIds":{"items":{"type":"number"},"type":"array"},"releasabilityId":{"type":"string"},"tags":{"items":{"example":"malware","type":"string"},"type":"array"},"targetCountry":{"example":"US","type":"string"},"targetIndustry":{"example":"Agriculture","type":"string"},"tlp":{"example":"amber","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","date","targetCountry","attacker","attackerCountry","targetIndustry","rawId","indicatorTypeId","indicator","event","numReferenced","numReferences","tlp","category","indicatorType","referenced","references","tags","killChain","mitreAttack","referencedIds","referencesIds","hasChildren"],"type":"object"},"type":"array"}}},"description":"Returns a list of events."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Filter and list events","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/aggregate":{"get":{"description":"Aggregate threat events by one or more columns (e.g., attacker, targetIndustry) with optional date filtering and daily grouping. Supports multi-dimensional aggregation for cross-analysis.","operationId":"get_EventAggregate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Column(s) to aggregate by - single column or comma-separated list (e.g., 'attacker', 'targetIndustry', 'attacker,targetIndustry')","in":"query","name":"aggregateBy","required":true,"schema":{"description":"Column(s) to aggregate by - single column or comma-separated list (e.g., 'attacker', 'targetIndustry', 'attacker,targetIndustry')","type":"string"}},{"description":"Dataset ID(s) to filter by. Can be a single dataset ID or array of dataset IDs. If not provided, uses default dataset","in":"query","name":"datasetId","schema":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}],"description":"Dataset ID(s) to filter by. Can be a single dataset ID or array of dataset IDs. If not provided, uses default dataset"}},{"description":"Start date for filtering (ISO 8601 format, e.g., '2024-01-01')","in":"query","name":"startDate","schema":{"description":"Start date for filtering (ISO 8601 format, e.g., '2024-01-01')","type":"string"}},{"description":"End date for filtering (ISO 8601 format, e.g., '2024-12-31')","in":"query","name":"endDate","schema":{"description":"End date for filtering (ISO 8601 format, e.g., '2024-12-31')","type":"string"}},{"description":"Whether to group results by date (daily aggregation)","in":"query","name":"groupByDate","schema":{"description":"Whether to group results by date (daily aggregation)","type":"boolean"}},{"description":"Maximum number of results to return","in":"query","name":"limit","schema":{"default":100,"description":"Maximum number of results to return","type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"aggregateBy":{"description":"Column(s) that were aggregated by","type":"string"},"aggregations":{"description":"Array of aggregation results with dynamic fields based on aggregateBy columns","items":{"allOf":[{"additionalProperties":{"nullable":true,"type":"string"},"type":"object"},{"properties":{"count":{"description":"Number of events for this aggregation","type":"number"},"date":{"description":"Date (if groupByDate is true)","type":"string"}},"required":["count"],"type":"object"}]},"type":"array"},"dateRange":{"description":"Date range used for filtering","properties":{"endDate":{"type":"string"},"startDate":{"type":"string"}},"type":"object"},"total":{"description":"Total number of events in the aggregation","type":"number"}},"required":["aggregations","total","aggregateBy"],"type":"object"}}},"description":"Returns aggregated event data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Aggregate events by single or multiple columns with optional date filtering","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/attackers":{"get":{"operationId":"get_AttackerList","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Array of dataset IDs to query attackers from. If not provided, uses the default dataset.","in":"query","name":"datasetIds","schema":{"description":"Array of dataset IDs to query attackers from. If not provided, uses the default dataset.","items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"}}},"description":"Returns a list of attackers."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Lists attackers across multiple datasets","tags":["Attacker"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/categories":{"get":{"operationId":"get_CategoryList","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Array of dataset IDs to query categories from. If not provided, uses the default dataset.","in":"query","name":"datasetIds","schema":{"description":"Array of dataset IDs to query categories from. If not provided, uses the default dataset.","items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"killChain":{"type":"number"},"mitreAttack":{"items":{"example":"T1234","type":"string"},"type":"array"},"name":{"example":"name","type":"string"},"shortname":{"example":"shortname","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name","killChain"],"type":"object"},"type":"array"}}},"description":"Returns a list of categories."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Lists categories across multiple datasets","tags":["Category"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/categories/catalog":{"get":{"operationId":"get_CategoryListComplete","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"killChain":{"type":"number"},"mitreAttack":{"items":{"example":"T1234","type":"string"},"type":"array"},"name":{"example":"name","type":"string"},"shortname":{"example":"shortname","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name","killChain"],"type":"object"},"type":"array"}}},"description":"Returns a list of categories."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Lists categories","tags":["Category"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/categories/create":{"post":{"operationId":"post_CategoryCreate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"killChain":{"type":"number"},"mitreAttack":{"items":{"example":"T1234","type":"string"},"type":"array"},"name":{"example":"name","type":"string"},"shortname":{"example":"shortname","type":"string"}},"required":["name","killChain"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"killChain":{"type":"number"},"mitreAttack":{"items":{"example":"T1234","type":"string"},"type":"array"},"name":{"example":"name","type":"string"},"shortname":{"example":"shortname","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name","killChain"],"type":"object"}}},"description":"Returns the created category."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Creates a new category","tags":["Category"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/categories/{category_id}":{"delete":{"operationId":"delete_CategoryDelete","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Category UUID.","in":"path","name":"category_id","required":true,"schema":{"description":"Category UUID.","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid"],"type":"object"}}},"description":"Returns the uuid of the deleted category."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Deletes a category","tags":["Category"],"x-api-token-group":["Cloudforce One Write"]},"get":{"operationId":"get_CategoryRead","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Category UUID.","in":"path","name":"category_id","required":true,"schema":{"description":"Category UUID.","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"killChain":{"type":"number"},"mitreAttack":{"items":{"example":"T1234","type":"string"},"type":"array"},"name":{"example":"name","type":"string"},"shortname":{"example":"shortname","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name","killChain"],"type":"object"}}},"description":"Returns a category."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Reads a category","tags":["Category"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]},"patch":{"operationId":"patch_CategoryUpdate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Category UUID.","in":"path","name":"category_id","required":true,"schema":{"description":"Category UUID.","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"killChain":{"type":"number"},"mitreAttack":{"items":{"example":"T1234","type":"string"},"type":"array"},"name":{"example":"name","type":"string"},"shortname":{"example":"shortname","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"killChain":{"type":"number"},"mitreAttack":{"items":{"example":"T1234","type":"string"},"type":"array"},"name":{"example":"name","type":"string"},"shortname":{"example":"shortname","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name","killChain"],"type":"object"}}},"description":"Returns the updated category."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Updates a category","tags":["Category"],"x-api-token-group":["Cloudforce One Write"]},"post":{"operationId":"post_CategoryUpdate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Category UUID.","in":"path","name":"category_id","required":true,"schema":{"description":"Category UUID.","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"killChain":{"type":"number"},"mitreAttack":{"items":{"example":"T1234","type":"string"},"type":"array"},"name":{"example":"name","type":"string"},"shortname":{"example":"shortname","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"killChain":{"type":"number"},"mitreAttack":{"items":{"example":"T1234","type":"string"},"type":"array"},"name":{"example":"name","type":"string"},"shortname":{"example":"shortname","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name","killChain"],"type":"object"}}},"description":"Returns the updated category."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Updates a category","tags":["Category"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/countries":{"get":{"operationId":"get_CountryRead","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"result":{"items":{"properties":{"alpha3":{"example":"AF","type":"string"},"name":{"example":"Afghanistan","type":"string"}},"required":["name","alpha3"],"type":"object"},"type":"array"},"success":{"example":"true","type":"string"}},"required":["success","result"],"type":"object"},"type":"array"}}},"description":"Returns the long and short country code for every country."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Retrieves countries information for all countries","tags":["Country"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/create":{"post":{"description":"To create a dataset, see the [`Create Dataset`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/create/) endpoint. When `datasetId` parameter is unspecified, it will be created in a default dataset named `Cloudforce One Threat Events`.","operationId":"post_EventCreate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"accountId":{"example":123456,"type":"number"},"attacker":{"example":"Flying Yeti","nullable":true,"type":"string"},"attackerCountry":{"example":"CN","type":"string"},"category":{"example":"Domain Resolution","type":"string"},"datasetId":{"example":"durableObjectName","type":"string"},"date":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"event":{"example":"An attacker registered the domain domain.com","type":"string"},"indicator":{"example":"domain.com","type":"string"},"indicatorType":{"example":"domain","type":"string"},"indicators":{"description":"Array of indicators for this event. Supports multiple indicators per event for complex scenarios.","items":{"properties":{"indicatorType":{"description":"The type of indicator (e.g., DOMAIN, IP, JA3, HASH)","example":"domain","type":"string"},"value":{"description":"The indicator value (e.g., domain name, IP address, hash)","example":"malicious.com","type":"string"}},"required":["value","indicatorType"],"type":"object"},"type":"array"},"insight":{"example":"This domain was likely registered for phishing purposes","type":"string"},"raw":{"properties":{"data":{"additionalProperties":true,"nullable":true,"type":"object"},"source":{"example":"example.com","type":"string"},"tlp":{"example":"amber","type":"string"}},"required":["data"],"type":"object"},"tags":{"items":{"example":"malware","type":"string"},"type":"array"},"targetCountry":{"example":"US","type":"string"},"targetIndustry":{"example":"Agriculture","type":"string"},"tlp":{"example":"amber","type":"string"}},"required":["date","category","event","tlp","raw"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"attacker":{"example":"Flying Yeti","type":"string"},"attackerCountry":{"example":"CN","type":"string"},"category":{"example":"Domain Resolution","type":"string"},"date":{"example":"2022-04-01T00:00:00Z","type":"string"},"event":{"example":"An attacker registered the domain domain.com","type":"string"},"hasChildren":{"type":"boolean"},"indicator":{"example":"domain.com","type":"string"},"indicatorType":{"example":"domain","type":"string"},"indicatorTypeId":{"example":5,"type":"number"},"insight":{"type":"string"},"killChain":{"type":"number"},"mitreAttack":{"items":{"example":" ","type":"string"},"type":"array"},"numReferenced":{"type":"number"},"numReferences":{"type":"number"},"rawId":{"example":"453gw34w3","type":"string"},"referenced":{"items":{"example":" ","type":"string"},"type":"array"},"referencedIds":{"items":{"type":"number"},"type":"array"},"references":{"items":{"example":" ","type":"string"},"type":"array"},"referencesIds":{"items":{"type":"number"},"type":"array"},"releasabilityId":{"type":"string"},"tags":{"items":{"example":"malware","type":"string"},"type":"array"},"targetCountry":{"example":"US","type":"string"},"targetIndustry":{"example":"Agriculture","type":"string"},"tlp":{"example":"amber","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","date","targetCountry","attacker","attackerCountry","targetIndustry","rawId","indicatorTypeId","indicator","event","numReferenced","numReferences","tlp","category","indicatorType","referenced","references","tags","killChain","mitreAttack","referencedIds","referencesIds","hasChildren"],"type":"object"}}},"description":"Returns the created event."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Creates a new event","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/create/bulk":{"post":{"description":"The `datasetId` parameter must be defined. To list existing datasets (and their IDs) in your account, use the [`List Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/) endpoint.","operationId":"post_EventCreateBulk","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"accountId":{"example":123456,"type":"number"},"attacker":{"example":"Flying Yeti","nullable":true,"type":"string"},"attackerCountry":{"example":"CN","type":"string"},"category":{"example":"Domain Resolution","type":"string"},"datasetId":{"example":"durableObjectName","type":"string"},"date":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"event":{"example":"An attacker registered the domain domain.com","type":"string"},"indicator":{"example":"domain.com","type":"string"},"indicatorType":{"example":"domain","type":"string"},"indicators":{"description":"Array of indicators for this event. Supports multiple indicators per event for complex scenarios.","items":{"properties":{"indicatorType":{"description":"The type of indicator (e.g., DOMAIN, IP, JA3, HASH)","example":"domain","type":"string"},"value":{"description":"The indicator value (e.g., domain name, IP address, hash)","example":"malicious.com","type":"string"}},"required":["value","indicatorType"],"type":"object"},"type":"array"},"insight":{"example":"This domain was likely registered for phishing purposes","type":"string"},"raw":{"properties":{"data":{"additionalProperties":true,"nullable":true,"type":"object"},"source":{"example":"example.com","type":"string"},"tlp":{"example":"amber","type":"string"}},"required":["data"],"type":"object"},"tags":{"items":{"example":"malware","type":"string"},"type":"array"},"targetCountry":{"example":"US","type":"string"},"targetIndustry":{"example":"Agriculture","type":"string"},"tlp":{"example":"amber","type":"string"}},"required":["date","category","event","tlp","raw"],"type":"object"},"type":"array"},"datasetId":{"example":"durableObjectName","type":"string"}},"required":["data","datasetId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Number of created bulk events","type":"number"}}},"description":"Returns the number of created bulk events."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Creates bulk events","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/create/bulk/relationships":{"post":{"description":"Creates bulk DOS attack events along with their corresponding indicator events and establishes relationships between them. The `datasetId` parameter must be defined. To list existing datasets (and their IDs) in your account, use the [`List Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/) endpoint.","operationId":"post_DOSEventCreateBulkWithRelationships","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"accountId":{"example":123456,"type":"number"},"attacker":{"example":"Flying Yeti","nullable":true,"type":"string"},"attackerCountry":{"example":"CN","type":"string"},"category":{"example":"Domain Resolution","type":"string"},"datasetId":{"example":"durableObjectName","type":"string"},"date":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"event":{"example":"An attacker registered the domain domain.com","type":"string"},"indicator":{"example":"domain.com","type":"string"},"indicatorType":{"example":"domain","type":"string"},"indicators":{"description":"Array of indicators for this event. Supports multiple indicators per event for complex scenarios.","items":{"properties":{"indicatorType":{"description":"The type of indicator (e.g., DOMAIN, IP, JA3, HASH)","example":"domain","type":"string"},"value":{"description":"The indicator value (e.g., domain name, IP address, hash)","example":"malicious.com","type":"string"}},"required":["value","indicatorType"],"type":"object"},"type":"array"},"insight":{"example":"This domain was likely registered for phishing purposes","type":"string"},"raw":{"properties":{"data":{"additionalProperties":true,"nullable":true,"type":"object"},"source":{"example":"example.com","type":"string"},"tlp":{"example":"amber","type":"string"}},"required":["data"],"type":"object"},"tags":{"items":{"example":"malware","type":"string"},"type":"array"},"targetCountry":{"example":"US","type":"string"},"targetIndustry":{"example":"Agriculture","type":"string"},"tlp":{"example":"amber","type":"string"}},"required":["date","category","event","tlp","raw"],"type":"object"},"type":"array"},"datasetId":{"example":"durableObjectName","type":"string"}},"required":["data","datasetId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Result of bulk relationship creation operation","properties":{"createdEventsCount":{"description":"Number of events created","type":"number"},"createdIndicatorsCount":{"description":"Number of indicators created","type":"number"},"createdRelationshipsCount":{"description":"Number of relationships created","type":"number"},"errorCount":{"description":"Number of errors encountered","type":"number"},"errors":{"description":"Array of error details","items":{"properties":{"error":{"description":"Error message","type":"string"},"eventIndex":{"description":"Index of the event that caused the error","type":"number"}},"required":["eventIndex","error"],"type":"object"},"type":"array"}},"required":["createdEventsCount","createdIndicatorsCount","createdRelationshipsCount","errorCount"],"type":"object"}}},"description":"Returns the number of created bulk events with relationships."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Creates bulk DOS event with relationships and indicators","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/dataset":{"get":{"operationId":"get_DatasetList","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"isPublic":{"example":true,"type":"boolean"},"name":{"example":"friendly dataset name","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name","isPublic"],"type":"object"},"type":"array"}}},"description":"Returns a list of dataset in an account."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Lists all datasets in an account","tags":["Dataset"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/dataset/create":{"post":{"operationId":"post_DatasetCreate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"isPublic":{"description":"If true, then anyone can search the dataset. If false, then its limited to the account.","type":"boolean"},"name":{"description":"Used to describe the dataset within the account context.","minLength":1,"type":"string"}},"required":["name","isPublic"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"isPublic":{"example":true,"type":"boolean"},"name":{"example":"friendly dataset name","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name","isPublic"],"type":"object"}}},"description":"Returns dataset information."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Creates a dataset","tags":["Dataset"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}":{"delete":{"description":"Deletes a dataset given a datasetId.","operationId":"delete_DatasetDelete","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset ID to delete","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset ID to delete","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"name":{"example":"friendly dataset name","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name"],"type":"object"}}},"description":"Returns the uuid and name of the deleted dataset."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Delete a dataset","tags":["Dataset"],"x-api-token-group":["Cloudforce One Write"]},"get":{"operationId":"get_DatasetRead","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset ID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset ID.","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"isPublic":{"example":true,"type":"boolean"},"name":{"example":"friendly dataset name","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name","isPublic"],"type":"object"}}},"description":"Returns a dataset."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Reads a dataset","tags":["Dataset"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]},"patch":{"operationId":"patch_DatasetUpdate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset ID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset ID.","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"isPublic":{"description":"If true, then anyone can search the dataset. If false, then its limited to the account.","type":"boolean"},"name":{"description":"Used to describe the dataset within the account context.","minLength":1,"type":"string"}},"required":["name","isPublic"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"isPublic":{"example":true,"type":"boolean"},"name":{"example":"friendly dataset name","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name","isPublic"],"type":"object"}}},"description":"Returns dataset information."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Updates an existing dataset","tags":["Dataset"],"x-api-token-group":["Cloudforce One Write"]},"post":{"operationId":"post_DatasetUpdate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset ID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset ID.","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"isPublic":{"description":"If true, then anyone can search the dataset. If false, then its limited to the account.","type":"boolean"},"name":{"description":"Used to describe the dataset within the account context.","minLength":1,"type":"string"}},"required":["name","isPublic"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"isPublic":{"example":true,"type":"boolean"},"name":{"example":"friendly dataset name","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name","isPublic"],"type":"object"}}},"description":"Returns dataset information."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Updates an existing dataset","tags":["Dataset"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/events/{event_id}":{"get":{"description":"Retrieves a specific event by its UUID.","operationId":"get_EventRead","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset ID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset ID.","type":"string"}},{"description":"Event UUID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event UUID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"attacker":{"example":"Flying Yeti","type":"string"},"attackerCountry":{"example":"CN","type":"string"},"category":{"example":"Domain Resolution","type":"string"},"date":{"example":"2022-04-01T00:00:00Z","type":"string"},"event":{"example":"An attacker registered the domain domain.com","type":"string"},"hasChildren":{"type":"boolean"},"indicator":{"example":"domain.com","type":"string"},"indicatorType":{"example":"domain","type":"string"},"indicatorTypeId":{"example":5,"type":"number"},"insight":{"type":"string"},"killChain":{"type":"number"},"mitreAttack":{"items":{"example":" ","type":"string"},"type":"array"},"numReferenced":{"type":"number"},"numReferences":{"type":"number"},"rawId":{"example":"453gw34w3","type":"string"},"referenced":{"items":{"example":" ","type":"string"},"type":"array"},"referencedIds":{"items":{"type":"number"},"type":"array"},"references":{"items":{"example":" ","type":"string"},"type":"array"},"referencesIds":{"items":{"type":"number"},"type":"array"},"releasabilityId":{"type":"string"},"tags":{"items":{"example":"malware","type":"string"},"type":"array"},"targetCountry":{"example":"US","type":"string"},"targetIndustry":{"example":"Agriculture","type":"string"},"tlp":{"example":"amber","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","date","targetCountry","attacker","attackerCountry","targetIndustry","rawId","indicatorTypeId","indicator","event","numReferenced","numReferences","tlp","category","indicatorType","referenced","references","tags","killChain","mitreAttack","referencedIds","referencesIds","hasChildren"],"type":"object"}}},"description":"Returns the event."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Reads an event","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicatorTypes/create":{"post":{"description":"Creates a new indicator type and initializes its dedicated Durable Object","operationId":"post_IndicatorTypeCreate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset ID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"description":"Optional description for the indicator type","type":"string"},"indicatorType":{"description":"The indicator type to create (e.g., 'DOMAIN', 'IP', 'URL', 'HASH', 'EMAIL')","maxLength":50,"minLength":1,"type":"string"}},"required":["indicatorType"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"durableObjectId":{"example":"account:123:DOMAIN","type":"string"},"indicatorType":{"example":"DOMAIN","type":"string"},"message":{"example":"Indicator type created successfully","type":"string"}},"required":["indicatorType","message","durableObjectId"],"type":"object"}}},"description":"Indicator type created successfully"},"400":{"content":{"application/json":{"schema":{"properties":{"content":{"properties":{"application/json":{"properties":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}},"required":["schema"],"type":"object"}},"required":["application/json"],"type":"object"},"description":{"example":"Bad Request.","type":"string"}},"required":["description","content"],"type":"object"}}},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"properties":{"content":{"properties":{"application/json":{"properties":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}},"required":["schema"],"type":"object"}},"required":["application/json"],"type":"object"},"description":{"example":"Bad Request.","type":"string"}},"required":["description","content"],"type":"object"}}},"description":"Internal Server Error"}},"security":[{"api_token":[]}],"summary":"Create a new indicator type","tags":["Indicators"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators":{"get":{"description":"Retrieves a paginated list of indicators for the account.","operationId":"get_IndicatorListLegacy","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset UUID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset UUID.","format":"uuid","type":"string"}},{"in":"query","name":"page","schema":{"type":"number"}},{"in":"query","name":"pageSize","schema":{"type":"number"}},{"in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"indicatorType","schema":{"type":"string"}},{"description":"Filter indicators by related event UUID(s). Multiple UUIDs can be provided by repeating the parameter.","in":"query","name":"relatedEvent","schema":{"description":"Filter indicators by related event UUID(s). Multiple UUIDs can be provided by repeating the parameter.","items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"indicators":{"items":{"properties":{"createdAt":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"indicatorType":{"example":"domain","type":"string"},"relatedEvents":{"items":{"properties":{"datasetId":{"example":"dataset-uuid-123","type":"string"},"eventId":{"example":"event-uuid-456","type":"string"}},"required":["datasetId","eventId"],"type":"object"},"type":"array"},"tags":{"items":{"properties":{"categoryName":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"updatedAt":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"},"value":{"example":"malicious-domain.com","type":"string"}},"required":["uuid","indicatorType","value","createdAt","updatedAt"],"type":"object"},"type":"array"},"pagination":{"properties":{"page":{"type":"number"},"pageSize":{"type":"number"},"totalCount":{"type":"number"},"totalPages":{"type":"number"}},"required":["page","pageSize","totalCount","totalPages"],"type":"object"}},"required":["indicators","pagination"],"type":"object"}}},"description":"Returns a list of indicators."}},"security":[{"api_token":[]}],"summary":"Lists indicators","tags":["Indicator"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/bulk":{"post":{"description":"Creates multiple indicators at once with their respective types and related datasets.","operationId":"post_IndicatorCreateBulk","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset UUID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset UUID.","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"autoCreateType":{"description":"Global flag to automatically create indicator types if they don't exist. Individual indicators can override this with their own autoCreateType flag.","type":"boolean"},"indicators":{"items":{"properties":{"autoCreateType":{"description":"If true, automatically create the indicator type if it doesn't exist. If false (default), throw an error when the indicator type doesn't exist.","type":"boolean"},"indicatorType":{"example":"domain","type":"string"},"relatedEvents":{"items":{"properties":{"datasetId":{"example":"dataset-uuid-123","type":"string"},"eventId":{"example":"event-uuid-456","type":"string"}},"required":["datasetId","eventId"],"type":"object"},"type":"array"},"tags":{"items":{"anyOf":[{"type":"string"},{"properties":{"categoryName":{"type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"}]},"type":"array"},"value":{"example":"malicious-domain.com","type":"string"}},"required":["indicatorType","value"],"type":"object"},"type":"array"}},"required":["indicators"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Number of created indicators","type":"number"}}},"description":"Returns the number of created indicators."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Creates multiple indicators in bulk","tags":["Indicator"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/create":{"post":{"description":"Creates a new indicator with the specified type and related datasets.","operationId":"post_IndicatorCreate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset UUID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset UUID.","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"autoCreateType":{"description":"If true, automatically create the indicator type if it doesn't exist. If false (default), throw an error when the indicator type doesn't exist.","type":"boolean"},"indicatorType":{"example":"domain","type":"string"},"relatedEvents":{"items":{"properties":{"datasetId":{"example":"dataset-uuid-123","type":"string"},"eventId":{"example":"event-uuid-456","type":"string"}},"required":["datasetId","eventId"],"type":"object"},"type":"array"},"tags":{"items":{"anyOf":[{"type":"string"},{"properties":{"categoryName":{"type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"}]},"type":"array"},"value":{"example":"malicious-domain.com","type":"string"}},"required":["indicatorType","value"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"createdAt":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"indicatorType":{"example":"domain","type":"string"},"relatedEvents":{"items":{"properties":{"datasetId":{"example":"dataset-uuid-123","type":"string"},"eventId":{"example":"event-uuid-456","type":"string"}},"required":["datasetId","eventId"],"type":"object"},"type":"array"},"tags":{"items":{"properties":{"categoryName":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"updatedAt":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"},"value":{"example":"malicious-domain.com","type":"string"}},"required":["uuid","indicatorType","value","createdAt","updatedAt"],"type":"object"}}},"description":"Returns the created indicator."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Creates a new indicator","tags":["Indicator"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/tags":{"get":{"description":"Returns all mirrored tags from the indicator dataset (DO mirror table). No pagination.","operationId":"get_IndicatorTagsList","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset ID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Array of mirror tag rows","items":{"type":"object"},"type":"array"}}},"description":"Returns an array of mirrored tags."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"List mirrored tags for an indicator dataset","tags":["Indicator"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/indicators/{indicator_id}":{"delete":{"description":"Deletes a specific indicator by its UUID.","operationId":"delete_IndicatorDelete","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset ID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset ID.","type":"string"}},{"description":"Indicator UUID.","in":"path","name":"indicator_id","required":true,"schema":{"description":"Indicator UUID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Indicator deleted successfully."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Deletes an indicator","tags":["Indicator"],"x-api-token-group":["Cloudforce One Write"]},"get":{"description":"Retrieves a specific indicator by its UUID.","operationId":"get_IndicatorRead","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset ID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset ID.","type":"string"}},{"description":"Indicator UUID.","in":"path","name":"indicator_id","required":true,"schema":{"description":"Indicator UUID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"createdAt":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"indicatorType":{"example":"domain","type":"string"},"relatedEvents":{"items":{"properties":{"datasetId":{"example":"dataset-uuid-123","type":"string"},"eventId":{"example":"event-uuid-456","type":"string"}},"required":["datasetId","eventId"],"type":"object"},"type":"array"},"tags":{"items":{"properties":{"categoryName":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"updatedAt":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"},"value":{"example":"malicious-domain.com","type":"string"}},"required":["uuid","indicatorType","value","createdAt","updatedAt"],"type":"object"}}},"description":"Returns the indicator."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Reads an indicator","tags":["Indicator"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]},"patch":{"description":"Updates an existing indicator's properties.","operationId":"patch_IndicatorUpdate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset ID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset ID.","type":"string"}},{"description":"Indicator UUID.","in":"path","name":"indicator_id","required":true,"schema":{"description":"Indicator UUID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"indicatorType":{"example":"domain","type":"string"},"relatedEvents":{"items":{"properties":{"datasetId":{"example":"dataset-uuid-123","type":"string"},"eventId":{"example":"event-uuid-456","type":"string"}},"required":["datasetId","eventId"],"type":"object"},"type":"array"},"tags":{"items":{"anyOf":[{"type":"string"},{"properties":{"categoryName":{"type":"string"},"value":{"type":"string"}},"required":["value"],"type":"object"}]},"type":"array"},"value":{"example":"updated-domain.com","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"createdAt":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"indicatorType":{"example":"domain","type":"string"},"relatedEvents":{"items":{"properties":{"datasetId":{"example":"dataset-uuid-123","type":"string"},"eventId":{"example":"event-uuid-456","type":"string"}},"required":["datasetId","eventId"],"type":"object"},"type":"array"},"tags":{"items":{"properties":{"categoryName":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"updatedAt":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"},"value":{"example":"malicious-domain.com","type":"string"}},"required":["uuid","indicatorType","value","createdAt","updatedAt"],"type":"object"}}},"description":"Returns the updated indicator."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Updates an indicator","tags":["Indicator"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/move":{"post":{"operationId":"post_EventMoveToNewDS","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset UUID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset UUID.","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destDatasetId":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"},"eventIds":{"items":{"example":"7632a037-fdef-4899-9b12-148470aae772","type":"string"},"type":"array"}},"required":["destDatasetId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"example":150,"type":"number"}}},"description":"Returns the number of moved events "},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Moves specified events from one dataset to another dataset","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/tags/{tag_uuid}/indicators":{"get":{"description":"Returns indicators associated with the provided tag UUID across all indicator datasets, with pagination.","operationId":"get_TagIndicatorsList","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Tag UUID.","in":"path","name":"tag_uuid","required":true,"schema":{"description":"Tag UUID.","type":"string"}},{"description":"Dataset UUID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset UUID.","format":"uuid","type":"string"}},{"in":"query","name":"page","schema":{"type":"number"}},{"in":"query","name":"pageSize","schema":{"type":"number"}},{"in":"query","name":"indicatorType","schema":{"type":"string"}},{"description":"Filter indicators by related event UUID(s). Multiple UUIDs can be provided by repeating the parameter.","in":"query","name":"relatedEvent","schema":{"description":"Filter indicators by related event UUID(s). Multiple UUIDs can be provided by repeating the parameter.","items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"indicators":{"items":{"properties":{"createdAt":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"indicatorType":{"example":"domain","type":"string"},"relatedEvents":{"items":{"properties":{"datasetId":{"example":"dataset-uuid-123","type":"string"},"eventId":{"example":"event-uuid-456","type":"string"}},"required":["datasetId","eventId"],"type":"object"},"type":"array"},"tags":{"items":{"properties":{"categoryName":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"updatedAt":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"},"value":{"example":"malicious-domain.com","type":"string"}},"required":["uuid","indicatorType","value","createdAt","updatedAt"],"type":"object"},"type":"array"},"pagination":{"properties":{"page":{"type":"number"},"pageSize":{"type":"number"},"totalCount":{"type":"number"},"totalPages":{"type":"number"}},"required":["page","pageSize","totalCount","totalPages"],"type":"object"}},"required":["indicators","pagination"],"type":"object"}}},"description":"Returns a paginated list of indicators."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"List indicators related to a tag","tags":["Tag"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}/targetIndustries":{"get":{"operationId":"get_TargetIndustryListByDataset","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset UUID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset UUID.","format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"}}},"description":"Returns a list of target industries for the dataset."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Lists all target industries for a specific dataset","tags":["Target Industry"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/datasets/populate":{"post":{"operationId":"post_DatasetPopulate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"properties":{"properties":{"accountId":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"datasets":{"properties":{"items":{"properties":{"properties":{"properties":{"attackers":{"properties":{"properties":{"properties":{"created":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"},"errors":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"},"found":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"}},"required":["found","created","errors"],"type":"object"},"type":{"example":"object","type":"string"}},"required":["type","properties"],"type":"object"},"categories":{"properties":{"properties":{"properties":{"created":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"},"errors":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"},"found":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"}},"required":["found","created","errors"],"type":"object"},"type":{"example":"object","type":"string"}},"required":["type","properties"],"type":"object"},"datasetId":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"indicatorTypes":{"properties":{"properties":{"properties":{"created":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"},"errors":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"},"found":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"}},"required":["found","created","errors"],"type":"object"},"type":{"example":"object","type":"string"}},"required":["type","properties"],"type":"object"},"processingTimeMs":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"},"targetIndustries":{"properties":{"properties":{"properties":{"created":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"},"errors":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"},"found":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"}},"required":["found","created","errors"],"type":"object"},"type":{"example":"object","type":"string"}},"required":["type","properties"],"type":"object"},"totalProcessed":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"}},"required":["datasetId","indicatorTypes","targetIndustries","categories","attackers","totalProcessed","processingTimeMs"],"type":"object"},"type":{"example":"object","type":"string"}},"required":["type","properties"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"},"errors":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"},"summary":{"properties":{"properties":{"properties":{"failedDatasets":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"},"successfulDatasets":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"},"totalDatasets":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"},"totalIndicatorTypes":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"},"totalProcessingTimeMs":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"}},"required":["totalDatasets","successfulDatasets","failedDatasets","totalIndicatorTypes","totalProcessingTimeMs"],"type":"object"},"type":{"example":"object","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["accountId","datasets","summary","errors"],"type":"object"},"type":{"example":"object","type":"string"}},"required":["type","properties"],"type":"object"}}},"description":"Returns population results with counts and any errors"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Populate dataset-specific lookup tables from existing Events data with batch processing","tags":["Datasets"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/event_tag/{event_id}":{"delete":{"operationId":"delete_EventTagDelete","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Event UUID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event UUID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"tags":{"items":{"example":"malware","type":"string"},"type":"array"}},"required":["tags"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"success":{"example":true,"type":"boolean"}},"required":["success"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns success if operation succeeded."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Removes a tag from an event","tags":["Event"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/events/event_tag/{event_id}/create":{"post":{"operationId":"post_EventTagCreate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Event UUID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event UUID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"tags":{"items":{"example":"botnet","type":"string"},"type":"array"}},"required":["tags"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"success":{"example":true,"type":"boolean"}},"required":["success"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns success if operation succeeded."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Adds a tag to an event","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/indicator-types":{"get":{"operationId":"get_IndicatorTypesList","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Array of dataset IDs to query indicator types from. If not provided, queries all datasets for the account.","in":"query","name":"datasetIds","schema":{"description":"Array of dataset IDs to query indicator types from. If not provided, queries all datasets for the account.","items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"}}},"description":"Returns a list of indicator types."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Lists indicator types across multiple datasets","tags":["Indicator Types"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/indicatorTypes":{"get":{"deprecated":true,"description":"This Method is deprecated. Please use /events/dataset/:dataset_id/indicatorTypes instead.","operationId":"get_LegacyIndicatorTypesList","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"}}},"description":"Returns a list of indicator types."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Lists all indicator types","tags":["Indicator Types"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/indicators":{"get":{"description":"Retrieves a paginated list of indicators across specified datasets. Use datasetIds=all or datasetIds=* to query all datasets for the account. If no datasetIds provided, uses the default dataset.","operationId":"get_IndicatorList","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset IDs to query indicators from (comma-separated or array), or special value 'all' or '*' to query all datasets. If not provided, uses the default dataset.","in":"query","name":"datasetIds","schema":{"description":"Dataset IDs to query indicators from (comma-separated or array), or special value 'all' or '*' to query all datasets. If not provided, uses the default dataset.","type":"string"}},{"in":"query","name":"page","schema":{"type":"number"}},{"in":"query","name":"pageSize","schema":{"type":"number"}},{"in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"indicatorType","schema":{"type":"string"}},{"description":"Filter by related event IDs","in":"query","name":"relatedEvents","schema":{"description":"Filter by related event IDs","items":{"type":"string"},"type":"array"}},{"description":"Filter by tag values or UUIDs. Indicators must have at least one of the specified tags (OR logic). Supports both tag UUID and tag value.","in":"query","name":"tags","schema":{"description":"Filter by tag values or UUIDs. Indicators must have at least one of the specified tags (OR logic). Supports both tag UUID and tag value.","items":{"type":"string"},"type":"array"}},{"description":"Filter indicators created on or after this date. Must use ISO 8601 format (e.g., '2024-01-15T00:00:00Z').","in":"query","name":"createdAfter","schema":{"description":"Filter indicators created on or after this date. Must use ISO 8601 format (e.g., '2024-01-15T00:00:00Z').","format":"date-time","type":"string"}},{"description":"Filter indicators created on or before this date. Must use ISO 8601 format (e.g., '2024-12-31T23:59:59Z').","in":"query","name":"createdBefore","schema":{"description":"Filter indicators created on or before this date. Must use ISO 8601 format (e.g., '2024-12-31T23:59:59Z').","format":"date-time","type":"string"}},{"description":"Limit the number of related events returned per indicator. Default: 2. Set to 0 for none, -1 for all events.","in":"query","name":"relatedEventsLimit","schema":{"description":"Limit the number of related events returned per indicator. Default: 2. Set to 0 for none, -1 for all events.","example":2,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"properties":{"properties":{"indicators":{"properties":{"items":{"properties":{"createdAt":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"indicatorType":{"example":"domain","type":"string"},"relatedEvents":{"items":{"properties":{"datasetId":{"example":"dataset-uuid-123","type":"string"},"eventId":{"example":"event-uuid-456","type":"string"}},"required":["datasetId","eventId"],"type":"object"},"type":"array"},"tags":{"items":{"properties":{"categoryName":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"type":"object"},"type":"array"},"updatedAt":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"},"value":{"example":"malicious-domain.com","type":"string"}},"required":["uuid","indicatorType","value","createdAt","updatedAt"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"},"pagination":{"properties":{"properties":{"properties":{"count":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"},"page":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"},"per_page":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"},"total_count":{"properties":{"type":{"example":"number","type":"string"}},"required":["type"],"type":"object"}},"required":["count","page","per_page","total_count"],"type":"object"},"type":{"example":"object","type":"string"}},"required":["type","properties"],"type":"object"}},"required":["indicators","pagination"],"type":"object"},"type":{"example":"object","type":"string"}},"required":["type","properties"],"type":"object"}}},"description":"Returns a paginated list of indicators."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Lists indicators across multiple datasets","tags":["Indicator"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/raw/{dataset_id}/{event_id}":{"get":{"operationId":"get_EventRawReadDS","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Event ID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event ID.","type":"string"}},{"description":"Dataset ID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"accountId":{"example":1234,"type":"number"},"created":{"example":"1970-01-01","type":"string"},"data":{"type":"object"},"id":{"example":"1234","type":"string"},"source":{"example":"https://example.com","type":"string"},"tlp":{"example":"amber","type":"string"}},"required":["accountId","created","data","id","source","tlp"],"type":"object"}}},"description":"Returns the raw event."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Reads data for a raw event","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/relate/{event_id}":{"delete":{"operationId":"delete_EventReferenceDelete","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Event UUID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event UUID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"events":{"items":{"example":"88888888-4444-4444-4444-121212121212","type":"string"},"type":"array"}},"required":["events"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"success":{"example":true,"type":"boolean"}},"required":["success"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns success if operation succeeded."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Removes an event reference","tags":["Event"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/events/relate/{event_id}/create":{"post":{"operationId":"post_EventReferenceCreate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Event UUID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event UUID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"events":{"items":{"example":"88888888-4444-4444-4444-121212121212","type":"string"},"type":"array"}},"required":["events"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"success":{"example":true,"type":"boolean"}},"required":["success"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["success","result"],"type":"object"}}},"description":"Returns success if operation succeeded."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Creates event references for a event","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/relationships/create":{"post":{"description":"Creates a directed relationship between two events. The relationship is from parent to child with a specified type.","operationId":"post_CreateEventRelationship","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"childIds":{"description":"Array of UUIDs for child events. Single child = 1:1 relationship, multiple = 1:many relationships","items":{"format":"uuid","type":"string"},"minItems":1,"type":"array"},"datasetId":{"description":"Dataset identifier where the events are stored","type":"string"},"parentId":{"description":"UUID of the parent event that will be the source of the relationship","format":"uuid","type":"string"},"relationshipType":{"description":"Type of relationship to create between parent and child events","enum":["related_to","caused_by","attributed_to"],"type":"string"}},"required":["parentId","childIds","relationshipType","datasetId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"childIds":{"description":"Array of child event UUIDs that were processed","items":{"format":"uuid","type":"string"},"type":"array"},"errors":{"description":"Array of errors for relationships that failed to be created (only present if some relationships failed)","items":{"properties":{"childId":{"description":"UUID of the child event that failed to create a relationship","format":"uuid","type":"string"},"error":{"description":"Error message describing why the relationship creation failed","type":"string"},"errorType":{"description":"Type/category of the error that occurred","type":"string"}},"required":["childId","error"],"type":"object"},"type":"array"},"message":{"description":"Human-readable message describing the operation result","type":"string"},"relationships":{"description":"Array of successfully created relationship objects","items":{"properties":{"childDatasetId":{"description":"Dataset ID where the child event resides","type":"string"},"childId":{"description":"UUID of the child event in the relationship","format":"uuid","type":"string"},"parentDatasetId":{"description":"Dataset ID where the parent event resides","type":"string"},"parentId":{"description":"UUID of the parent event in the relationship","format":"uuid","type":"string"},"relationshipType":{"description":"Type of relationship between the events","enum":["related_to","caused_by","attributed_to"],"type":"string"}},"required":["parentId","childId","relationshipType","parentDatasetId","childDatasetId"],"type":"object"},"type":"array"},"relationshipsCreated":{"description":"Number of relationships that were successfully created","type":"number"},"success":{"description":"Whether the relationship creation operation completed successfully","type":"boolean"}},"required":["success","message","relationships"],"type":"object"}}},"description":"Relationship created successfully"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Create a relationship between two events","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/tags":{"get":{"description":"Returns all Source-of-Truth tags for an account.","operationId":"get_TagList","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"in":"query","name":"page","schema":{"type":"number"}},{"in":"query","name":"pageSize","schema":{"type":"number"}},{"in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"categoryUuid","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"pagination":{"properties":{"page":{"type":"number"},"pageSize":{"type":"number"},"totalCount":{"type":"number"},"totalPages":{"type":"number"}},"required":["page","pageSize","totalCount","totalPages"],"type":"object"},"tags":{"items":{"properties":{"activeDuration":{"type":"string"},"actorCategory":{"type":"string"},"aliasGroupNames":{"items":{"type":"string"},"type":"array"},"aliasGroupNamesInternal":{"items":{"type":"string"},"type":"array"},"analyticPriority":{"type":"number"},"attributionConfidence":{"type":"string"},"attributionOrganization":{"type":"string"},"categoryName":{"example":"Nation State","type":"string"},"externalReferenceLinks":{"items":{"type":"string"},"type":"array"},"internalDescription":{"type":"string"},"motive":{"type":"string"},"opsecLevel":{"type":"string"},"originCountryISO":{"type":"string"},"priority":{"type":"number"},"sophisticationLevel":{"type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"},"value":{"example":"APT28","type":"string"}},"required":["uuid","value"],"type":"object"},"type":"array"}},"required":["tags","pagination"],"type":"object"}}},"description":"Returns a paginated list of tags."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Lists all tags (SoT)","tags":["Tag"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/tags/categories":{"get":{"description":"Returns all Source-of-Truth tag categories for an account.","operationId":"get_TagCategoryList","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"in":"query","name":"search","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"categories":{"items":{"properties":{"createdAt":{"type":"string"},"description":{"type":"string"},"name":{"example":"Actor","type":"string"},"updatedAt":{"type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name"],"type":"object"},"type":"array"}},"required":["categories"],"type":"object"}}},"description":"Returns a list of tag categories."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Lists all tag categories (SoT)","tags":["TagCategory"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/tags/categories/create":{"post":{"description":"Creates a new Source-of-Truth tag category for an account.","operationId":"post_TagCategoryCreate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"type":"string"},"name":{"example":"Actor","type":"string"}},"required":["name"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"createdAt":{"type":"string"},"description":{"type":"string"},"name":{"example":"Actor","type":"string"},"updatedAt":{"type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name"],"type":"object"}}},"description":"Returns the created tag category."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."},"409":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Creates a new tag category (SoT)","tags":["TagCategory"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/tags/categories/{category_uuid}":{"delete":{"description":"Deletes a Source-of-Truth tag category by UUID.","operationId":"delete_TagCategoryDelete","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Tag Category UUID.","in":"path","name":"category_uuid","required":true,"schema":{"description":"Tag Category UUID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid"],"type":"object"}}},"description":"Returns the uuid of the deleted tag category."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Deletes a tag category (SoT)","tags":["TagCategory"],"x-api-token-group":["Cloudforce One Write"]},"patch":{"description":"Updates a Source-of-Truth tag category by UUID.","operationId":"patch_TagCategoryUpdate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Tag Category UUID.","in":"path","name":"category_uuid","required":true,"schema":{"description":"Tag Category UUID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"createdAt":{"type":"string"},"description":{"type":"string"},"name":{"example":"Actor","type":"string"},"updatedAt":{"type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","name"],"type":"object"}}},"description":"Returns the updated tag category."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."},"409":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Updates a tag category (SoT)","tags":["TagCategory"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/events/tags/create":{"post":{"description":"Creates a new tag to be used accross threat events.","operationId":"post_TagCreate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"activeDuration":{"type":"string"},"actorCategory":{"type":"string"},"aliasGroupNames":{"items":{"type":"string"},"type":"array"},"aliasGroupNamesInternal":{"items":{"type":"string"},"type":"array"},"analyticPriority":{"type":"number"},"attributionConfidence":{"type":"string"},"attributionOrganization":{"type":"string"},"categoryUuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"},"externalReferenceLinks":{"items":{"type":"string"},"type":"array"},"internalDescription":{"type":"string"},"motive":{"type":"string"},"opsecLevel":{"type":"string"},"originCountryISO":{"type":"string"},"priority":{"type":"number"},"sophisticationLevel":{"type":"string"},"value":{"example":"APT28","type":"string"}},"required":["value"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"activeDuration":{"type":"string"},"actorCategory":{"type":"string"},"aliasGroupNames":{"items":{"type":"string"},"type":"array"},"aliasGroupNamesInternal":{"items":{"type":"string"},"type":"array"},"analyticPriority":{"type":"number"},"attributionConfidence":{"type":"string"},"attributionOrganization":{"type":"string"},"categoryName":{"example":"Nation State","type":"string"},"externalReferenceLinks":{"items":{"type":"string"},"type":"array"},"internalDescription":{"type":"string"},"motive":{"type":"string"},"opsecLevel":{"type":"string"},"originCountryISO":{"type":"string"},"priority":{"type":"number"},"sophisticationLevel":{"type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"},"value":{"example":"APT28","type":"string"}},"required":["uuid","value"],"type":"object"}}},"description":"Returns the created tag."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Creates a new tag","tags":["Tag"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid}":{"delete":{"description":"Deletes a Source-of-Truth tag by UUID.","operationId":"delete_TagDelete","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Tag UUID.","in":"path","name":"tag_uuid","required":true,"schema":{"description":"Tag UUID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid"],"type":"object"}}},"description":"Returns the uuid of the deleted tag."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Deletes a tag (SoT)","tags":["Tag"],"x-api-token-group":["Cloudforce One Write"]},"patch":{"description":"Updates a Source-of-Truth tag by UUID.","operationId":"patch_TagUpdate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Tag UUID.","in":"path","name":"tag_uuid","required":true,"schema":{"description":"Tag UUID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"activeDuration":{"type":"string"},"actorCategory":{"type":"string"},"aliasGroupNames":{"items":{"type":"string"},"type":"array"},"aliasGroupNamesInternal":{"items":{"type":"string"},"type":"array"},"analyticPriority":{"type":"number"},"attributionConfidence":{"type":"string"},"attributionOrganization":{"type":"string"},"categoryUuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"},"externalReferenceLinks":{"items":{"type":"string"},"type":"array"},"internalDescription":{"type":"string"},"motive":{"type":"string"},"opsecLevel":{"type":"string"},"originCountryISO":{"type":"string"},"priority":{"type":"number"},"sophisticationLevel":{"type":"string"},"value":{"example":"APT28","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"activeDuration":{"type":"string"},"actorCategory":{"type":"string"},"aliasGroupNames":{"items":{"type":"string"},"type":"array"},"aliasGroupNamesInternal":{"items":{"type":"string"},"type":"array"},"analyticPriority":{"type":"number"},"attributionConfidence":{"type":"string"},"attributionOrganization":{"type":"string"},"categoryName":{"example":"Nation State","type":"string"},"externalReferenceLinks":{"items":{"type":"string"},"type":"array"},"internalDescription":{"type":"string"},"motive":{"type":"string"},"opsecLevel":{"type":"string"},"originCountryISO":{"type":"string"},"priority":{"type":"number"},"sophisticationLevel":{"type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"},"value":{"example":"APT28","type":"string"}},"required":["uuid","value"],"type":"object"}}},"description":"Returns the updated tag."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Updates a tag (SoT)","tags":["Tag"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/events/targetIndustries":{"get":{"operationId":"get_TargetIndustryList","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Array of dataset IDs to query target industries from. If not provided, uses the default dataset.","in":"query","name":"datasetIds","schema":{"description":"Array of dataset IDs to query target industries from. If not provided, uses the default dataset.","items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"}}},"description":"Returns a list of target industries."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Lists target industries across multiple datasets","tags":["Target Industry"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/targetIndustries/catalog":{"get":{"operationId":"get_TargetIndustryListComplete","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"items":{"properties":{"type":{"example":"string","type":"string"}},"required":["type"],"type":"object"},"type":{"example":"array","type":"string"}},"required":["type","items"],"type":"object"}}},"description":"Returns all target industries from industry map catalog."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Lists all target industries from industry map catalog","tags":["Target Industry"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/{dataset_id}/delete":{"delete":{"operationId":"delete_EventDeleteDO","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Dataset UUID.","in":"path","name":"dataset_id","required":true,"schema":{"description":"Dataset UUID.","format":"uuid","type":"string"}},{"description":"Array of Event IDs to delete.","in":"query","name":"eventIds","required":true,"schema":{"description":"Array of Event IDs to delete.","items":{"minLength":1,"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Number of deleted events","type":"number"}}},"description":"Returns the number of deleted events."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Deletes one or more events","tags":["Event"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/events/{event_id}":{"delete":{"description":"The `datasetId` parameter must be defined. To list existing datasets (and their IDs) in your account, use the [`List Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/) endpoint.","operationId":"delete_EventDelete","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Event UUID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event UUID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid"],"type":"object"}}},"description":"Returns the uuid of the deleted event."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Deletes an event","tags":["Event"],"x-api-token-group":["Cloudforce One Write"]},"get":{"deprecated":true,"description":"This Method is deprecated. Please use /events/dataset/:dataset_id/events/:event_id instead.","operationId":"get_EventReadDeprecated","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Event UUID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event UUID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"attacker":{"example":"Flying Yeti","type":"string"},"attackerCountry":{"example":"CN","type":"string"},"category":{"example":"Domain Resolution","type":"string"},"date":{"example":"2022-04-01T00:00:00Z","type":"string"},"event":{"example":"An attacker registered the domain domain.com","type":"string"},"hasChildren":{"type":"boolean"},"indicator":{"example":"domain.com","type":"string"},"indicatorType":{"example":"domain","type":"string"},"indicatorTypeId":{"example":5,"type":"number"},"insight":{"type":"string"},"killChain":{"type":"number"},"mitreAttack":{"items":{"example":" ","type":"string"},"type":"array"},"numReferenced":{"type":"number"},"numReferences":{"type":"number"},"rawId":{"example":"453gw34w3","type":"string"},"referenced":{"items":{"example":" ","type":"string"},"type":"array"},"referencedIds":{"items":{"type":"number"},"type":"array"},"references":{"items":{"example":" ","type":"string"},"type":"array"},"referencesIds":{"items":{"type":"number"},"type":"array"},"releasabilityId":{"type":"string"},"tags":{"items":{"example":"malware","type":"string"},"type":"array"},"targetCountry":{"example":"US","type":"string"},"targetIndustry":{"example":"Agriculture","type":"string"},"tlp":{"example":"amber","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","date","targetCountry","attacker","attackerCountry","targetIndustry","rawId","indicatorTypeId","indicator","event","numReferenced","numReferences","tlp","category","indicatorType","referenced","references","tags","killChain","mitreAttack","referencedIds","referencesIds","hasChildren"],"type":"object"}}},"description":"Returns an event."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Reads an event","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]},"patch":{"operationId":"patch_EventUpdate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Event UUID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event UUID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"attacker":{"example":"Flying Yeti","nullable":true,"type":"string"},"attackerCountry":{"example":"CN","type":"string"},"category":{"example":"Domain Resolution","type":"string"},"date":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"event":{"example":"An attacker registered the domain domain.com","type":"string"},"indicator":{"example":"domain2.com","type":"string"},"indicatorType":{"example":"domain","type":"string"},"insight":{"example":"new insight","type":"string"},"raw":{"properties":{"data":{"additionalProperties":true,"nullable":true,"type":"object"},"source":{"example":"example.com","type":"string"},"tlp":{"example":"amber","type":"string"}},"type":"object"},"targetCountry":{"example":"US","type":"string"},"targetIndustry":{"example":"Insurance","type":"string"},"tlp":{"example":"amber","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"attacker":{"example":"Flying Yeti","type":"string"},"attackerCountry":{"example":"CN","type":"string"},"category":{"example":"Domain Resolution","type":"string"},"date":{"example":"2022-04-01T00:00:00Z","type":"string"},"event":{"example":"An attacker registered the domain domain.com","type":"string"},"hasChildren":{"type":"boolean"},"indicator":{"example":"domain.com","type":"string"},"indicatorType":{"example":"domain","type":"string"},"indicatorTypeId":{"example":5,"type":"number"},"insight":{"type":"string"},"killChain":{"type":"number"},"mitreAttack":{"items":{"example":" ","type":"string"},"type":"array"},"numReferenced":{"type":"number"},"numReferences":{"type":"number"},"rawId":{"example":"453gw34w3","type":"string"},"referenced":{"items":{"example":" ","type":"string"},"type":"array"},"referencedIds":{"items":{"type":"number"},"type":"array"},"references":{"items":{"example":" ","type":"string"},"type":"array"},"referencesIds":{"items":{"type":"number"},"type":"array"},"releasabilityId":{"type":"string"},"tags":{"items":{"example":"malware","type":"string"},"type":"array"},"targetCountry":{"example":"US","type":"string"},"targetIndustry":{"example":"Agriculture","type":"string"},"tlp":{"example":"amber","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","date","targetCountry","attacker","attackerCountry","targetIndustry","rawId","indicatorTypeId","indicator","event","numReferenced","numReferences","tlp","category","indicatorType","referenced","references","tags","killChain","mitreAttack","referencedIds","referencesIds","hasChildren"],"type":"object"}}},"description":"Returns the updated event."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Updates an event","tags":["Event"],"x-api-token-group":["Cloudforce One Write"]},"post":{"operationId":"post_EventUpdate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Event UUID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event UUID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"attacker":{"example":"Flying Yeti","nullable":true,"type":"string"},"attackerCountry":{"example":"CN","type":"string"},"category":{"example":"Domain Resolution","type":"string"},"date":{"example":"2022-04-01T00:00:00Z","format":"date-time","type":"string"},"event":{"example":"An attacker registered the domain domain.com","type":"string"},"indicator":{"example":"domain2.com","type":"string"},"indicatorType":{"example":"domain","type":"string"},"insight":{"example":"new insight","type":"string"},"raw":{"properties":{"data":{"additionalProperties":true,"nullable":true,"type":"object"},"source":{"example":"example.com","type":"string"},"tlp":{"example":"amber","type":"string"}},"type":"object"},"targetCountry":{"example":"US","type":"string"},"targetIndustry":{"example":"Insurance","type":"string"},"tlp":{"example":"amber","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"attacker":{"example":"Flying Yeti","type":"string"},"attackerCountry":{"example":"CN","type":"string"},"category":{"example":"Domain Resolution","type":"string"},"date":{"example":"2022-04-01T00:00:00Z","type":"string"},"event":{"example":"An attacker registered the domain domain.com","type":"string"},"hasChildren":{"type":"boolean"},"indicator":{"example":"domain.com","type":"string"},"indicatorType":{"example":"domain","type":"string"},"indicatorTypeId":{"example":5,"type":"number"},"insight":{"type":"string"},"killChain":{"type":"number"},"mitreAttack":{"items":{"example":" ","type":"string"},"type":"array"},"numReferenced":{"type":"number"},"numReferences":{"type":"number"},"rawId":{"example":"453gw34w3","type":"string"},"referenced":{"items":{"example":" ","type":"string"},"type":"array"},"referencedIds":{"items":{"type":"number"},"type":"array"},"references":{"items":{"example":" ","type":"string"},"type":"array"},"referencesIds":{"items":{"type":"number"},"type":"array"},"releasabilityId":{"type":"string"},"tags":{"items":{"example":"malware","type":"string"},"type":"array"},"targetCountry":{"example":"US","type":"string"},"targetIndustry":{"example":"Agriculture","type":"string"},"tlp":{"example":"amber","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","date","targetCountry","attacker","attackerCountry","targetIndustry","rawId","indicatorTypeId","indicator","event","numReferenced","numReferences","tlp","category","indicatorType","referenced","references","tags","killChain","mitreAttack","referencedIds","referencesIds","hasChildren"],"type":"object"}}},"description":"Returns the updated event."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Updates an event","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/{event_id}/raw/{raw_id}":{"get":{"operationId":"get_EventRawRead","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Event UUID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event UUID.","type":"string"}},{"description":"Raw Event UUID.","in":"path","name":"raw_id","required":true,"schema":{"description":"Raw Event UUID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"accountId":{"example":1234,"type":"number"},"created":{"example":"1970-01-01","type":"string"},"data":{"type":"object"},"id":{"example":"1234","type":"string"},"source":{"example":"https://example.com","type":"string"},"tlp":{"example":"amber","type":"string"}},"required":["accountId","created","data","id","source","tlp"],"type":"object"}}},"description":"Returns the raw event."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Reads data for a raw event","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]},"patch":{"operationId":"patch_EventRawUpdate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Event UUID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event UUID.","type":"string"}},{"description":"Raw Event UUID.","in":"path","name":"raw_id","required":true,"schema":{"description":"Raw Event UUID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object"},"source":{"example":"example.com","type":"string"},"tlp":{"example":"amber","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object"},"id":{"example":"1234","type":"string"}},"required":["id","data"],"type":"object"}}},"description":"Returns the uuid of the updated raw event and its data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Updates a raw event","tags":["Event"],"x-api-token-group":["Cloudforce One Write"]},"post":{"operationId":"post_EventRawUpdate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Event UUID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event UUID.","type":"string"}},{"description":"Raw Event UUID.","in":"path","name":"raw_id","required":true,"schema":{"description":"Raw Event UUID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object"},"source":{"example":"example.com","type":"string"},"tlp":{"example":"amber","type":"string"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"type":"object"},"id":{"example":"1234","type":"string"}},"required":["id","data"],"type":"object"}}},"description":"Returns the uuid of the updated raw event and its data."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Updates a raw event","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/events/{event_id}/relationships":{"get":{"description":"The `event_id` must be defined (to list existing events (and their IDs), use the [`Filter and List Events`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/methods/list/) endpoint). Also, must provide query parameters.","operationId":"get_EventRelationships","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Event UUID.","in":"path","name":"event_id","required":true,"schema":{"description":"Event UUID.","type":"string"}},{"description":"The direction to traverse the graph. Defaults to 'both' to search all.","in":"query","name":"direction","schema":{"default":"both","description":"The direction to traverse the graph. Defaults to 'both' to search all.","enum":["ancestors","descendants","both"],"type":"string"}},{"description":"The maximum depth to traverse. Defaults to 5.","in":"query","name":"maxDepth","schema":{"description":"The maximum depth to traverse. Defaults to 5.","type":"number"}},{"description":"An optional array of relationship types to filter by.","in":"query","name":"relationshipTypes","schema":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}],"description":"An optional array of relationship types to filter by."}},{"description":"An optional array of indicator type IDs to filter the results by.","in":"query","name":"indicatorTypeIds","schema":{"description":"An optional array of indicator type IDs to filter the results by.","items":{"type":"string"},"type":"array"}},{"description":"The dataset ID to search within.","in":"query","name":"datasetId","required":true,"schema":{"description":"The dataset ID to search within.","type":"string"}},{"description":"Whether to include the starting event in the results. Defaults to true.","in":"query","name":"includeParent","schema":{"default":true,"description":"Whether to include the starting event in the results. Defaults to true.","type":"boolean"}},{"in":"query","name":"page","schema":{"type":"number"}},{"in":"query","name":"pageSize","schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"attacker":{"example":"Flying Yeti","type":"string"},"attackerCountry":{"example":"CN","type":"string"},"category":{"example":"Domain Resolution","type":"string"},"date":{"example":"2022-04-01T00:00:00Z","type":"string"},"event":{"example":"An attacker registered the domain domain.com","type":"string"},"hasChildren":{"type":"boolean"},"indicator":{"example":"domain.com","type":"string"},"indicatorType":{"example":"domain","type":"string"},"indicatorTypeId":{"example":5,"type":"number"},"insight":{"type":"string"},"killChain":{"type":"number"},"mitreAttack":{"items":{"example":" ","type":"string"},"type":"array"},"numReferenced":{"type":"number"},"numReferences":{"type":"number"},"rawId":{"example":"453gw34w3","type":"string"},"referenced":{"items":{"example":" ","type":"string"},"type":"array"},"referencedIds":{"items":{"type":"number"},"type":"array"},"references":{"items":{"example":" ","type":"string"},"type":"array"},"referencesIds":{"items":{"type":"number"},"type":"array"},"releasabilityId":{"type":"string"},"tags":{"items":{"example":"malware","type":"string"},"type":"array"},"targetCountry":{"example":"US","type":"string"},"targetIndustry":{"example":"Agriculture","type":"string"},"tlp":{"example":"amber","type":"string"},"uuid":{"example":"12345678-1234-1234-1234-1234567890ab","type":"string"}},"required":["uuid","date","targetCountry","attacker","attackerCountry","targetIndustry","rawId","indicatorTypeId","indicator","event","numReferenced","numReferences","tlp","category","indicatorType","referenced","references","tags","killChain","mitreAttack","referencedIds","referencesIds","hasChildren"],"type":"object"},"type":"array"}}},"description":"Returns a list of events related to the specified starting event."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"An error occurred.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_token":[]}],"summary":"Filter and list events related to specific event","tags":["Event"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/requests":{"post":{"operationId":"cloudforce-one-request-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_request-list"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/cloudforce-one-requests_request-list-item"},"type":"array"}},"type":"object"}]}}},"description":"List requests response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Create response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Requests","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/requests/constants":{"get":{"operationId":"cloudforce-one-request-constants","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloudforce-one-requests_request-constants"}},"type":"object"}]}}},"description":"Get request constants response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Get request constants response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Request Priority, Status, and TLP constants","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/requests/new":{"post":{"description":"Creating a request adds the request into the Cloudforce One queue for analysis. In addition to the content, a short title, type, priority, and releasability should be provided. If one is not provided, a default will be assigned.","operationId":"cloudforce-one-request-new","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_request-edit"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloudforce-one-requests_request-item"}},"type":"object"}]}}},"description":"Create request response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Create response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a New Request.","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/requests/priority":{"post":{"operationId":"cloudforce-one-priority-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_priority-list"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/cloudforce-one-requests_priority-item"},"type":"array"}},"type":"object"}]}}},"description":"List priorities response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"List priorities response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Priority Intelligence Requirements","tags":["Priority Intelligence Requirements (PIR)"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/requests/priority/new":{"post":{"operationId":"cloudforce-one-priority-new","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_priority-edit"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloudforce-one-requests_priority-item"}},"type":"object"}]}}},"description":"Create priority response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Create priority response  failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a New Priority Intelligence Requirement","tags":["Priority Intelligence Requirements (PIR)"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/requests/priority/quota":{"get":{"operationId":"cloudforce-one-priority-quota","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_quota"}]}},"type":"object"}]}}},"description":"Get priority quota response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Get priority quota response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Priority Intelligence Requirement Quota","tags":["Priority Intelligence Requirements (PIR)"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/requests/priority/{priority_id}":{"delete":{"operationId":"cloudforce-one-priority-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"priority_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"}}},"description":"Delete priority response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Delete priority response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a Priority Intelligence Requirement","tags":["Priority Intelligence Requirements (PIR)"],"x-api-token-group":["Cloudforce One Write"]},"get":{"operationId":"cloudforce-one-priority-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"priority_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_request-item"}]}},"type":"object"}]}}},"description":"Get priority response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Get priority response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a Priority Intelligence Requirement","tags":["Priority Intelligence Requirements (PIR)"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]},"put":{"operationId":"cloudforce-one-priority-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"priority_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_priority-edit"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_request-item"}]}},"type":"object"}]}}},"description":"Update priority response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Update priority response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update a Priority Intelligence Requirement","tags":["Priority Intelligence Requirements (PIR)"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/requests/quota":{"get":{"operationId":"cloudforce-one-request-quota","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloudforce-one-requests_quota"}},"type":"object"}]}}},"description":"Get request quota response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Get request quota response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Request Quota","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/requests/types":{"get":{"operationId":"cloudforce-one-request-types","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloudforce-one-requests_request-types"}},"type":"object"}]}}},"description":"Get request types response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Get request types response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Request Types","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cloudforce-one/requests/{request_id}":{"delete":{"operationId":"cloudforce-one-request-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"request_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"}}},"description":"Delete request response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Delete request response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a Request","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write"]},"get":{"operationId":"cloudforce-one-request-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"request_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloudforce-one-requests_request-item"}},"type":"object"}]}}},"description":"Get request response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Get request response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a Request","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]},"put":{"description":"Updating a request alters the request in the Cloudforce One queue. This API may be used to update any attributes of the request after the initial submission. Only fields that you choose to update need to be add to the request body.","operationId":"cloudforce-one-request-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"request_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_request-edit"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloudforce-one-requests_request-item"}},"type":"object"}]}}},"description":"Update request response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Update request response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update a Request","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset":{"post":{"operationId":"cloudforce-one-request-asset-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"request_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_request-asset-list"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/cloudforce-one-requests_request-asset-item"},"type":"array"}},"type":"object"}]}}},"description":"List request assets response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"List request assets response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Request Assets","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/new":{"post":{"operationId":"cloudforce-one-request-asset-new","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"request_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_request-asset-edit"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloudforce-one-requests_request-asset-item"}},"type":"object"}]}}},"description":"Create request asset response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Create request asset response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a New Request Asset","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/requests/{request_id}/asset/{asset_id}":{"delete":{"operationId":"cloudforce-one-request-asset-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"request_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}},{"in":"path","name":"asset_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"}}},"description":"Delete request asset response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Delete request asset response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a Request Asset","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write"]},"get":{"operationId":"cloudforce-one-request-asset-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"request_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}},{"in":"path","name":"asset_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/cloudforce-one-requests_request-asset-item"},"type":"array"}},"type":"object"}]}}},"description":"Get request asset response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Get request asset response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a Request Asset","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]},"put":{"operationId":"cloudforce-one-request-asset-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"request_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}},{"in":"path","name":"asset_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_request-asset-edit"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloudforce-one-requests_request-asset-item"}},"type":"object"}]}}},"description":"Update request asset response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Update request asset response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update a Request Asset","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/requests/{request_id}/message":{"post":{"operationId":"cloudforce-one-request-message-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"request_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_request-message-list"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/cloudforce-one-requests_request-message-item"},"type":"array"}},"type":"object"}]}}},"description":"List request messages response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"List request messages response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Request Messages","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/new":{"post":{"operationId":"cloudforce-one-request-message-new","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"request_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_request-message-edit"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloudforce-one-requests_request-message-item"}},"type":"object"}]}}},"description":"Create request message response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Create request message response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a New Request Message","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/requests/{request_id}/message/{message_id}":{"delete":{"operationId":"cloudforce-one-request-message-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"request_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}},{"in":"path","name":"message_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"}}},"description":"Delete request message response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Delete request message response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a Request Message","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write"]},"put":{"operationId":"cloudforce-one-request-message-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_identifier"}},{"in":"path","name":"request_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_uuid"}},{"in":"path","name":"message_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_request-message-edit"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloudforce-one-requests_request-message-item"}},"type":"object"}]}}},"description":"Update request message response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-requests_api-response-common-failure"}}},"description":"Update request message response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update a Request Message","tags":["Request for Information (RFI)"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/scans/config":{"get":{"operationId":"get_ConfigFetch","parameters":[{"description":"Defines the Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Defines the Account ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_scan-config"},"type":"array"}}}]}}},"description":"Returns all Scan Configs."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_api-response-common-failure"}}},"description":"List Scan Configs failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Scan Configs","tags":["Scans"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]},"post":{"operationId":"post_ConfigCreate","parameters":[{"description":"Defines the Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Defines the Account ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"frequency":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_frequency"},"ips":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_ips"},"ports":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_ports"}},"required":["ips"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_scan-config"}}}]}}},"description":"Returns the created config."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_api-response-common-failure"}}},"description":"Create a new Scan Config failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a new Scan Config","tags":["Scans"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/scans/config/{config_id}":{"delete":{"operationId":"delete_DeleteScans","parameters":[{"description":"Defines the Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Defines the Account ID.","type":"string"}},{"description":"Defines the Config ID.","in":"path","name":"config_id","required":true,"schema":{"description":"Defines the Config ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"string"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"type":"object"},"success":{"type":"boolean"}},"required":["success","result","messages","errors"],"type":"object"}}},"description":"Delete a Scan Config."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_api-response-common-failure"}}},"description":"Delete a Scan Config failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a Scan Config","tags":["Scans"],"x-api-token-group":["Cloudforce One Write"]},"patch":{"operationId":"post_ConfigUpdate","parameters":[{"description":"Defines the Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Defines the Account ID.","type":"string"}},{"description":"Defines the Config ID.","in":"path","name":"config_id","required":true,"schema":{"description":"Defines the Config ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"frequency":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_frequency"},"ips":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_ips"},"ports":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_ports"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_scan-config"}}}]}}},"description":"Returns the updated config."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_api-response-common-failure"}}},"description":"Update an Existing Scan Config failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update an existing Scan Config","tags":["Scans"],"x-api-token-group":["Cloudforce One Write"]}},"/accounts/{account_id}/cloudforce-one/scans/results/{config_id}":{"get":{"operationId":"get_GetOpenPorts","parameters":[{"description":"Defines the Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Defines the Account ID.","type":"string"}},{"description":"Defines the Config ID.","in":"path","name":"config_id","required":true,"schema":{"description":"Defines the Config ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"string"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"properties":{"1.1.1.1":{"items":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_port"},"type":"array"}},"required":["1.1.1.1"],"type":"object"},"success":{"type":"boolean"}},"required":["success","result","messages","errors"],"type":"object"}}},"description":"Returns Current Open Ports."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-port-scan-api_api-response-common-failure"}}},"description":"Get the Latest Scan Result failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get the Latest Scan Result","tags":["Scans"],"x-api-token-group":["Cloudforce One Write","Cloudforce One Read"]}},"/accounts/{account_id}/cni/cnis":{"get":{"operationId":"list_cnis","parameters":[{"description":"If specified, only show CNIs associated with the specified slot","in":"query","name":"slot","schema":{"nullable":true,"type":"string"}},{"description":"If specified, only show cnis associated with the specified tunnel id","in":"query","name":"tunnel_id","schema":{"nullable":true,"type":"string"}},{"in":"query","name":"cursor","schema":{"format":"int32","nullable":true,"type":"integer"}},{"in":"query","name":"limit","schema":{"minimum":0,"nullable":true,"type":"integer"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/nsc_AccountTag"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_CniList"}}},"description":"List of matching CNI objects"},"400":{"description":"Bad request"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List existing CNI objects","tags":["CNIs"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"]},"post":{"operationId":"create_cni","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/nsc_AccountTag"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_CniCreate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_Cni"}}},"description":"CNI was successfully created"},"400":{"description":"Bad request"},"409":{"description":"Name Conflict"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a new CNI object","tags":["CNIs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"]}},"/accounts/{account_id}/cni/cnis/{cni}":{"delete":{"operationId":"delete_cni","parameters":[{"description":"CNI ID to retrieve information about","in":"path","name":"cni","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/nsc_AccountTag"}}],"responses":{"200":{"description":"CNI has been successfully deleted"},"400":{"description":"Bad request"},"404":{"description":"CNI not found"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a specified CNI object","tags":["CNIs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"]},"get":{"operationId":"get_cni","parameters":[{"description":"CNI ID to retrieve information about","in":"path","name":"cni","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/nsc_AccountTag"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_Cni"}}},"description":"CNI's associated data"},"400":{"description":"Bad request"},"404":{"description":"CNI not found"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get information about a CNI object","tags":["CNIs"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"]},"put":{"operationId":"update_cni","parameters":[{"description":"CNI ID to retrieve information about","in":"path","name":"cni","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/nsc_AccountTag"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_Cni"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_Cni"}}},"description":"CNI has been successfully modified"},"400":{"description":"Bad request"},"404":{"description":"CNI not found"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Modify stored information about a CNI object","tags":["CNIs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"]}},"/accounts/{account_id}/cni/interconnects":{"get":{"operationId":"list_interconnects","parameters":[{"description":"If specified, only show interconnects located at the given site","in":"query","name":"site","schema":{"nullable":true,"type":"string"}},{"description":"If specified, only show interconnects of the given type","in":"query","name":"type","schema":{"nullable":true,"type":"string"}},{"in":"query","name":"cursor","schema":{"format":"int32","nullable":true,"type":"integer"}},{"in":"query","name":"limit","schema":{"minimum":0,"nullable":true,"type":"integer"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/nsc_AccountTag"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_InterconnectList"}}},"description":"List of matching interconnect objects"},"400":{"description":"Bad request"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List existing interconnects","tags":["Interconnects"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"]},"post":{"operationId":"create_interconnect","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/nsc_AccountTag"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_InterconnectCreate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_Interconnect"}}},"description":"Information about the new interconnect"},"400":{"description":"Bad request"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a new interconnect","tags":["Interconnects"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"]}},"/accounts/{account_id}/cni/interconnects/{icon}":{"delete":{"operationId":"delete_interconnect","parameters":[{"description":"Interconnect name to retrieve information about","in":"path","name":"icon","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/nsc_AccountTag"}}],"responses":{"200":{"description":"Successfully deleted interconnect"},"400":{"description":"Bad request"},"404":{"description":"Interconnect not found"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an interconnect object","tags":["Interconnects"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"]},"get":{"operationId":"get_interconnect","parameters":[{"description":"Interconnect name to retrieve information about","in":"path","name":"icon","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/nsc_AccountTag"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_Interconnect"}}},"description":"Information about the specified interconnect"},"400":{"description":"Bad request"},"404":{"description":"Interconnect not found"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get information about an interconnect object","tags":["Interconnects"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"]}},"/accounts/{account_id}/cni/interconnects/{icon}/loa":{"get":{"operationId":"get_interconnect_loa","parameters":[{"description":"Interconnect name to retrieve information about","in":"path","name":"icon","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/nsc_AccountTag"}}],"responses":{"200":{"description":"Generated LOA in PDF format"},"400":{"description":"Bad request"},"404":{"description":"Interconnect not found"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Generate the Letter of Authorization (LOA) for a given interconnect","tags":["Interconnects"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"]}},"/accounts/{account_id}/cni/interconnects/{icon}/status":{"get":{"operationId":"get_interconnect_status","parameters":[{"description":"Interconnect name to retrieve information about","in":"path","name":"icon","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/nsc_AccountTag"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_StatusInfo"}}},"description":"Current interconnect status"},"400":{"description":"Bad request"},"404":{"description":"Interconnect not found"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get the current status of an interconnect object","tags":["Interconnects"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"]}},"/accounts/{account_id}/cni/settings":{"get":{"operationId":"get_settings","parameters":[{"description":"Account tag to retrieve settings for","in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_Settings"}}},"description":"The active account settings values"},"400":{"description":"Bad request"},"404":{"description":"Account not found"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get the current settings for the active account","tags":["Settings"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"]},"put":{"operationId":"update_settings","parameters":[{"description":"Account tag to update settings for","in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_SettingsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_Settings"}}},"description":"The active account settings values"},"400":{"description":"Bad request"},"404":{"description":"Account not found"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update the current settings for the active account","tags":["Settings"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"]}},"/accounts/{account_id}/cni/slots":{"get":{"operationId":"list_slots","parameters":[{"description":"If specified, only show slots with the given text in their address field","in":"query","name":"address_contains","schema":{"nullable":true,"type":"string"}},{"description":"If specified, only show slots located at the given site","in":"query","name":"site","schema":{"nullable":true,"type":"string"}},{"description":"If specified, only show slots that support the given speed","in":"query","name":"speed","schema":{"nullable":true,"type":"string"}},{"description":"If specified, only show slots with a specific occupied/unoccupied state","in":"query","name":"occupied","schema":{"nullable":true,"type":"boolean"}},{"in":"query","name":"cursor","schema":{"format":"int32","nullable":true,"type":"integer"}},{"in":"query","name":"limit","schema":{"minimum":0,"nullable":true,"type":"integer"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/nsc_AccountTag"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_SlotList"}}},"description":"List of matching slots"},"400":{"description":"Bad request"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve a list of all slots matching the specified parameters","tags":["Slots"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"]}},"/accounts/{account_id}/cni/slots/{slot}":{"get":{"operationId":"get_slot","parameters":[{"in":"path","name":"slot","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/nsc_AccountTag"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/nsc_SlotInfo"}}},"description":"Information about the specified slot"},"400":{"description":"Bad request"},"404":{"description":"Slot not found"},"500":{"description":"Internal server error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get information about the specified slot","tags":["Slots"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"]}},"/accounts/{account_id}/connectivity/directory/services":{"get":{"operationId":"connectivity-services-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/infra_AccountTag"}},{"in":"query","name":"type","schema":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/infra_ServiceType"}],"type":"string"}},{"description":"Current page in the response","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"}},{"description":"Max amount of entries returned per page","in":"query","name":"per_page","schema":{"default":1000,"format":"int32","maximum":1000,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/infra_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/infra_ConnectivityServiceArray"}},"type":"object"}]}}},"description":"Successfully retrieved connectivity services"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_api-response-common-failure"}}},"description":"Failed to retrieve connectivity services"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List connectivity services","tags":["Connectivity Services"]},"post":{"operationId":"connectivity-services-post","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/infra_AccountTag"}}],"requestBody":{"content":{"application/json":{"examples":{"http-with-defaults":{"summary":"HTTP service with defaults","value":{"host":{"hostname":"api.example.com","resolver_network":{"tunnel_id":"0191dce4-9ab4-7fce-b660-8e5dec5172da"}},"name":"web-server","type":"http"}},"http-with-hostname":{"summary":"HTTP service with hostname","value":{"host":{"hostname":"api.example.com","resolver_network":{"resolver_ips":["10.0.0.1","10.0.0.2"],"tunnel_id":"0191dce4-9ab4-7fce-b660-8e5dec5172da"}},"https_port":443,"name":"api-gateway","type":"http"}},"http-with-ipv4":{"summary":"HTTP service with IPv4 host","value":{"host":{"ipv4":"10.0.0.1","network":{"tunnel_id":"0191dce4-9ab4-7fce-b660-8e5dec5172da"}},"http_port":8080,"https_port":8443,"name":"web-server","type":"http"}}},"schema":{"$ref":"#/components/schemas/infra_ServiceConfig"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"http-service-created":{"summary":"Successfully created HTTP service","value":{"errors":[],"messages":[],"result":{"created_at":"2024-01-15T09:30:00Z","host":{"hostname":"api.example.com","resolver_network":{"tunnel_id":"0191dce4-9ab4-7fce-b660-8e5dec5172da"}},"name":"web-server","service_id":"550e8400-e29b-41d4-a716-446655440000","type":"http","updated_at":"2024-01-15T09:30:00Z"},"success":true}}},"schema":{"allOf":[{"$ref":"#/components/schemas/infra_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/infra_ServiceConfig"}},"type":"object"}]}}},"description":"Successfully created connectivity service"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_api-response-common-failure"}}},"description":"Failed to create connectivity service"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create connectivity service","tags":["Connectivity Services"]}},"/accounts/{account_id}/connectivity/directory/services/{service_id}":{"delete":{"operationId":"connectivity-services-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"service_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"Successfully deleted connectivity service"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_api-response-common-failure"}}},"description":"Failed to delete connectivity service"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete connectivity service","tags":["Connectivity Services"]},"get":{"operationId":"connectivity-services-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"service_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/infra_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/infra_ServiceConfig"}},"type":"object"}]}}},"description":"Successfully retrieved connectivity service"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_api-response-common-failure"}}},"description":"Failed to retrieve connectivity service"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get connectivity service","tags":["Connectivity Services"]},"put":{"operationId":"connectivity-services-put","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"service_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_ServiceConfig"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/infra_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/infra_ServiceConfig"}},"type":"object"}]}}},"description":"Successfully updated connectivity service"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_api-response-common-failure"}}},"description":"Failed to update connectivity service"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update connectivity service","tags":["Connectivity Services"]}},"/accounts/{account_id}/custom_ns":{"get":{"description":"List an account's custom nameservers.","operationId":"account-level-custom-nameservers-list-account-custom-nameservers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-custom-nameservers_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-custom-nameservers_acns_response_collection"}}},"description":"List Account Custom Nameservers response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_acns_response_collection"},{"$ref":"#/components/schemas/dns-custom-nameservers_api-response-common-failure"}],"type":"object"}}},"description":"List Account Custom Nameservers response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Account Custom Nameservers","tags":["Account-Level Custom Nameservers"],"x-api-token-group":["Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"post":{"operationId":"account-level-custom-nameservers-add-account-custom-nameserver","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-custom-nameservers_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-custom-nameservers_CustomNSInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-custom-nameservers_acns_response_single"}}},"description":"Add Account Custom Nameserver response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_acns_response_single"},{"$ref":"#/components/schemas/dns-custom-nameservers_api-response-common-failure"}],"type":"object"}}},"description":"Add Account Custom Nameserver response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Add Account Custom Nameserver","tags":["Account-Level Custom Nameservers"],"x-api-token-group":["Account Settings Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/custom_ns/{custom_ns_id}":{"delete":{"operationId":"account-level-custom-nameservers-delete-account-custom-nameserver","parameters":[{"in":"path","name":"custom_ns_id","required":true,"schema":{"$ref":"#/components/schemas/dns-custom-nameservers_ns_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-custom-nameservers_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-custom-nameservers_empty_response"}}},"description":"Delete Account Custom Nameserver response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_empty_response"},{"$ref":"#/components/schemas/dns-custom-nameservers_api-response-common-failure"}],"type":"object"}}},"description":"Delete Account Custom Nameserver response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Account Custom Nameserver","tags":["Account-Level Custom Nameservers"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/d1/database":{"get":{"description":"Returns a list of D1 databases.","operationId":"cloudflare-d1-list-databases","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/d1_account-identifier"}},{"in":"query","name":"name","schema":{"description":"a database name to search for.","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":1000,"description":"Number of items per page.","maximum":10000,"minimum":10,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/d1_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/d1_database-response"},"type":"array"},"result_info":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters","example":2000,"type":"number"}},"type":"object"}}}]}}},"description":"List D1 databases response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_api-response-common-failure"}}},"description":"List D1 databases response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List D1 Databases","tags":["D1"],"x-api-token-group":["D1 Read","D1 Write"]},"post":{"description":"Returns the created D1 database.","operationId":"cloudflare-d1-create-database","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/d1_account-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"jurisdiction":{"$ref":"#/components/schemas/d1_jurisdiction"},"name":{"$ref":"#/components/schemas/d1_database-name"},"primary_location_hint":{"$ref":"#/components/schemas/d1_primary-location-hint"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/d1_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/d1_database-details-response"}}}]}}},"description":"Returns the created D1 database's metadata"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_api-response-common-failure"}}},"description":"Database details response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create D1 Database","tags":["D1"],"x-api-token-group":["D1 Write"]}},"/accounts/{account_id}/d1/database/{database_id}":{"delete":{"description":"Deletes the specified D1 database.","operationId":"cloudflare-d1-delete-database","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/d1_account-identifier"}},{"in":"path","name":"database_id","required":true,"schema":{"$ref":"#/components/schemas/d1_database-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/d1_api-response-common"},{"properties":{"result":{"enum":[null],"nullable":true,"type":"object"}}}]}}},"description":"Delete D1 database response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_api-response-common-failure"}}},"description":"Delete D1 database response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete D1 Database","tags":["D1"],"x-api-token-group":["D1 Write"]},"get":{"description":"Returns the specified D1 database.","operationId":"cloudflare-d1-get-database","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/d1_account-identifier"}},{"in":"path","name":"database_id","required":true,"schema":{"oneOf":[{"$ref":"#/components/schemas/d1_database-identifier"},{"$ref":"#/components/schemas/d1_database-name"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/d1_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/d1_database-details-response"}}}]}}},"description":"Database details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_api-response-common-failure"}}},"description":"Database details response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get D1 Database","tags":["D1"],"x-api-token-group":["D1 Read","D1 Write"]},"patch":{"description":"Updates partially the specified D1 database.","operationId":"cloudflare-d1-update-partial-database","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/d1_account-identifier"}},{"in":"path","name":"database_id","required":true,"schema":{"$ref":"#/components/schemas/d1_database-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_database-update-partial-request-body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/d1_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/d1_database-details-response"}}}]}}},"description":"Database details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_api-response-common-failure"}}},"description":"Update D1 database response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update D1 Database partially","tags":["D1"],"x-api-token-group":["D1 Write"]},"put":{"description":"Updates the specified D1 database.","operationId":"cloudflare-d1-update-database","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/d1_account-identifier"}},{"in":"path","name":"database_id","required":true,"schema":{"$ref":"#/components/schemas/d1_database-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_database-update-request-body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/d1_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/d1_database-details-response"}}}]}}},"description":"Database details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_api-response-common-failure"}}},"description":"Update D1 database response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update D1 Database","tags":["D1"],"x-api-token-group":["D1 Write"]}},"/accounts/{account_id}/d1/database/{database_id}/export":{"post":{"description":"Returns a URL where the SQL contents of your D1 can be downloaded. Note: this process may take\nsome time for larger DBs, during which your D1 will be unavailable to serve queries. To avoid\nblocking your DB unnecessarily, an in-progress export must be continually polled or will automatically cancel.\n","operationId":"cloudflare-d1-export-database","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/d1_account-identifier"}},{"in":"path","name":"database_id","required":true,"schema":{"$ref":"#/components/schemas/d1_database-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"current_bookmark":{"description":"To poll an in-progress export, provide the current bookmark (returned by your first polling response)","type":"string","x-auditable":true},"dump_options":{"properties":{"no_data":{"description":"Export only the table definitions, not their contents","type":"boolean","x-auditable":true},"no_schema":{"description":"Export only each table's contents, not its definition","type":"boolean","x-auditable":true},"tables":{"description":"Filter the export to just one or more tables. Passing an empty array is the same as not passing anything and means: export all tables.","items":{"type":"string","x-auditable":true},"type":"array"}},"type":"object"},"output_format":{"description":"Specifies that you will poll this endpoint until the export completes","enum":["polling"],"type":"string","x-auditable":true}},"required":["output_format"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/d1_api-response-common"},{"properties":{"result":{"properties":{"at_bookmark":{"description":"The current time-travel bookmark for your D1, used to poll for updates. Will not change for the duration of the export task.","type":"string","x-auditable":true},"error":{"description":"Only present when status = 'error'. Contains the error message.","type":"string","x-auditable":true},"messages":{"description":"Logs since the last time you polled","items":{"type":"string","x-auditable":true},"type":"array"},"result":{"description":"Only present when status = 'complete'","properties":{"filename":{"description":"The generated SQL filename.","type":"string","x-auditable":true},"signed_url":{"description":"The URL to download the exported SQL. Available for one hour.","type":"string"}},"type":"object"},"status":{"enum":["complete","error"],"type":"string","x-auditable":true},"success":{"type":"boolean","x-auditable":true},"type":{"enum":["export"],"type":"string","x-auditable":true}},"type":"object"}}}]}}},"description":"Polled successfully, task no longer running (errored or complete)"},"202":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/d1_api-response-common"},{"properties":{"result":{"properties":{"at_bookmark":{"description":"The current time-travel bookmark for your D1, used to poll for updates. Will not change for the duration of the export task.","type":"string","x-auditable":true},"messages":{"description":"Logs since the last time you polled","items":{"type":"string","x-auditable":true},"type":"array"},"status":{"enum":["active"],"type":"string","x-auditable":true},"success":{"type":"boolean","x-auditable":true},"type":{"enum":["export"],"type":"string","x-auditable":true}},"type":"object"}}}]}}},"description":"Polled successfully, task is currently running"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_api-response-common-failure"}}},"description":"Poll failed (API error)"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Export D1 Database as SQL","tags":["D1"]}},"/accounts/{account_id}/d1/database/{database_id}/import":{"post":{"description":"Generates a temporary URL for uploading an SQL file to, then instructing the D1 to import it\nand polling it for status updates. Imports block the D1 for their duration.\n","operationId":"cloudflare-d1-import-database","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/d1_account-identifier"}},{"in":"path","name":"database_id","required":true,"schema":{"$ref":"#/components/schemas/d1_database-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"action":{"description":"Indicates you have a new SQL file to upload.","enum":["init"],"type":"string","x-auditable":true},"etag":{"description":"Required when action is 'init' or 'ingest'. An md5 hash of the file you're uploading. Used to check if it already exists, and validate its contents before ingesting.","type":"string","x-auditable":true}},"required":["action","etag"],"title":"init","type":"object"},{"properties":{"action":{"description":"Indicates you've finished uploading to tell the D1 to start consuming it","enum":["ingest"],"type":"string","x-auditable":true},"etag":{"description":"An md5 hash of the file you're uploading. Used to check if it already exists, and validate its contents before ingesting.","type":"string","x-auditable":true},"filename":{"description":"The filename you have successfully uploaded.","type":"string","x-auditable":true}},"required":["action","etag","filename"],"title":"ingest","type":"object"},{"properties":{"action":{"description":"Indicates you've finished uploading to tell the D1 to start consuming it","enum":["poll"],"type":"string","x-auditable":true},"current_bookmark":{"description":"This identifies the currently-running import, checking its status.","type":"string","x-auditable":true}},"required":["action","current_bookmark"],"title":"poll","type":"object"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/d1_api-response-common"},{"properties":{"result":{"properties":{"at_bookmark":{"description":"The current time-travel bookmark for your D1, used to poll for updates. Will not change for the duration of the import. Only returned if an import process is currently running or recently finished.","type":"string","x-auditable":true},"error":{"description":"Only present when status = 'error'. Contains the error message that prevented the import from succeeding.","type":"string","x-auditable":true},"filename":{"description":"Derived from the database ID and etag, to use in avoiding repeated uploads. Only returned when for the 'init' action.","type":"string","x-auditable":true},"messages":{"description":"Logs since the last time you polled","items":{"type":"string","x-auditable":true},"type":"array"},"result":{"description":"Only present when status = 'complete'","properties":{"final_bookmark":{"description":"The time-travel bookmark if you need restore your D1 to directly after the import succeeded.","type":"string","x-auditable":true},"meta":{"$ref":"#/components/schemas/d1_query-meta"},"num_queries":{"description":"The total number of queries that were executed during the import.","type":"number","x-auditable":true}},"type":"object"},"status":{"enum":["complete","error"],"type":"string","x-auditable":true},"success":{"type":"boolean","x-auditable":true},"type":{"enum":["import"],"type":"string","x-auditable":true},"upload_url":{"description":"The R2 presigned URL to use for uploading. Only returned when for the 'init' action.","type":"string"}},"type":"object"}}}]}}},"description":"Successful action. Import is either ready to start, under way, or finished (succeeded or failed)."},"202":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/d1_api-response-common"},{"properties":{"result":{"properties":{"at_bookmark":{"description":"The current time-travel bookmark for your D1, used to poll for updates. Will not change for the duration of the import.","type":"string","x-auditable":true},"messages":{"description":"Logs since the last time you polled","items":{"type":"string","x-auditable":true},"type":"array"},"status":{"enum":["active"],"type":"string","x-auditable":true},"success":{"type":"boolean","x-auditable":true},"type":{"enum":["import"],"type":"string","x-auditable":true}},"type":"object"}}}]}}},"description":"Polled successfully, task is currently running"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_api-response-common-failure"}}},"description":"Poll failed (API error)"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Import SQL into your D1 Database","tags":["D1"]}},"/accounts/{account_id}/d1/database/{database_id}/query":{"post":{"description":"Returns the query result as an object.","operationId":"cloudflare-d1-query-database","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/d1_account-identifier"}},{"in":"path","name":"database_id","required":true,"schema":{"$ref":"#/components/schemas/d1_database-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_batch-query"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/d1_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/d1_query-result-response"},"type":"array"}}}]}}},"description":"Query response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_api-response-common-failure"}}},"description":"Query response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Query D1 Database","tags":["D1"],"x-api-token-group":["D1 Read","D1 Write"]}},"/accounts/{account_id}/d1/database/{database_id}/raw":{"post":{"description":"Returns the query result rows as arrays rather than objects. This is a performance-optimized version of the /query endpoint.","operationId":"cloudflare-d1-raw-database-query","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/d1_account-identifier"}},{"in":"path","name":"database_id","required":true,"schema":{"$ref":"#/components/schemas/d1_database-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_batch-query"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/d1_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/d1_raw-result-response"},"type":"array"}}}]}}},"description":"Raw query response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/d1_api-response-common-failure"}}},"description":"Query response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Raw D1 Database query","tags":["D1"]}},"/accounts/{account_id}/devices":{"get":{"deprecated":true,"description":"List WARP devices. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled for the account.\n\n**Deprecated**: please use one of the following endpoints instead:\n- GET /accounts/{account_id}/devices/physical-devices\n- GET /accounts/{account_id}/devices/registrations\n","operationId":"devices-list-devices","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_devices_response"}}},"description":"List devices response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_devices_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"List devices response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List devices (deprecated)","tags":["Devices"]}},"/accounts/{account_id}/devices/networks":{"get":{"description":"Fetches a list of managed networks for an account.","operationId":"device-managed-networks-list-device-managed-networks","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_components-schemas-response_collection"}}},"description":"List your device managed networks response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_components-schemas-response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"List your device managed networks response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List your device managed networks","tags":["Device Managed Networks"]},"post":{"description":"Creates a new device managed network.","operationId":"device-managed-networks-create-device-managed-network","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config":{"$ref":"#/components/schemas/teams-devices_schemas-config_request"},"name":{"$ref":"#/components/schemas/teams-devices_device-managed-networks_components-schemas-name"},"type":{"$ref":"#/components/schemas/teams-devices_components-schemas-type"}},"required":["name","type","config"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_components-schemas-single_response"}}},"description":"Create a device managed networks response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_components-schemas-single_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Create a device managed networks response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a device managed network","tags":["Device Managed Networks"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/networks/{network_id}":{"delete":{"description":"Deletes a device managed network and fetches a list of the remaining device managed networks for an account.","operationId":"device-managed-networks-delete-device-managed-network","parameters":[{"in":"path","name":"network_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_components-schemas-response_collection"}}},"description":"Delete a device managed network response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_components-schemas-response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Delete a device managed network response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a device managed network","tags":["Device Managed Networks"],"x-api-token-group":["Zero Trust Write"]},"get":{"description":"Fetches details for a single managed network.","operationId":"device-managed-networks-device-managed-network-details","parameters":[{"in":"path","name":"network_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_components-schemas-single_response"}}},"description":"Get device managed network details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_components-schemas-single_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get device managed network details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get device managed network details","tags":["Device Managed Networks"]},"put":{"description":"Updates a configured device managed network.","operationId":"device-managed-networks-update-device-managed-network","parameters":[{"in":"path","name":"network_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config":{"$ref":"#/components/schemas/teams-devices_schemas-config_request"},"name":{"$ref":"#/components/schemas/teams-devices_device-managed-networks_components-schemas-name"},"type":{"$ref":"#/components/schemas/teams-devices_components-schemas-type"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_components-schemas-single_response"}}},"description":"Update a device managed network response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_components-schemas-single_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Update a device managed network response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a device managed network","tags":["Device Managed Networks"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/physical-devices":{"get":{"description":"Lists WARP devices.","operationId":"list-devices","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/teams-devices_devices_list_devices_param_cursor"},{"$ref":"#/components/parameters/teams-devices_devices_list_devices_param_sort_by"},{"$ref":"#/components/parameters/teams-devices_devices_list_devices_param_sort_order"},{"$ref":"#/components/parameters/teams-devices_devices_list_devices_param_last_seen_user_email"},{"$ref":"#/components/parameters/teams-devices_devices_list_devices_param_seen_after"},{"$ref":"#/components/parameters/teams-devices_devices_list_devices_param_seen_before"},{"$ref":"#/components/parameters/teams-devices_devices_list_devices_param_per_page"},{"$ref":"#/components/parameters/teams-devices_devices_list_devices_param_search"},{"$ref":"#/components/parameters/teams-devices_devices_list_devices_param_active_registrations"},{"$ref":"#/components/parameters/teams-devices_devices_list_devices_param_id"},{"$ref":"#/components/parameters/teams-devices_devices_list_devices_param_include"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"example":[],"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"messages":{"example":[],"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"result":{"items":{"$ref":"#/components/schemas/teams-devices_physical_device"},"type":"array"},"result_info":{"$ref":"#/components/schemas/teams-devices_cursor_result_info"},"success":{"description":"Whether the API call was successful.","type":"boolean"}},"required":["result","success","errors","messages"],"type":"object"}}},"description":"Returns a list of Devices."}},"security":[{"api_token":[]}],"summary":"List devices","tags":["Physical Devices"]}},"/accounts/{account_id}/devices/physical-devices/{device_id}":{"delete":{"description":"Deletes a WARP device.","operationId":"delete-device","parameters":[{"in":"path","name":"device_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"result":{"$ref":"#/components/schemas/teams-devices_empty_body"},"success":{"description":"Whether the API call was successful.","type":"boolean"}},"required":["success","errors","messages"],"type":"object"}}},"description":"Device was successfully deleted."}},"security":[{"api_token":[]}],"summary":"Delete device","tags":["Physical Devices"],"x-api-token-group":["Zero Trust Write"]},"get":{"description":"Fetches a single WARP device.","operationId":"get-device","parameters":[{"in":"path","name":"device_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/teams-devices_devices_get_device_param_include"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"result":{"$ref":"#/components/schemas/teams-devices_physical_device"},"success":{"description":"Whether the API call was successful.","type":"boolean"}},"required":["result","success","errors","messages"],"type":"object"}}},"description":"Returns a Device."}},"security":[{"api_token":[]}],"summary":"Get device","tags":["Physical Devices"]}},"/accounts/{account_id}/devices/physical-devices/{device_id}/revoke":{"post":{"description":"Revokes all WARP registrations associated with the specified device.","operationId":"revoke-device","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"device_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"result":{"$ref":"#/components/schemas/teams-devices_empty_body"},"success":{"description":"Whether the API call was successful.","type":"boolean"}},"required":["success","errors","messages"],"type":"object"}}},"description":"Revoke device registrations response."}},"security":[{"api_token":[]}],"summary":"Revoke device registrations","tags":["Physical Devices"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/policies":{"get":{"description":"Fetches a list of the device settings profiles for an account.","operationId":"devices-list-device-settings-policies","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_device_settings_response_collection"}}},"description":"List device settings profiles response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_device_settings_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"List device settings profiles response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List device settings profiles","tags":["Devices"]}},"/accounts/{account_id}/devices/policy":{"get":{"description":"Fetches the default device settings profile for an account.","operationId":"devices-get-default-device-settings-policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_default_device_settings_response"}}},"description":"Get the default device settings profile response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_default_device_settings_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get the default device settings profile response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get the default device settings profile","tags":["Devices"]},"patch":{"description":"Updates the default device settings profile for an account.","operationId":"devices-update-default-device-settings-policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/teams-devices_allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/teams-devices_allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/teams-devices_allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/teams-devices_auto_connect"},"captive_portal":{"$ref":"#/components/schemas/teams-devices_captive_portal"},"disable_auto_fallback":{"$ref":"#/components/schemas/teams-devices_disable_auto_fallback"},"exclude":{"$ref":"#/components/schemas/teams-devices_exclude_request"},"exclude_office_ips":{"$ref":"#/components/schemas/teams-devices_exclude_office_ips"},"include":{"$ref":"#/components/schemas/teams-devices_include_request"},"lan_allow_minutes":{"$ref":"#/components/schemas/teams-devices_lan_allow_minutes"},"lan_allow_subnet_size":{"$ref":"#/components/schemas/teams-devices_lan_allow_subnet_size"},"register_interface_ip_with_dns":{"$ref":"#/components/schemas/teams-devices_register_interface_ip_with_dns"},"sccm_vpn_boundary_support":{"$ref":"#/components/schemas/teams-devices_sccm_vpn_boundary_support"},"service_mode_v2":{"$ref":"#/components/schemas/teams-devices_service_mode_v2"},"support_url":{"$ref":"#/components/schemas/teams-devices_support_url"},"switch_locked":{"$ref":"#/components/schemas/teams-devices_switch_locked"},"tunnel_protocol":{"$ref":"#/components/schemas/teams-devices_tunnel_protocol"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_default_device_settings_response"}}},"description":"Update the default device settings profile response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_default_device_settings_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Update the default device settings profile response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update the default device settings profile","tags":["Devices"],"x-api-token-group":["Zero Trust Write"]},"post":{"description":"Creates a device settings profile to be applied to certain devices matching the criteria.","operationId":"devices-create-device-settings-policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/teams-devices_allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/teams-devices_allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/teams-devices_allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/teams-devices_auto_connect"},"captive_portal":{"$ref":"#/components/schemas/teams-devices_captive_portal"},"description":{"$ref":"#/components/schemas/teams-devices_schemas-description"},"disable_auto_fallback":{"$ref":"#/components/schemas/teams-devices_disable_auto_fallback"},"enabled":{"default":true,"description":"Whether the policy will be applied to matching devices.","example":true,"type":"boolean"},"exclude":{"$ref":"#/components/schemas/teams-devices_exclude_request"},"exclude_office_ips":{"$ref":"#/components/schemas/teams-devices_exclude_office_ips"},"include":{"$ref":"#/components/schemas/teams-devices_include_request"},"lan_allow_minutes":{"$ref":"#/components/schemas/teams-devices_lan_allow_minutes"},"lan_allow_subnet_size":{"$ref":"#/components/schemas/teams-devices_lan_allow_subnet_size"},"match":{"$ref":"#/components/schemas/teams-devices_schemas-match"},"name":{"description":"The name of the device settings profile.","example":"Allow Developers","maxLength":100,"type":"string"},"precedence":{"$ref":"#/components/schemas/teams-devices_precedence"},"register_interface_ip_with_dns":{"$ref":"#/components/schemas/teams-devices_register_interface_ip_with_dns"},"sccm_vpn_boundary_support":{"$ref":"#/components/schemas/teams-devices_sccm_vpn_boundary_support"},"service_mode_v2":{"$ref":"#/components/schemas/teams-devices_service_mode_v2"},"support_url":{"$ref":"#/components/schemas/teams-devices_support_url"},"switch_locked":{"$ref":"#/components/schemas/teams-devices_switch_locked"},"tunnel_protocol":{"$ref":"#/components/schemas/teams-devices_tunnel_protocol"}},"required":["name","precedence","match"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_device_settings_response"}}},"description":"Create a device settings profile response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_device_settings_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Create a device settings profile response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a device settings profile","tags":["Devices"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/policy/exclude":{"get":{"description":"Fetches the list of routes excluded from the WARP client's tunnel.","operationId":"devices-get-split-tunnel-exclude-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_split_tunnel_response_collection"}}},"description":"Get the Split Tunnel exclude list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_split_tunnel_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get the Split Tunnel exclude list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get the Split Tunnel exclude list","tags":["Devices"]},"put":{"description":"Sets the list of routes excluded from the WARP client's tunnel.","operationId":"devices-set-split-tunnel-exclude-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/teams-devices_split_tunnel"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_split_tunnel_response_collection"}}},"description":"Set the Split Tunnel exclude list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_split_tunnel_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Set the Split Tunnel exclude list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Set the Split Tunnel exclude list","tags":["Devices"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/policy/fallback_domains":{"get":{"description":"Fetches a list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.","operationId":"devices-get-local-domain-fallback-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_fallback_domain_response_collection"}}},"description":"Get your Local Domain Fallback list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_fallback_domain_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get your Local Domain Fallback list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get your Local Domain Fallback list","tags":["Devices"]},"put":{"description":"Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead.","operationId":"devices-set-local-domain-fallback-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/teams-devices_fallback_domain"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_fallback_domain_response_collection"}}},"description":"Set your Local Domain Fallback list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_fallback_domain_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Set your Local Domain Fallback list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Set your Local Domain Fallback list","tags":["Devices"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/policy/include":{"get":{"description":"Fetches the list of routes included in the WARP client's tunnel.","operationId":"devices-get-split-tunnel-include-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_split_tunnel_include_response_collection"}}},"description":"Get the Split Tunnel include list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_split_tunnel_include_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get the Split Tunnel include list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get the Split Tunnel include list","tags":["Devices"]},"put":{"description":"Sets the list of routes included in the WARP client's tunnel.","operationId":"devices-set-split-tunnel-include-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/teams-devices_split_tunnel_include"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_split_tunnel_include_response_collection"}}},"description":"Set the Split Tunnel include list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_split_tunnel_include_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Set the Split Tunnel include list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Set the Split Tunnel include list","tags":["Devices"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/policy/{policy_id}":{"delete":{"description":"Deletes a device settings profile and fetches a list of the remaining profiles for an account.","operationId":"devices-delete-device-settings-policy","parameters":[{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_device_settings_response_collection"}}},"description":"Delete a device settings profile response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_device_settings_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Delete a device settings profile response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a device settings profile","tags":["Devices"],"x-api-token-group":["Zero Trust Write"]},"get":{"description":"Fetches a device settings profile by ID.","operationId":"devices-get-device-settings-policy-by-id","parameters":[{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_device_settings_response"}}},"description":"Get device settings profile by ID response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_device_settings_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get device settings profile by ID response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get device settings profile by ID","tags":["Devices"]},"patch":{"description":"Updates a configured device settings profile.","operationId":"devices-update-device-settings-policy","parameters":[{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/teams-devices_allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/teams-devices_allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/teams-devices_allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/teams-devices_auto_connect"},"captive_portal":{"$ref":"#/components/schemas/teams-devices_captive_portal"},"description":{"$ref":"#/components/schemas/teams-devices_schemas-description"},"disable_auto_fallback":{"$ref":"#/components/schemas/teams-devices_disable_auto_fallback"},"enabled":{"description":"Whether the policy will be applied to matching devices.","example":true,"type":"boolean"},"exclude":{"$ref":"#/components/schemas/teams-devices_exclude_request"},"exclude_office_ips":{"$ref":"#/components/schemas/teams-devices_exclude_office_ips"},"include":{"$ref":"#/components/schemas/teams-devices_include_request"},"lan_allow_minutes":{"$ref":"#/components/schemas/teams-devices_lan_allow_minutes"},"lan_allow_subnet_size":{"$ref":"#/components/schemas/teams-devices_lan_allow_subnet_size"},"match":{"$ref":"#/components/schemas/teams-devices_schemas-match"},"name":{"description":"The name of the device settings profile.","example":"Allow Developers","maxLength":100,"type":"string"},"precedence":{"$ref":"#/components/schemas/teams-devices_precedence"},"register_interface_ip_with_dns":{"$ref":"#/components/schemas/teams-devices_register_interface_ip_with_dns"},"sccm_vpn_boundary_support":{"$ref":"#/components/schemas/teams-devices_sccm_vpn_boundary_support"},"service_mode_v2":{"$ref":"#/components/schemas/teams-devices_service_mode_v2"},"support_url":{"$ref":"#/components/schemas/teams-devices_support_url"},"switch_locked":{"$ref":"#/components/schemas/teams-devices_switch_locked"},"tunnel_protocol":{"$ref":"#/components/schemas/teams-devices_tunnel_protocol"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_device_settings_response"}}},"description":"Update a device settings profile Policy response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_device_settings_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Update a device settings profile Policy response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a device settings profile","tags":["Devices"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/policy/{policy_id}/exclude":{"get":{"description":"Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile.","operationId":"devices-get-split-tunnel-exclude-list-for-a-device-settings-policy","parameters":[{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_split_tunnel_response_collection"}}},"description":"Get the Split Tunnel exclude list for a device settings profile response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_split_tunnel_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get the Split Tunnel exclude list for a device settings profile response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get the Split Tunnel exclude list for a device settings profile","tags":["Devices"]},"put":{"description":"Sets the list of routes excluded from the WARP client's tunnel for a specific device settings profile.","operationId":"devices-set-split-tunnel-exclude-list-for-a-device-settings-policy","parameters":[{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/teams-devices_split_tunnel"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_split_tunnel_response_collection"}}},"description":"Set the Split Tunnel exclude list for a device settings profile response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_split_tunnel_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Set the Split Tunnel exclude list for a device settings profile response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Set the Split Tunnel exclude list for a device settings profile","tags":["Devices"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/policy/{policy_id}/fallback_domains":{"get":{"description":"Fetches the list of domains to bypass Gateway DNS resolution from a specified device settings profile. These domains will use the specified local DNS resolver instead.","operationId":"devices-get-local-domain-fallback-list-for-a-device-settings-policy","parameters":[{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_fallback_domain_response_collection"}}},"description":"Get the Local Domain Fallback list for a device settings profile response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_fallback_domain_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get the Local Domain Fallback list for a device settings profile response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get the Local Domain Fallback list for a device settings profile","tags":["Devices"]},"put":{"description":"Sets the list of domains to bypass Gateway DNS resolution. These domains will use the specified local DNS resolver instead. This will only apply to the specified device settings profile.","operationId":"devices-set-local-domain-fallback-list-for-a-device-settings-policy","parameters":[{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/teams-devices_fallback_domain"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_fallback_domain_response_collection"}}},"description":"Set the Local Domain Fallback list for a device settings profile response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_fallback_domain_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Set the Local Domain Fallback list for a device settings profile response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Set the Local Domain Fallback list for a device settings profile","tags":["Devices"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/policy/{policy_id}/include":{"get":{"description":"Fetches the list of routes included in the WARP client's tunnel for a specific device settings profile.","operationId":"devices-get-split-tunnel-include-list-for-a-device-settings-policy","parameters":[{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_split_tunnel_include_response_collection"}}},"description":"Get the Split Tunnel include list for a device settings profile response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_split_tunnel_include_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get the Split Tunnel include list for a device settings profile response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get the Split Tunnel include list for a device settings profile","tags":["Devices"]},"put":{"description":"Sets the list of routes included in the WARP client's tunnel for a specific device settings profile.","operationId":"devices-set-split-tunnel-include-list-for-a-device-settings-policy","parameters":[{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/teams-devices_split_tunnel_include"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_split_tunnel_include_response_collection"}}},"description":"Set the Split Tunnel include list for a device settings profile response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_split_tunnel_include_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Set the Split Tunnel include list for a device settings profile response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Set the Split Tunnel include list for a device settings profile","tags":["Devices"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/posture":{"get":{"description":"Fetches device posture rules for a Zero Trust account.","operationId":"device-posture-rules-list-device-posture-rules","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_response_collection"}}},"description":"List device posture rules response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"List device posture rules response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List device posture rules","tags":["Device posture rules"]},"post":{"description":"Creates a new device posture rule.","operationId":"device-posture-rules-create-device-posture-rule","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/teams-devices_description"},"expiration":{"$ref":"#/components/schemas/teams-devices_expiration"},"input":{"$ref":"#/components/schemas/teams-devices_input"},"match":{"$ref":"#/components/schemas/teams-devices_match"},"name":{"$ref":"#/components/schemas/teams-devices_name"},"schedule":{"$ref":"#/components/schemas/teams-devices_schedule"},"type":{"$ref":"#/components/schemas/teams-devices_type"}},"required":["name","type"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_single_response"}}},"description":"Create device posture rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_single_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Create device posture rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a device posture rule","tags":["Device posture rules"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/posture/integration":{"get":{"description":"Fetches the list of device posture integrations for an account.","operationId":"device-posture-integrations-list-device-posture-integrations","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_schemas-response_collection"}}},"description":"List your device posture integrations response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_schemas-response_collection"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"List your device posture integrations response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List your device posture integrations","tags":["Device Posture Integrations"]},"post":{"description":"Create a new device posture integration.","operationId":"device-posture-integrations-create-device-posture-integration","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config":{"$ref":"#/components/schemas/teams-devices_config_request"},"interval":{"$ref":"#/components/schemas/teams-devices_interval"},"name":{"$ref":"#/components/schemas/teams-devices_components-schemas-name"},"type":{"$ref":"#/components/schemas/teams-devices_schemas-type"}},"required":["name","type","interval","config"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_schemas-single_response"}}},"description":"Create a device posture integration response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_schemas-single_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Create a device posture integration response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a device posture integration","tags":["Device Posture Integrations"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/posture/integration/{integration_id}":{"delete":{"description":"Delete a configured device posture integration.","operationId":"device-posture-integrations-delete-device-posture-integration","parameters":[{"in":"path","name":"integration_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_schemas-id_response"}}},"description":"Delete a device posture integration response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_schemas-id_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Delete a device posture integration response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a device posture integration","tags":["Device Posture Integrations"],"x-api-token-group":["Zero Trust Write"]},"get":{"description":"Fetches details for a single device posture integration.","operationId":"device-posture-integrations-device-posture-integration-details","parameters":[{"in":"path","name":"integration_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_schemas-single_response"}}},"description":"Get device posture integration details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_schemas-single_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}],"type":"object"}}},"description":"Get device posture integration details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get device posture integration details","tags":["Device Posture Integrations"]},"patch":{"description":"Updates a configured device posture integration.","operationId":"device-posture-integrations-update-device-posture-integration","parameters":[{"in":"path","name":"integration_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config":{"$ref":"#/components/schemas/teams-devices_config_request"},"interval":{"$ref":"#/components/schemas/teams-devices_interval"},"name":{"$ref":"#/components/schemas/teams-devices_components-schemas-name"},"type":{"$ref":"#/components/schemas/teams-devices_schemas-type"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_schemas-single_response"}}},"description":"Update a device posture integration response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_schemas-single_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Update a device posture integration response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a device posture integration","tags":["Device Posture Integrations"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/posture/{rule_id}":{"delete":{"description":"Deletes a device posture rule.","operationId":"device-posture-rules-delete-device-posture-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_id_response"}}},"description":"Delete a device posture rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_id_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Delete a device posture rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a device posture rule","tags":["Device posture rules"],"x-api-token-group":["Zero Trust Write"]},"get":{"description":"Fetches a single device posture rule.","operationId":"device-posture-rules-device-posture-rules-details","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_single_response"}}},"description":"Get device posture rule details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_single_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get device posture rule details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get device posture rule details","tags":["Device posture rules"]},"put":{"description":"Updates a device posture rule.","operationId":"device-posture-rules-update-device-posture-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/teams-devices_description"},"expiration":{"$ref":"#/components/schemas/teams-devices_expiration"},"input":{"$ref":"#/components/schemas/teams-devices_input"},"match":{"$ref":"#/components/schemas/teams-devices_match"},"name":{"$ref":"#/components/schemas/teams-devices_name"},"schedule":{"$ref":"#/components/schemas/teams-devices_schedule"},"type":{"$ref":"#/components/schemas/teams-devices_type"}},"required":["name","type"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_single_response"}}},"description":"Update a device posture rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_single_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Update a device posture rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a device posture rule","tags":["Device posture rules"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/registrations":{"delete":{"description":"Deletes a list of WARP registrations.","operationId":"delete-registrations","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"description":"A list of registration IDs to delete.","in":"query","name":"id","required":true,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"result":{"$ref":"#/components/schemas/teams-devices_empty_body"},"result_info":{"$ref":"#/components/schemas/teams-devices_cursor_result_info"},"success":{"description":"Whether the API call was successful.","type":"boolean"}},"required":["result","success","errors","messages"],"type":"object"}}},"description":"Delete a list of registrations response."}},"security":[{"api_token":[]}],"summary":"Delete registrations","tags":["Physical Devices"],"x-api-token-group":["Zero Trust Write"]},"get":{"description":"Lists WARP registrations.","operationId":"list-registrations","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/teams-devices_devices_list_registrations_param_user_id"},{"$ref":"#/components/parameters/teams-devices_devices_list_registrations_param_seen_after"},{"$ref":"#/components/parameters/teams-devices_devices_list_registrations_param_seen_before"},{"$ref":"#/components/parameters/teams-devices_devices_list_registrations_param_status"},{"$ref":"#/components/parameters/teams-devices_devices_list_registrations_param_per_page"},{"$ref":"#/components/parameters/teams-devices_devices_list_registrations_param_search"},{"$ref":"#/components/parameters/teams-devices_devices_list_registrations_param_sort_by"},{"$ref":"#/components/parameters/teams-devices_devices_list_registrations_param_sort_order"},{"$ref":"#/components/parameters/teams-devices_devices_list_registrations_param_cursor"},{"$ref":"#/components/parameters/teams-devices_devices_list_registrations_param_id"},{"$ref":"#/components/parameters/teams-devices_devices_list_registrations_param_device_id"},{"$ref":"#/components/parameters/teams-devices_devices_list_registrations_param_include"}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":[{"created_at":"2025-02-14T13:17:00Z","deleted_at":null,"device":{"client_version":"1.0.0","id":"32aa0404-78f1-49a4-99e0-97f575081356","name":"My Device"},"id":"11ffb86f-3f0c-4306-b4a2-e62f872b166a","key":"U+QTP50RsWfeLGHF4tlGDnmGeuwtsz46KCHr5OyhWq00Rsdfl45mgnQAuEJ6CO0YrkyTl9FUf5iB0bwYR3g4EEFEHhtu6jFaqfMrBMBSz6itv9HQXkaR9OieKQ==","key_type":"secp256r1","last_seen_at":"2025-02-14T13:17:00Z","revoked_at":null,"tunnel_type":"masque","updated_at":"2025-02-14T13:17:00Z","user":{"email":"alice@example.org","id":"30323c1f-318d-4ec9-92c7-5a8c4d25c4fc","name":"Alice"}},{"created_at":"2025-02-15T10:20:00Z","deleted_at":null,"device":{"client_version":"1.0.1","id":"43bb1515-8902-50b5-aa01-a88686192467","name":"Bob's Laptop"},"id":"22eedc7a-4a1d-5417-c5b3-f73a983c277b","key":"V/RSP61StXgfmLHJG5umHEonHfvxtz57LDIs6PziXr11Stegm56nhrRBvFK7DP1ZsLzUm0GVg6jC1cxZS4h5FFGFJiju7kGbrgNsCNCT77juw0IRYlS0QpjgLR==","key_type":"secp256r1","last_seen_at":"2025-02-15T10:25:00Z","revoked_at":null,"tunnel_type":"masque","updated_at":"2025-02-15T10:25:00Z","user":{"email":"bob@example.com","id":"41434d2a-429e-5fd0-a3d8-6b9d5e36d5ad","name":"Bob"}}],"result_info":{"count":2,"cursor":"ais86dftf.asdf7ba8","per_page":10,"total_count":null},"success":true},"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"result":{"items":{"$ref":"#/components/schemas/teams-devices_registration"},"type":"array"},"result_info":{"$ref":"#/components/schemas/teams-devices_cursor_result_info"},"success":{"description":"Whether the API call was successful.","type":"boolean"}},"required":["result","success","errors","messages"],"type":"object"}}},"description":"List of registrations response."}},"security":[{"api_token":[]}],"summary":"List registrations","tags":["Registrations"]}},"/accounts/{account_id}/devices/registrations/revoke":{"post":{"description":"Revokes a list of WARP registrations.","operationId":"revoke-registrations","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"description":"A list of registration IDs to revoke.","in":"query","name":"id","required":true,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"result":{"$ref":"#/components/schemas/teams-devices_empty_body"},"result_info":{"$ref":"#/components/schemas/teams-devices_cursor_result_info"},"success":{"description":"Whether the API call was successful.","type":"boolean"}},"required":["result","success","errors","messages"],"type":"object"}}},"description":"Revoke registrations response."}},"security":[{"api_token":[]}],"summary":"Revoke registrations","tags":["Registrations"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/registrations/unrevoke":{"post":{"description":"Unrevokes a list of WARP registrations.","operationId":"unrevoke-registrations","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"description":"A list of registration IDs to unrevoke.","in":"query","name":"id","required":true,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"result":{"$ref":"#/components/schemas/teams-devices_empty_body"},"result_info":{"$ref":"#/components/schemas/teams-devices_cursor_result_info"},"success":{"description":"Whether the API call was successful.","type":"boolean"}},"required":["result","success","errors","messages"],"type":"object"}}},"description":"Unrevoke registrations response."}},"security":[{"api_token":[]}],"summary":"Unrevoke registrations","tags":["Registrations"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/registrations/{registration_id}":{"delete":{"description":"Deletes a WARP registration.","operationId":"delete-registration","parameters":[{"in":"path","name":"registration_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"result":{"$ref":"#/components/schemas/teams-devices_empty_body"},"success":{"description":"Whether the API call was successful.","type":"boolean"}},"required":["success","errors","messages"],"type":"object"}}},"description":"Registration deleted response."}},"security":[{"api_token":[]}],"summary":"Delete registration","tags":["Registrations"],"x-api-token-group":["Zero Trust Write"]},"get":{"description":"Fetches a single WARP registration.","operationId":"get-registration","parameters":[{"in":"path","name":"registration_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/teams-devices_devices_get_registration_param_include"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"result":{"$ref":"#/components/schemas/teams-devices_registration"},"success":{"description":"Whether the API call was successful.","type":"boolean"}},"required":["result","success","errors","messages"],"type":"object"}}},"description":"Returns a Registration."}},"security":[{"api_token":[]}],"summary":"Get registration","tags":["Registrations"]}},"/accounts/{account_id}/devices/registrations/{registration_id}/override_codes":{"get":{"description":"Fetches one-time use admin override codes for a registration. This relies on the **Admin Override** setting being enabled in your device configuration.","operationId":"get-registration-override-codes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"registration_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/teams-devices_v4_response_message"},"type":"array"},"result":{"$ref":"#/components/schemas/teams-devices_override_codes"},"success":{"description":"Whether the API call was successful.","type":"boolean"}},"required":["result","success","errors","messages"],"type":"object"}}},"description":"Get admin override codes for a registration response."}},"security":[{"api_token":[]}],"summary":"Get override codes","tags":["warp-teams-device-api_other"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]}},"/accounts/{account_id}/devices/resilience/disconnect":{"get":{"description":"Fetch the Global WARP override state.","operationId":"devices-resilience-retrieve-global-warp-override","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_global_warp_override_response"}}},"description":"Fetch Global WARP override state response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Fetch Global WARP override state failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve Global WARP override state","tags":["Devices Resilience"],"x-api-token-group":["Zero Trust Resilience Read","Zero Trust Resilience Write","Zero Trust Read","Zero Trust Write"]},"post":{"description":"Sets the Global WARP override state.","operationId":"devices-resilience-set-global-warp-override","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_global_warp_override_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_global_warp_override_response"}}},"description":"Set Global WARP override state response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Set Global WARP override state response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Set Global WARP override state","tags":["Devices Resilience"],"x-api-token-group":["Zero Trust Resilience Write"]}},"/accounts/{account_id}/devices/revoke":{"post":{"deprecated":true,"description":"Revokes a list of devices. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled.\n\n**Deprecated**: please use POST /accounts/{account_id}/devices/registrations/revoke instead.\n","operationId":"devices-revoke-devices","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_revoke_devices_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_api-response-single"}}},"description":"Revoke devices response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Revoke devices response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Revoke devices (deprecated)","tags":["Devices"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/settings":{"delete":{"description":"Resets the current device settings for a Zero Trust account.","operationId":"zero-trust-accounts-delete-device-settings-for-zero-trust-account","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_zero-trust-account-device-settings-response"}}},"description":"Reset response for device settings for a Zero Trust account."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_zero-trust-account-device-settings-response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Reset failure response device settings for a Zero Trust account."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Reset device settings for a Zero Trust account with defaults. This turns off all proxying.","tags":["Zero Trust accounts"],"x-api-token-group":["Zero Trust Write"]},"get":{"description":"Describes the current device settings for a Zero Trust account.","operationId":"zero-trust-accounts-get-device-settings-for-zero-trust-account","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_zero-trust-account-device-settings-response"}}},"description":"Get device settings for a Zero Trust account response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_zero-trust-account-device-settings-response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get device settings for a Zero Trust account response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get device settings for a Zero Trust account","tags":["Zero Trust accounts"]},"patch":{"description":"Patches the current device settings for a Zero Trust account.","operationId":"zero-trust-accounts-patch-device-settings-for-the-zero-trust-account","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_zero-trust-account-device-settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_zero-trust-account-device-settings-response"}}},"description":"Patch device settings for a Zero Trust account response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_zero-trust-account-device-settings-response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Patch device settings for a Zero Trust account response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch device settings for a Zero Trust account","tags":["Zero Trust accounts"],"x-api-token-group":["Zero Trust Write"]},"put":{"description":"Updates the current device settings for a Zero Trust account.","operationId":"zero-trust-accounts-update-device-settings-for-the-zero-trust-account","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_zero-trust-account-device-settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_zero-trust-account-device-settings-response"}}},"description":"Update device settings for a Zero Trust account response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_zero-trust-account-device-settings-response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Update device settings for a Zero Trust account response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update device settings for a Zero Trust account","tags":["Zero Trust accounts"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/unrevoke":{"post":{"deprecated":true,"description":"Unrevokes a list of devices. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled.\n\n**Deprecated**: please use POST /accounts/{account_id}/devices/registrations/unrevoke instead.\n","operationId":"devices-unrevoke-devices","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_unrevoke_devices_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_api-response-single"}}},"description":"Unrevoke devices response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_api-response-single"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Unrevoke devices response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Unrevoke devices (deprecated)","tags":["Devices"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/devices/{device_id}":{"get":{"deprecated":true,"description":"Fetches a single WARP device. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled for the account.\n\n**Deprecated**: please use one of the following endpoints instead:\n- GET /accounts/{account_id}/devices/physical-devices/{device_id}\n- GET /accounts/{account_id}/devices/registrations/{registration_id}\n","operationId":"devices-device-details","parameters":[{"in":"path","name":"device_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_registration_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_device_response"}}},"description":"Get device details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_device_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get device details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get device (deprecated)","tags":["Devices"]}},"/accounts/{account_id}/devices/{device_id}/override_codes":{"get":{"deprecated":true,"description":"Fetches a one-time use admin override code for a device. This relies on the **Admin Override** setting being enabled in your device configuration. Not supported when [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/) is enabled for the account.\n**Deprecated:** please use GET /accounts/{account_id}/devices/registrations/{registration_id}/override_codes instead.\n","operationId":"devices-list-admin-override-code-for-device","parameters":[{"in":"path","name":"device_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_registration_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_override_codes_response"}}},"description":"Get an admin override code for a device response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_override_codes_response"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get an admin override code for a device response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get override codes (deprecated)\n","tags":["Devices"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]}},"/accounts/{account_id}/dex/colos":{"get":{"description":"List Cloudflare colos that account's devices were connected to during a time period, sorted by usage starting from the most used colo. Colos without traffic are also returned and sorted alphabetically.","operationId":"dex-endpoints-list-colos","parameters":[{"description":"unique identifier linked to an account in the API request path.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"Start time for connection period in ISO (RFC3339 - ISO 8601) format","in":"query","name":"from","required":true,"schema":{"example":"2023-08-20T20:45:00Z","type":"string"}},{"description":"End time for connection period in ISO (RFC3339 - ISO 8601) format","in":"query","name":"to","required":true,"schema":{"example":"2023-08-24T20:45:00Z","type":"string"}},{"description":"Type of usage that colos should be sorted by. If unspecified, returns all Cloudflare colos sorted alphabetically.","in":"query","name":"sortBy","schema":{"enum":["fleet-status-usage","application-tests-usage"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_colos_response"}}}]}}},"description":"List colos response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"List colos failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List Cloudflare colos","tags":["DEX Synthetic Application Monitoring"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/commands":{"get":{"description":"Retrieves a paginated list of commands issued to devices under the specified account, optionally filtered by time range, device, or other parameters","operationId":"get-commands","parameters":[{"description":"unique identifier linked to an account in the API request path","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"Page number for pagination","in":"query","name":"page","required":true,"schema":{"example":1,"type":"number"}},{"description":"Number of results per page","in":"query","name":"per_page","required":true,"schema":{"example":50,"type":"number"}},{"description":"Start time for the query in ISO (RFC3339 - ISO 8601) format","in":"query","name":"from","schema":{"example":"2023-08-20T20:45:00Z","format":"date-time","type":"string"}},{"description":"End time for the query in ISO (RFC3339 - ISO 8601) format","in":"query","name":"to","schema":{"example":"2023-08-24T20:45:00Z","format":"date-time","type":"string"}},{"description":"Unique identifier for a device","in":"query","name":"device_id","schema":{"type":"string"}},{"description":"Email tied to the device","in":"query","name":"user_email","schema":{"type":"string"}},{"description":"Optionally filter executed commands by command type","in":"query","name":"command_type","schema":{"type":"string"}},{"description":"Optionally filter executed commands by status","in":"query","name":"status","schema":{"enum":["PENDING_EXEC","PENDING_UPLOAD","SUCCESS","FAILED"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_get_commands_response"}}}]}}},"description":"Get commands response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"Get commands failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List account commands","tags":["DEX Remote Commands"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]},"post":{"description":"Initiate commands for up to 10 devices per account","operationId":"post-commands","parameters":[{"description":"unique identifier linked to an account in the API request path","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"commands":{"description":"List of device-level commands to execute","items":{"properties":{"command_args":{"additionalProperties":false,"properties":{"interfaces":{"description":"List of interfaces to capture packets on","items":{"enum":["default","tunnel"],"type":"string","x-auditable":true},"type":"array"},"max-file-size-mb":{"default":5,"description":"Maximum file size (in MB) for the capture file. Specifies the maximum file size of the warp-diag zip artifact that can be uploaded. If the zip artifact exceeds the specified max file size, it will NOT be uploaded","minimum":1,"type":"number","x-auditable":true},"packet-size-bytes":{"default":160,"description":"Maximum number of bytes to save for each packet","minimum":1,"type":"number","x-auditable":true},"test-all-routes":{"default":true,"description":"Test an IP address from all included or excluded ranges. Tests an IP address from all included or excluded ranges. Essentially the same as running 'route get \u003cip\u003e'' and collecting the results. This option may increase the time taken to collect the warp-diag","type":"boolean","x-auditable":true},"time-limit-min":{"default":5,"description":"Limit on capture duration (in minutes)","minimum":1,"type":"number","x-auditable":true}},"type":"object"},"command_type":{"description":"Type of command to execute on the device","enum":["pcap","warp-diag"],"type":"string","x-auditable":true},"device_id":{"description":"Unique identifier for the device","type":"string"},"user_email":{"description":"Email tied to the device","type":"string"}},"required":["device_id","user_email","command_type"],"type":"object"},"maxItems":20,"type":"array"}},"required":["commands"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_post_commands_response"}}}]}}},"description":"Create commands response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"Create commands failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Create account commands","tags":["DEX Remote Commands"],"x-api-token-group":["Cloudflare DEX Write"]}},"/accounts/{account_id}/dex/commands/devices":{"get":{"description":"List devices with WARP client support for remote captures which have been connected in the last 1 hour.","operationId":"get-commands-eligible-devices","parameters":[{"description":"unique identifier linked to an account in the API request path","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"Page number of paginated results","in":"query","name":"page","required":true,"schema":{"minimum":1,"type":"number"}},{"description":"Number of items per page","in":"query","name":"per_page","required":true,"schema":{"maximum":50,"minimum":1,"type":"number"}},{"description":"Filter devices by name or email","in":"query","name":"search","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_commands_devices_response"}}}]}}},"description":"List of eligible devices"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"List eligible devices failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List devices eligible for remote captures","tags":["DEX Remote Commands"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/commands/quota":{"get":{"description":"Retrieves the current quota usage and limits for device commands within a specific account, including the time when the quota will reset","operationId":"get-commands-quota","parameters":[{"description":"unique identifier linked to an account in the API request path","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_get_commands_quota_response"}}}]}}},"description":"Get commands quota response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"Get commands quota failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Returns account commands usage, quota, and reset time","tags":["DEX Remote Commands"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/commands/{command_id}/downloads/{filename}":{"get":{"description":"Downloads artifacts for an executed command. Bulk downloads are not supported","operationId":"get-commands-command-id-downloads-filename","parameters":[{"description":"unique identifier linked to an account in the API request path","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"Unique identifier for command","in":"path","name":"command_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_command_id"}},{"description":"The name of the file to be downloaded, including the `.zip` extension","in":"path","name":"filename","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"Get command artifacts response","headers":{"Accept-Ranges":{"description":"Indicates that the file supports byte-range requests","schema":{"example":"bytes","type":"string"}},"Content-Disposition":{"description":"Indicates that the file should be treated as an attachment for downloading","schema":{"example":"attachment; filename*=example.zip","type":"string"}},"Content-Encoding":{"description":"Specifies the encoding of the file content, if any","schema":{"example":"gzip","type":"string"}},"Content-Length":{"description":"The size of the file in bytes","schema":{"type":"integer"}},"Content-Type":{"description":"Specifies the media type of the file","schema":{"example":"application/zip","type":"string"}},"ETag":{"description":"The entity tag of the file for cache validation","schema":{"example":"34f9b5e9c8a6","type":"string"}},"Last-Modified":{"description":"The last modification date of the file","schema":{"example":"Wed, 21 Oct 2023 07:28:00 GMT","format":"date-time","type":"string"}}}},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"Get downloaded commands failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Download command output file","tags":["DEX Remote Commands"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/devices/dex_tests":{"get":{"description":"Fetch all DEX tests","operationId":"device-dex-test-details","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_dex-response_collection"}}},"description":"Device DEX test details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_dex-single_response"},{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}]}}},"description":"Device DEX test response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Device DEX tests","tags":["Device DEX Tests"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]},"post":{"description":"Create a DEX test.","operationId":"device-dex-test-create-device-dex-test","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_device-dex-test-schemas-http"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_dex-single_response"}}},"description":"Update Dex test response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_dex-single_response"},{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}]}}},"description":"Update Dex test response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create Device DEX test","tags":["Device DEX Tests"],"x-api-token-group":["Cloudflare DEX Write"]}},"/accounts/{account_id}/dex/devices/dex_tests/{dex_test_id}":{"delete":{"description":"Delete a Device DEX test. Returns the remaining device dex tests for the account.","operationId":"device-dex-test-delete-device-dex-test","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"in":"path","name":"dex_test_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_dex-delete-response-collection"}}},"description":"Delete Device DEX test response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_dex-response_collection"},{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}]}}},"description":"Delete DEX test response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete Device DEX test","tags":["Device DEX Tests"],"x-api-token-group":["Cloudflare DEX Write"]},"get":{"description":"Fetch a single DEX test.","operationId":"device-dex-test-get-device-dex-test","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"in":"path","name":"dex_test_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_schemas-test-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_dex-single_response"}}},"description":"Device DEX test details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_dex-single_response"},{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}]}}},"description":"Device DEX test response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Device DEX test","tags":["Device DEX Tests"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]},"put":{"description":"Update a DEX test.","operationId":"device-dex-test-update-device-dex-test","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"in":"path","name":"dex_test_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_device-dex-test-schemas-http"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_dex-single_response"}}},"description":"Update Dex test response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_dex-single_response"},{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}]}}},"description":"Update Dex test response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update Device DEX test","tags":["Device DEX Tests"],"x-api-token-group":["Cloudflare DEX Write"]}},"/accounts/{account_id}/dex/devices/{device_id}/fleet-status/live":{"get":{"description":"Get the live status of a latest device given device_id from the device_state table","operationId":"devices-live-status","parameters":[{"description":"Unique identifier for account","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"Unique identifier for device","in":"path","name":"device_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_device_id"}},{"description":"Number of minutes before current time","in":"query","name":"since_minutes","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_since_minutes"}},{"description":"Number of minutes before current time","in":"query","name":"time_now","schema":{"$ref":"#/components/schemas/digital-experience-monitoring_time_now"}},{"description":"List of data centers to filter results","in":"query","name":"colo","schema":{"$ref":"#/components/schemas/digital-experience-monitoring_colo"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_device"}}},"description":"Get the live status of a latest device"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}]}}},"description":"Get the live status of a latest device failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get the live status of a latest device","tags":["DEX Synthetic Application Monitoring"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/fleet-status/devices":{"get":{"description":"List details for devices using WARP","operationId":"dex-fleet-status-devices","parameters":[{"description":"Unique identifier for account","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"Time range end in ISO format","in":"query","name":"to","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_timestamp"}},{"description":"Time range beginning in ISO format","in":"query","name":"from","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_timestamp"}},{"description":"Page number","in":"query","name":"page","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_page"}},{"description":"Number of results per page","in":"query","name":"per_page","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_per_page"}},{"description":"Dimension to sort results by","in":"query","name":"sort_by","schema":{"$ref":"#/components/schemas/digital-experience-monitoring_sort_by"}},{"description":"Cloudflare colo","in":"query","name":"colo","schema":{"$ref":"#/components/schemas/digital-experience-monitoring_colo"}},{"description":"Device-specific ID, given as UUID v4","in":"query","name":"device_id","schema":{"$ref":"#/components/schemas/digital-experience-monitoring_device_id"}},{"description":"The mode under which the WARP client is run","in":"query","name":"mode","schema":{"$ref":"#/components/schemas/digital-experience-monitoring_mode"}},{"description":"Network status","in":"query","name":"status","schema":{"$ref":"#/components/schemas/digital-experience-monitoring_status"}},{"description":"Operating system","in":"query","name":"platform","schema":{"$ref":"#/components/schemas/digital-experience-monitoring_platform"}},{"description":"WARP client version","in":"query","name":"version","schema":{"$ref":"#/components/schemas/digital-experience-monitoring_version"}},{"description":"Source:\n  * `hourly` - device details aggregated hourly, up to 7 days prior\n  * `last_seen` - device details, up to 24 hours prior\n  * `raw` - device details, up to 7 days prior\n","in":"query","name":"source","schema":{"$ref":"#/components/schemas/digital-experience-monitoring_source"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_fleet_status_devices_response"}}},"description":"List devices response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}]}}},"description":"List devices response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List fleet status devices","tags":["DEX Synthetic Application Monitoring"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/fleet-status/live":{"get":{"description":"List details for live (up to 60 minutes) devices using WARP","operationId":"dex-fleet-status-live","parameters":[{"description":"Unique identifier for account","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"Number of minutes before current time","in":"query","name":"since_minutes","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_since_minutes"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_fleet_status_live_response"}}},"description":"List device details (live) response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}]}}},"description":"List device details (live) response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List fleet status details by dimension","tags":["DEX Synthetic Application Monitoring"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/fleet-status/over-time":{"get":{"description":"List details for devices using WARP, up to 7 days","operationId":"dex-fleet-status-over-time","parameters":[{"description":"Unique identifier for account","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"Time range end in ISO format","in":"query","name":"to","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_timestamp"}},{"description":"Time range beginning in ISO format","in":"query","name":"from","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_timestamp"}},{"description":"Cloudflare colo","in":"query","name":"colo","schema":{"$ref":"#/components/schemas/digital-experience-monitoring_colo"}},{"description":"Device-specific ID, given as UUID v4","in":"query","name":"device_id","schema":{"$ref":"#/components/schemas/digital-experience-monitoring_device_id"}}],"responses":{"200":{"description":"List DEX devices response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}]}}},"description":"DEX HTTP test details failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List fleet status aggregate details by dimension","tags":["DEX Synthetic Application Monitoring"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/http-tests/{test_id}":{"get":{"description":"Get test details and aggregate performance metrics for an http test for a given time period between 1 hour and 7 days.","operationId":"dex-endpoints-http-test-details","parameters":[{"description":"unique identifier linked to an account in the API request path.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"unique identifier for a specific test","in":"path","name":"test_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"}},{"description":"Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.","in":"query","name":"deviceId","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Start time for aggregate metrics in ISO ms","in":"query","name":"from","required":true,"schema":{"example":1689520412000,"type":"string"}},{"description":"End time for aggregate metrics in ISO ms","in":"query","name":"to","required":true,"schema":{"example":1689606812000,"type":"string"}},{"description":"Time interval for aggregate time slots.","in":"query","name":"interval","required":true,"schema":{"enum":["minute","hour"],"type":"string"}},{"description":"Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.","in":"query","name":"colo","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_http_details_response"}}}]}}},"description":"DEX HTTP test details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"DEX HTTP test details failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get details and aggregate metrics for an http test","tags":["DEX Synthetic Application Monitoring"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/http-tests/{test_id}/percentiles":{"get":{"description":"Get percentiles for an http test for a given time period between 1 hour and 7 days.","operationId":"dex-endpoints-http-test-percentiles","parameters":[{"description":"unique identifier linked to an account in the API request path.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"unique identifier for a specific test","in":"path","name":"test_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"}},{"description":"Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.","in":"query","name":"deviceId","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Start time for the query in ISO (RFC3339 - ISO 8601) format","in":"query","name":"from","required":true,"schema":{"example":"2023-09-20T17:00:00Z","type":"string"}},{"description":"End time for the query in ISO (RFC3339 - ISO 8601) format","in":"query","name":"to","required":true,"schema":{"example":"2023-09-20T17:00:00Z","type":"string"}},{"description":"Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.","in":"query","name":"colo","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_http_details_percentiles_response"}}}]}}},"description":"DEX HTTP test percentiles response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"DEX HTTP test percentiles failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get percentiles for an http test","tags":["DEX Synthetic Application Monitoring"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/tests/overview":{"get":{"description":"List DEX tests with overview metrics","operationId":"dex-endpoints-list-tests-overview","parameters":[{"description":"unique identifier linked to an account in the API request path.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.","in":"query","name":"colo","schema":{"type":"string"}},{"description":"Optionally filter results by test name","in":"query","name":"testName","schema":{"type":"string"}},{"description":"Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.","in":"query","name":"deviceId","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Page number of paginated results","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"number"}},{"description":"Number of items per page","in":"query","name":"per_page","schema":{"default":10,"maximum":50,"minimum":1,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_tests_response"}}}]}}},"description":"success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List DEX test analytics","tags":["DEX Synthetic Application Monitoring"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/tests/unique-devices":{"get":{"description":"Returns unique count of devices that have run synthetic application monitoring tests in the past 7 days.","operationId":"dex-endpoints-tests-unique-devices","parameters":[{"description":"unique identifier linked to an account in the API request path.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"Optionally filter results by test name","in":"query","name":"testName","schema":{"type":"string"}},{"description":"Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.","in":"query","name":"deviceId","schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_unique_devices_response"}}}]}}},"description":"DEX unique devices targeted response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"DEX unique devices targeted failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get count of devices targeted","tags":["DEX Synthetic Application Monitoring"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/traceroute-test-results/{test_result_id}/network-path":{"get":{"description":"Get a breakdown of hops and performance metrics for a specific traceroute test run","operationId":"dex-endpoints-traceroute-test-result-network-path","parameters":[{"description":"unique identifier linked to an account","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"unique identifier for a specific traceroute test","in":"path","name":"test_result_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_traceroute_test_result_network_path_response"}}}]}}},"description":"DEX traceroute test result network path response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"DEX traceroute test result network path failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get details for a specific traceroute test run","tags":["DEX Synthetic Application Monitoring"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/traceroute-tests/{test_id}":{"get":{"description":"Get test details and aggregate performance metrics for an traceroute test for a given time period between 1 hour and 7 days.","operationId":"dex-endpoints-traceroute-test-details","parameters":[{"description":"Unique identifier linked to an account","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"Unique identifier for a specific test","in":"path","name":"test_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"}},{"description":"Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.","in":"query","name":"deviceId","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Start time for aggregate metrics in ISO ms","in":"query","name":"from","required":true,"schema":{"example":1689520412000,"type":"string"}},{"description":"End time for aggregate metrics in ISO ms","in":"query","name":"to","required":true,"schema":{"example":1689606812000,"type":"string"}},{"description":"Time interval for aggregate time slots.","in":"query","name":"interval","required":true,"schema":{"enum":["minute","hour"],"type":"string"}},{"description":"Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.","in":"query","name":"colo","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_traceroute_details_response"}}}]}}},"description":"DEX traceroute test details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"DEX traceroute test details response failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get details and aggregate metrics for a traceroute test","tags":["DEX Synthetic Application Monitoring"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path":{"get":{"description":"Get a breakdown of metrics by hop for individual traceroute test runs","operationId":"dex-endpoints-traceroute-test-network-path","parameters":[{"description":"unique identifier linked to an account","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"unique identifier for a specific test","in":"path","name":"test_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"}},{"description":"Device to filter tracroute result runs to","in":"query","name":"deviceId","required":true,"schema":{"type":"string"}},{"description":"Start time for aggregate metrics in ISO ms","in":"query","name":"from","required":true,"schema":{"example":1689520412000,"type":"string"}},{"description":"End time for aggregate metrics in ISO ms","in":"query","name":"to","required":true,"schema":{"example":1689606812000,"type":"string"}},{"description":"Time interval for aggregate time slots.","in":"query","name":"interval","required":true,"schema":{"enum":["minute","hour"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_traceroute_test_network_path_response"}}}]}}},"description":"DEX traceroute test network path response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"DEX traceroute test network path failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get network path breakdown for a traceroute test","tags":["DEX Synthetic Application Monitoring"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles":{"get":{"description":"Get percentiles for a traceroute test for a given time period between 1 hour and 7 days.","operationId":"dex-endpoints-traceroute-test-percentiles","parameters":[{"description":"unique identifier linked to an account in the API request path.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"unique identifier for a specific test","in":"path","name":"test_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_uuid"}},{"description":"Optionally filter result stats to a specific device(s). Cannot be used in combination with colo param.","in":"query","name":"deviceId","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Start time for the query in ISO (RFC3339 - ISO 8601) format","in":"query","name":"from","required":true,"schema":{"example":"2023-09-20T17:00:00Z","type":"string"}},{"description":"End time for the query in ISO (RFC3339 - ISO 8601) format","in":"query","name":"to","required":true,"schema":{"example":"2023-09-20T17:00:00Z","type":"string"}},{"description":"Optionally filter result stats to a Cloudflare colo. Cannot be used in combination with deviceId param.","in":"query","name":"colo","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_traceroute_details_percentiles_response"}}}]}}},"description":"DEX Traceroute test percentiles response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"DEX Traceroute test percentiles failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get percentiles for a traceroute test","tags":["DEX Synthetic Application Monitoring"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/dex/warp-change-events":{"get":{"description":"List WARP configuration and enablement toggle change events by device.","operationId":"list-warp-change-events","parameters":[{"description":"unique identifier linked to an account in the API request path","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_account_identifier"}},{"description":"Page number of paginated results","in":"query","name":"page","required":true,"schema":{"minimum":1,"type":"number"}},{"description":"Number of items per page","in":"query","name":"per_page","required":true,"schema":{"maximum":50,"minimum":1,"type":"number"}},{"description":"Start time for the query in ISO (RFC3339 - ISO 8601) format","in":"query","name":"from","required":true,"schema":{"example":"2023-09-20T17:00:00Z","type":"string"}},{"description":"End time for the query in ISO (RFC3339 - ISO 8601) format","in":"query","name":"to","required":true,"schema":{"example":"2023-09-20T17:00:00Z","type":"string"}},{"description":"Filter events by type 'config' or 'toggle'","in":"query","name":"type","schema":{"enum":["config","toggle"],"type":"string"}},{"description":"Filter events by type toggle value. Applicable to type='toggle' events only.","in":"query","name":"toggle","schema":{"enum":["on","off"],"type":"string"}},{"description":"Filter events by WARP configuration name changed from or to. Applicable to type='config' events only.","in":"query","name":"config_name","schema":{"example":"MASQUE","type":"string"}},{"description":"Filter events by account name.","in":"query","name":"account_name","schema":{"example":"Myorg","type":"string"}},{"description":"Sort response by event timestamp.","in":"query","name":"sort_order","schema":{"default":"ASC","enum":["ASC","DESC"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/digital-experience-monitoring_warp_events_response"}}}]}}},"description":"success response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/digital-experience-monitoring_api-response-common-failure"}}},"description":"List WARP change events failure response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List WARP change events.","tags":["WARP Change Events"],"x-api-token-group":["Cloudflare DEX Write","Cloudflare DEX Read","Zero Trust Report","Zero Trust Read"]}},"/accounts/{account_id}/diagnostics/endpoint-healthchecks":{"get":{"description":"List Endpoint Health Checks.","operationId":"diagnostics-endpoint-healthcheck-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-transit_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-transit_endpoint_health_check_response_single"}}},"description":"Endpoint Health Checks for account."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-transit_api-response-common-failure"}]}}},"description":"Endpoint Health Check response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Endpoint Health Checks","tags":["Endpoint Health Checks"],"x-api-token-group":["Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create Endpoint Health Check.","operationId":"diagnostics-endpoint-healthcheck-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-transit_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-transit_endpoint_health_check"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-transit_endpoint_health_check_response_single"}}},"description":"Endpoint Health Check response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-transit_api-response-common-failure"}]}}},"description":"Endpoint Health Check response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Endpoint Health Check","tags":["Endpoint Health Checks"],"x-api-token-group":["Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}":{"delete":{"description":"Delete Endpoint Health Check.","operationId":"diagnostics-endpoint-healthcheck-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-transit_identifier"}},{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/magic-transit_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-transit_api-response-common"}}},"description":"Endpoint Health Checks response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-transit_api-response-common-failure"}]}}},"description":"Endpoint Health Check failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Endpoint Health Check","tags":["Endpoint Health Checks"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get a single Endpoint Health Check.","operationId":"diagnostics-endpoint-healthcheck-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-transit_identifier"}},{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/magic-transit_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-transit_endpoint_health_check_response_single"}}},"description":"Endpoint Health Checks response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-transit_traceroute_response_collection"},{"$ref":"#/components/schemas/magic-transit_api-response-common-failure"}]}}},"description":"Endpoint Health Check failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Endpoint Health Check","tags":["Endpoint Health Checks"],"x-api-token-group":["Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update a Endpoint Health Check.","operationId":"diagnostics-endpoint-healthcheck-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-transit_identifier"}},{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/magic-transit_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-transit_endpoint_health_check"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-transit_endpoint_health_check_response_single"}}},"description":"Endpoint Health Checks response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-transit_api-response-common-failure"}]}}},"description":"Endpoint Health Check failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Endpoint Health Check","tags":["Endpoint Health Checks"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/diagnostics/traceroute":{"post":{"description":"Run traceroutes from Cloudflare colos.","operationId":"diagnostics-traceroute","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-transit_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"colos":{"$ref":"#/components/schemas/magic-transit_colos"},"options":{"$ref":"#/components/schemas/magic-transit_options"},"targets":{"$ref":"#/components/schemas/magic-transit_targets"}},"required":["targets"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-transit_traceroute_response_collection"}}},"description":"Traceroute response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-transit_traceroute_response_collection"},{"$ref":"#/components/schemas/magic-transit_api-response-common-failure"}]}}},"description":"Traceroute response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Traceroute","tags":["Diagnostics"],"x-api-token-group":["Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/dlp/datasets":{"get":{"operationId":"dlp-datasets-read-all","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dlp_Dataset"},"type":"array"}},"type":"object"}]}}},"description":"Datasets read successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Datasets read failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Fetch all datasets","tags":["DLP Datasets"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"post":{"operationId":"dlp-datasets-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"case_sensitive":{"description":"Only applies to custom word lists.\nDetermines if the words should be matched in a case-sensitive manner\nCannot be set to false if `secret` is true or undefined","type":"boolean"},"description":{"description":"The description of the dataset.","nullable":true,"type":"string"},"encoding_version":{"description":"Dataset encoding version\n\nNon-secret custom word lists with no header are always version 1.\nSecret EDM lists with no header are version 1.\nMulticolumn CSV with headers are version 2.\nOmitting this field provides the default value 0, which is interpreted\nthe same as 1.","format":"int32","minimum":0,"type":"integer"},"name":{"type":"string"},"secret":{"description":"Generate a secret dataset.\n\nIf true, the response will include a secret to use with the EDM encoder.\nIf false, the response has no secret and the dataset is uploaded in plaintext.","type":"boolean"}},"required":["name"],"type":"object"}}},"description":"Dataset description.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"dataset":{"$ref":"#/components/schemas/dlp_Dataset"},"encoding_version":{"description":"Encoding version to use for dataset.","format":"int32","minimum":0,"type":"integer"},"max_cells":{"format":"int64","minimum":0,"type":"integer"},"secret":{"description":"The secret to use for Exact Data Match datasets.\n\nThis is not present in Custom Wordlists.","format":"password","type":"string"},"version":{"description":"The version to use when uploading the dataset.","format":"int64","type":"integer"}},"required":["version","max_cells","dataset","encoding_version"],"type":"object"}},"type":"object"}]}}},"description":"Dataset created successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Dataset creation failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a new dataset","tags":["DLP Datasets"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/datasets/{dataset_id}":{"delete":{"description":"This deletes all versions of the dataset.","operationId":"dlp-datasets-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"dataset_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"Dataset deleted successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Dataset delete failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a dataset","tags":["DLP Datasets"],"x-api-token-group":["Zero Trust Write"]},"get":{"operationId":"dlp-datasets-read","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"dataset_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"case_sensitive":{"type":"boolean"},"columns":{"items":{"$ref":"#/components/schemas/dlp_DatasetColumn"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"description":{"description":"The description of the dataset.","nullable":true,"type":"string"},"encoding_version":{"format":"int32","minimum":0,"type":"integer"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"num_cells":{"format":"int64","type":"integer"},"secret":{"type":"boolean"},"status":{"$ref":"#/components/schemas/dlp_DatasetUploadStatus"},"updated_at":{"description":"Stores when the dataset was last updated.\n\nThis includes name or description changes as well as uploads.","format":"date-time","type":"string"},"uploads":{"items":{"$ref":"#/components/schemas/dlp_DatasetUpload"},"type":"array"}},"required":["name","id","status","num_cells","created_at","updated_at","uploads","secret","encoding_version","columns"],"type":"object"}},"type":"object"}]}}},"description":"Dataset read successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Dataset read failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Fetch a specific dataset","tags":["DLP Datasets"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"put":{"operationId":"dlp-datasets-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"dataset_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"case_sensitive":{"description":"Determines if the words should be matched in a case-sensitive manner.\n\nOnly required for custom word lists.","type":"boolean"},"description":{"description":"The description of the dataset.","nullable":true,"type":"string"},"name":{"description":"The name of the dataset, must be unique.","nullable":true,"type":"string"}},"type":"object"}}},"description":"Dataset description.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"case_sensitive":{"type":"boolean"},"columns":{"items":{"$ref":"#/components/schemas/dlp_DatasetColumn"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"description":{"description":"The description of the dataset.","nullable":true,"type":"string"},"encoding_version":{"format":"int32","minimum":0,"type":"integer"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"num_cells":{"format":"int64","type":"integer"},"secret":{"type":"boolean"},"status":{"$ref":"#/components/schemas/dlp_DatasetUploadStatus"},"updated_at":{"description":"Stores when the dataset was last updated.\n\nThis includes name or description changes as well as uploads.","format":"date-time","type":"string"},"uploads":{"items":{"$ref":"#/components/schemas/dlp_DatasetUpload"},"type":"array"}},"required":["name","id","status","num_cells","created_at","updated_at","uploads","secret","encoding_version","columns"],"type":"object"}},"type":"object"}]}}},"description":"Dataset updated successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Dataset update failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update details about a dataset","tags":["DLP Datasets"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/datasets/{dataset_id}/upload":{"post":{"operationId":"dlp-datasets-create-version","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"dataset_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"case_sensitive":{"type":"boolean"},"columns":{"items":{"$ref":"#/components/schemas/dlp_DatasetColumn"},"type":"array"},"encoding_version":{"format":"int32","minimum":0,"type":"integer"},"max_cells":{"format":"int64","minimum":0,"type":"integer"},"secret":{"format":"password","type":"string"},"version":{"format":"int64","type":"integer"}},"required":["version","max_cells","encoding_version"],"type":"object"}},"type":"object"}]}}},"description":"Dataset version created successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Dataset version creation failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Prepare to upload a new version of a dataset","tags":["DLP Datasets"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/datasets/{dataset_id}/upload/{version}":{"post":{"description":"This is used for single-column EDMv1 and Custom Word Lists. The EDM format\ncan only be created in the Cloudflare dashboard. For other clients, this\noperation can only be used for non-secret Custom Word Lists. The body must\nbe a UTF-8 encoded, newline (NL or CRNL) separated list of words to be matched.","operationId":"dlp-datasets-upload-version","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"dataset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"version","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"Dataset. For custom wordlists this contains UTF-8 patterns separated by newline characters.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"case_sensitive":{"type":"boolean"},"columns":{"items":{"$ref":"#/components/schemas/dlp_DatasetColumn"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"description":{"description":"The description of the dataset.","nullable":true,"type":"string"},"encoding_version":{"format":"int32","minimum":0,"type":"integer"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"num_cells":{"format":"int64","type":"integer"},"secret":{"type":"boolean"},"status":{"$ref":"#/components/schemas/dlp_DatasetUploadStatus"},"updated_at":{"description":"Stores when the dataset was last updated.\n\nThis includes name or description changes as well as uploads.","format":"date-time","type":"string"},"uploads":{"items":{"$ref":"#/components/schemas/dlp_DatasetUpload"},"type":"array"}},"required":["name","id","status","num_cells","created_at","updated_at","uploads","secret","encoding_version","columns"],"type":"object"}},"type":"object"}]}}},"description":"Dataset version uploaded successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Dataset version upload failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Upload a new version of a dataset","tags":["DLP Datasets"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}":{"post":{"description":"This is used for multi-column EDMv2 datasets. The EDMv2 format can only be\ncreated in the Cloudflare dashboard. The columns in the response appear in\nthe same order as in the request.","operationId":"dlp-datasets-define-columns","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"dataset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"version","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"allOf":[{"oneOf":[{"properties":{"entry_id":{"format":"uuid","type":"string"}},"required":["entry_id"],"title":"Existing Column","type":"object"},{"properties":{"entry_name":{"type":"string"}},"required":["entry_name"],"title":"New Column","type":"object"}]},{"properties":{"header_name":{"type":"string"},"num_cells":{"format":"int64","type":"integer"}},"required":["header_name","num_cells"],"type":"object"}]},"type":"array"}}},"description":"array of new columns to create for this dataset version.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dlp_DatasetColumn"},"type":"array"}},"type":"object"}]}}},"description":"Dataset columns created successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Failed to create dataset columns."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Sets the column information for a multi-column upload","tags":["DLP Datasets"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/datasets/{dataset_id}/versions/{version}/entries/{entry_id}":{"post":{"description":"This is used for multi-column EDMv2 datasets. The EDMv2 format can only be\ncreated in the Cloudflare dashboard.","operationId":"dlp-datasets-upload-dataset-column","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"dataset_id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"version","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"path","name":"entry_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"Dataset content.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"entry_id":{"format":"uuid","type":"string"},"header_name":{"type":"string"},"num_cells":{"format":"int64","type":"integer"},"upload_status":{"$ref":"#/components/schemas/dlp_DatasetUploadStatus"}},"required":["entry_id","upload_status","header_name","num_cells"],"type":"object"}},"type":"object"}]}}},"description":"Dataset column uploaded successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Failed to upload dataset column."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Upload a new version of a multi-column dataset","tags":["DLP Datasets"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/document_fingerprints":{"get":{"operationId":"dlp-document-fingerprints-read-all","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dlp_DocumentFingerprint"},"type":"array"}},"type":"object"}]}}},"description":"Document fingerprint read was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Document fingerprint read failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve data about all document fingerprints.","tags":["DLP Document Fingerprints"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"post":{"operationId":"dlp-document-fingerprints-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"default":"","type":"string"},"match_percent":{"format":"int32","type":"integer"},"name":{"type":"string"}},"required":["name","match_percent"],"type":"object"}}},"description":"Attributes of the new document fingerprint.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"default":"","type":"string"},"entry_id":{"format":"uuid","type":"string"},"file_name":{"nullable":true,"type":"string"},"id":{"format":"uuid","type":"string"},"match_percent":{"format":"int32","type":"integer"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/dlp_DatasetUploadStatus"},"updated_at":{"format":"date-time","type":"string"},"version":{"format":"int64","nullable":true,"type":"integer"}},"required":["id","entry_id","name","description","match_percent","status","created_at","updated_at"],"type":"object"}},"type":"object"}]}}},"description":"Document fingerprint created successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Document fingerprint creation failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Creates a new document fingerprint.","tags":["DLP Document Fingerprints"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/document_fingerprints/{document_fingerprint_id}":{"delete":{"operationId":"dlp-document-fingerprints-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"document_fingerprint_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"Document fingerprint delete was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Document fingerprint delete failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a single document fingerprint.","tags":["DLP Document Fingerprints"],"x-api-token-group":["Zero Trust Write"]},"get":{"operationId":"dlp-document-fingerprints-read","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"document_fingerprint_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"default":"","type":"string"},"entry_id":{"format":"uuid","type":"string"},"file_name":{"nullable":true,"type":"string"},"id":{"format":"uuid","type":"string"},"match_percent":{"format":"int32","type":"integer"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/dlp_DatasetUploadStatus"},"updated_at":{"format":"date-time","type":"string"},"version":{"format":"int64","nullable":true,"type":"integer"}},"required":["id","entry_id","name","description","match_percent","status","created_at","updated_at"],"type":"object"}},"type":"object"}]}}},"description":"Document fingerprint read was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Document fingerprint read failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve data about a specific document fingerprint.","tags":["DLP Document Fingerprints"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"post":{"operationId":"dlp-document-fingerprints-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"document_fingerprint_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_UpdateDocumentFingerprint"}}},"description":"Attributes of the document fingerprint to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"default":"","type":"string"},"entry_id":{"format":"uuid","type":"string"},"file_name":{"nullable":true,"type":"string"},"id":{"format":"uuid","type":"string"},"match_percent":{"format":"int32","type":"integer"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/dlp_DatasetUploadStatus"},"updated_at":{"format":"date-time","type":"string"},"version":{"format":"int64","nullable":true,"type":"integer"}},"required":["id","entry_id","name","description","match_percent","status","created_at","updated_at"],"type":"object"}},"type":"object"}]}}},"description":"Document fingerprint read was successful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Document fingerprint read failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update the attributes of a single document fingerprint.","tags":["DLP Document Fingerprints"],"x-api-token-group":["Zero Trust Write"]},"put":{"operationId":"dlp-document-fingerprints-upload","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"document_fingerprint_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"description":"File used for document fingerprinting.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"created_at":{"format":"date-time","type":"string"},"description":{"type":"string"},"entry_id":{"format":"uuid","type":"string"},"file_name":{"type":"string"},"id":{"format":"uuid","type":"string"},"match_percent":{"format":"int32","type":"integer"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/dlp_DatasetUploadStatus"},"updated_at":{"format":"date-time","type":"string"},"version":{"format":"int64","type":"integer"}},"required":["id","entry_id","name","description","match_percent","version","file_name","status","created_at","updated_at"],"type":"object"}},"type":"object"}]}}},"description":"File uploaded successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Failed to upload file."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Uploads a new version for a document fingerprint.","tags":["DLP Document Fingerprints"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/email/account_mapping":{"get":{"operationId":"dlp-email-scanner-get-account-mapping","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"addin_identifier_token":{"format":"uuid","type":"string"},"auth_requirements":{"$ref":"#/components/schemas/dlp_AddinAuth"}},"required":["auth_requirements","addin_identifier_token"],"type":"object"}},"type":"object"}]}}},"description":"Get Email Scanner Account Mapping response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Get Email Scanner Account Mapping failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get mapping","tags":["DLP Email"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"post":{"operationId":"dlp-email-scanner-create-account-mapping","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_UpdateAddinAccountMapping"}}},"description":"Account mapping.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"addin_identifier_token":{"format":"uuid","type":"string"},"auth_requirements":{"$ref":"#/components/schemas/dlp_AddinAuth"}},"required":["auth_requirements","addin_identifier_token"],"type":"object"}},"type":"object"}]}}},"description":"New Email Scanner Account Mapping response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"New Email Scanner Account Mapping failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create mapping","tags":["DLP Email"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/email/rules":{"get":{"description":"Lists all email scanner rules for an account.","operationId":"dlp-email-scanner-list-all-rules","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dlp_EmailRule"},"type":"array"}},"type":"object"}]}}},"description":"List all email scanner rules response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"List all email scanner rules failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List all email scanner rules","tags":["DLP Email"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"patch":{"operationId":"dlp-email-scanner-update-rule-priorities","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_UpdateEmailRulePriorities"}}},"description":"Rule priorities.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"action":{"$ref":"#/components/schemas/dlp_EmailRuleAction"},"conditions":{"description":"Triggered if all conditions match.","items":{"$ref":"#/components/schemas/dlp_EmailRuleCondition"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"description":{"nullable":true,"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"},"priority":{"format":"int32","minimum":0,"type":"integer"},"rule_id":{"format":"uuid","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["rule_id","name","priority","enabled","conditions","action","created_at","updated_at"],"type":"object"}},"type":"object"}]}}},"description":"Update Email Scanner Rule priorities response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Update Email Scanner Rule priorities failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update email scanner rule priorities","tags":["DLP Email"],"x-api-token-group":["Zero Trust Write"]},"post":{"operationId":"dlp-email-scanner-create-rule","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_CreateEmailRule"}}},"description":"Rule description.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"action":{"$ref":"#/components/schemas/dlp_EmailRuleAction"},"conditions":{"description":"Triggered if all conditions match.","items":{"$ref":"#/components/schemas/dlp_EmailRuleCondition"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"description":{"nullable":true,"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"},"priority":{"format":"int32","minimum":0,"type":"integer"},"rule_id":{"format":"uuid","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["rule_id","name","priority","enabled","conditions","action","created_at","updated_at"],"type":"object"}},"type":"object"}]}}},"description":"New Email Scanner Rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"New Email Scanner Rule failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create email scanner rule","tags":["DLP Email"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/email/rules/{rule_id}":{"delete":{"operationId":"dlp-email-scanner-delete-rule","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"rule_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"action":{"$ref":"#/components/schemas/dlp_EmailRuleAction"},"conditions":{"description":"Triggered if all conditions match.","items":{"$ref":"#/components/schemas/dlp_EmailRuleCondition"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"description":{"nullable":true,"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"},"priority":{"format":"int32","minimum":0,"type":"integer"},"rule_id":{"format":"uuid","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["rule_id","name","priority","enabled","conditions","action","created_at","updated_at"],"type":"object"}},"type":"object"}]}}},"description":"Delete Email Scanner Rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Delete Email Scanner Rule failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete email scanner rule","tags":["DLP Email"],"x-api-token-group":["Zero Trust Write"]},"get":{"operationId":"dlp-email-scanner-get-rule","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"rule_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"action":{"$ref":"#/components/schemas/dlp_EmailRuleAction"},"conditions":{"description":"Triggered if all conditions match.","items":{"$ref":"#/components/schemas/dlp_EmailRuleCondition"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"description":{"nullable":true,"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"},"priority":{"format":"int32","minimum":0,"type":"integer"},"rule_id":{"format":"uuid","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["rule_id","name","priority","enabled","conditions","action","created_at","updated_at"],"type":"object"}},"type":"object"}]}}},"description":"Get Email Scanner Rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Get Email Scanner Rule failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get an email scanner rule","tags":["DLP Email"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"put":{"operationId":"dlp-email-scanner-update-rule","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"rule_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_CreateEmailRule"}}},"description":"Rule description.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"action":{"$ref":"#/components/schemas/dlp_EmailRuleAction"},"conditions":{"description":"Triggered if all conditions match.","items":{"$ref":"#/components/schemas/dlp_EmailRuleCondition"},"type":"array"},"created_at":{"format":"date-time","type":"string"},"description":{"nullable":true,"type":"string"},"enabled":{"type":"boolean"},"name":{"type":"string"},"priority":{"format":"int32","minimum":0,"type":"integer"},"rule_id":{"format":"uuid","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["rule_id","name","priority","enabled","conditions","action","created_at","updated_at"],"type":"object"}},"type":"object"}]}}},"description":"Update Email Scanner Rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Update Email Scanner Rule failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update email scanner rule","tags":["DLP Email"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/entries":{"get":{"description":"Lists all DLP entries in an account.","operationId":"dlp-entries-list-all-entries","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"items":{"discriminator":{"propertyName":"type"},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/dlp_CustomEntry"},{"properties":{"type":{"enum":["custom"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Custom Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedEntry"},{"properties":{"type":{"enum":["predefined"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Predefined Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_IntegrationEntry"},{"properties":{"type":{"enum":["integration"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Integration Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_ExactDataEntry"},{"properties":{"type":{"enum":["exact_data"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Exact Data Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_DocumentFingerprintEntry"},{"properties":{"type":{"enum":["document_fingerprint"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Document Fingerprint Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_WordListEntry"},{"properties":{"type":{"enum":["word_list"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Word List Entry"}]},"type":"array"}},"type":"object"}]}}},"description":"List all entries response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"List all entries failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List all entries","tags":["DLP Entries"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"post":{"description":"Creates a DLP custom entry.","operationId":"dlp-entries-create-entry","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_NewEntry"}}},"description":"A new entry to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"pattern":{"$ref":"#/components/schemas/dlp_Pattern"},"profile_id":{"format":"uuid","nullable":true,"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","name","created_at","updated_at","pattern","enabled"],"type":"object"}},"type":"object"}]}}},"description":"Create new custom entry response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Create new custom entry failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create custom entry","tags":["DLP Entries"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/entries/custom/{entry_id}":{"put":{"description":"Updates a DLP custom entry.","operationId":"dlp-entries-update-custom-entry","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_CustomEntryUpdate"}}},"description":"Update to be applied to the entry.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"pattern":{"$ref":"#/components/schemas/dlp_Pattern"},"profile_id":{"format":"uuid","nullable":true,"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","name","created_at","updated_at","pattern","enabled"],"type":"object"}},"type":"object"}]}}},"description":"Update entry response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Update entry failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update custom entry","tags":["DLP Entries"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/entries/integration":{"post":{"description":"Integration entries can't be created, this will update an existing integration entry.\nThis is needed for our generated terraform API.","operationId":"dlp-entries-create-integration-entry","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_NewPredefinedEntry"}}},"description":"This endpoint will update an existing integration entry. It is not possible to create new integration entries.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"profile_id":{"format":"uuid","nullable":true,"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","name","created_at","updated_at","enabled"],"type":"object"}},"type":"object"}]}}},"description":"Create integration entry response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Create entry failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create integration entry","tags":["DLP Integration Entries"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/entries/integration/{entry_id}":{"delete":{"description":"This is a no-op as integration entires can't be deleted but is needed for our generated terraform API.","operationId":"dlp-entries-delete-integration-entry","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]}}},"description":"Delete integration entry response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Delete entry failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete integration entry","tags":["DLP Integration Entries"],"x-api-token-group":["Zero Trust Write"]},"put":{"description":"Updates a DLP entry.","operationId":"dlp-entries-update-integration-entry","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_PredefinedEntryUpdate"}}},"description":"Enable or disable integration entry in owning profile.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"created_at":{"format":"date-time","type":"string"},"enabled":{"type":"boolean"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"profile_id":{"format":"uuid","nullable":true,"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","name","created_at","updated_at","enabled"],"type":"object"}},"type":"object"}]}}},"description":"Update integration entry response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Update entry failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update integration entry","tags":["DLP Integration Entries"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/entries/predefined":{"post":{"description":"Predefined entries can't be created, this will update an existing predefined entry.\nThis is needed for our generated terraform API.","operationId":"dlp-entries-create-predefined-entry","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_NewPredefinedEntry"}}},"description":"This endpoint will update an existing predefined entry. It is not possible to create new predefined entries.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"confidence":{"$ref":"#/components/schemas/dlp_EntryConfidence"},"enabled":{"type":"boolean"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"profile_id":{"format":"uuid","nullable":true,"type":"string"},"variant":{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedEntryVariant"}]}},"required":["id","name","enabled","confidence"],"type":"object"}},"type":"object"}]}}},"description":"Create predefined entry response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Create entry failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create predefined entry","tags":["DLP Predefined Entries"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/entries/predefined/{entry_id}":{"delete":{"description":"This is a no-op as predefined entires can't be deleted but is needed for our generated terraform API.","operationId":"dlp-entries-delete-predefined-entry","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]}}},"description":"Delete predefined entry response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Delete entry failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete predefined entry","tags":["DLP Predefined Entries"],"x-api-token-group":["Zero Trust Write"]},"put":{"description":"Updates a DLP entry.","operationId":"dlp-entries-update-predefined-entry","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_PredefinedEntryUpdate"}}},"description":"Settings to enable or disable predefined entry in owning profile.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"confidence":{"$ref":"#/components/schemas/dlp_EntryConfidence"},"enabled":{"type":"boolean"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"profile_id":{"format":"uuid","nullable":true,"type":"string"},"variant":{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedEntryVariant"}]}},"required":["id","name","enabled","confidence"],"type":"object"}},"type":"object"}]}}},"description":"Update predefined entry response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Update entry failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update predefined entry","tags":["DLP Entries"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/entries/{entry_id}":{"delete":{"description":"Deletes a DLP custom entry.","operationId":"dlp-entries-delete-entry","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]}}},"description":"Delete custom entry response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Delete custom entry failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete custom entry","tags":["DLP Entries"],"x-api-token-group":["Zero Trust Write"]},"get":{"description":"Fetches a DLP entry by ID.","operationId":"dlp-entries-get-dlp-entry","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"discriminator":{"propertyName":"type"},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/dlp_CustomEntry"},{"properties":{"type":{"enum":["custom"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Custom Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedEntry"},{"properties":{"type":{"enum":["predefined"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Predefined Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_IntegrationEntry"},{"properties":{"type":{"enum":["integration"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Integration Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_ExactDataEntry"},{"properties":{"type":{"enum":["exact_data"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Exact Data Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_DocumentFingerprintEntry"},{"properties":{"type":{"enum":["document_fingerprint"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Document Fingerprint Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_WordListEntry"},{"properties":{"type":{"enum":["word_list"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Word List Entry"}]}},"type":"object"}]}}},"description":"Get entry response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Get entry failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DLP Entry","tags":["DLP Entries"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"put":{"description":"Updates a DLP entry.","operationId":"dlp-entries-update-entry","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"entry_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_EntryUpdate"}}},"description":"Update to be applied to the entry.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"discriminator":{"propertyName":"type"},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/dlp_CustomEntry"},{"properties":{"type":{"enum":["custom"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Custom Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedEntry"},{"properties":{"type":{"enum":["predefined"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Predefined Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_IntegrationEntry"},{"properties":{"type":{"enum":["integration"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Integration Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_ExactDataEntry"},{"properties":{"type":{"enum":["exact_data"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Exact Data Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_DocumentFingerprintEntry"},{"properties":{"type":{"enum":["document_fingerprint"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Document Fingerprint Entry"},{"allOf":[{"$ref":"#/components/schemas/dlp_WordListEntry"},{"properties":{"type":{"enum":["word_list"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Word List Entry"}]}},"type":"object"}]}}},"description":"Update entry response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Update entry failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update entry","tags":["DLP Entries"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/limits":{"get":{"operationId":"dlp-limits-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"max_dataset_cells":{"format":"int64","minimum":0,"type":"integer"}},"required":["max_dataset_cells"],"type":"object"}},"type":"object"}]}}},"description":"Limits retrieved successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Limits get failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Fetch limits associated with DLP for account","tags":["DLP Settings"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]}},"/accounts/{account_id}/dlp/patterns/validate":{"post":{"description":"Validates whether this pattern is a valid regular expression. Rejects it if\nthe regular expression is too complex or can match an unbounded-length\nstring. The regex will be rejected if it uses `*` or `+`. Bound the maximum\nnumber of characters that can be matched using a range, e.g. `{1,100}`.","operationId":"dlp-pattern-validate","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_RegexValidationQuery"}}},"description":"Validation query.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"valid":{"type":"boolean"}},"required":["valid"],"type":"object"}},"type":"object"}]}}},"description":"Validation response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Failed to validate."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Validate a DLP regex pattern","tags":["DLP Settings"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/payload_log":{"get":{"operationId":"dlp-payload-log-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"public_key":{"nullable":true,"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["updated_at"],"type":"object"}},"type":"object"}]}}},"description":"Payload log settings."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Failed to get payload log settings."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get payload log settings","tags":["DLP Settings"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"put":{"operationId":"dlp-payload-log-put","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_PayloadLogSettingUpdate"}}},"description":"New payload log settings.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"public_key":{"nullable":true,"type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["updated_at"],"type":"object"}},"type":"object"}]}}},"description":"Payload log settings."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Failed to set payload log settings."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Set payload log settings","tags":["DLP Settings"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/profiles":{"get":{"description":"Lists all DLP profiles in an account.","operationId":"dlp-profiles-list-all-profiles","parameters":[{"description":"Return all profiles, including those that current account does not have access to.","in":"query","name":"all","schema":{"type":"boolean"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dlp_Profile"},"type":"array"}},"type":"object"}]}}},"description":"List all profiles response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"List all profiles failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List all profiles","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]}},"/accounts/{account_id}/dlp/profiles/custom":{"get":{"description":"Lists all DLP custom profiles in an account.","operationId":"dlp-profiles-list-all-custom-profiles","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dlp_CustomProfile"},"type":"array"}},"type":"object"}]}}},"description":"List all custom profiles response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"List all profiles failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List all custom profiles","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"post":{"description":"Creates a DLP custom profile.","operationId":"dlp-profiles-create-custom-profiles","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_NewCustomProfile"}}},"description":"A new profile to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"discriminator":{"propertyName":"type"},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/dlp_CustomProfile"},{"properties":{"type":{"enum":["custom"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Custom Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedProfile"},{"properties":{"type":{"enum":["predefined"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Predefined Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_IntegrationProfile"},{"properties":{"type":{"enum":["integration"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Integration Profile"}]}},"type":"object"}]}}},"description":"New custom profile response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"New custom profile failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create custom profile","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/profiles/custom/{profile_id}":{"delete":{"description":"Deletes a DLP custom profile.","operationId":"dlp-profiles-delete-custom-profile","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"profile_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]}}},"description":"Delete custom profile response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Delete custom profile failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete custom profile","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Write"]},"get":{"description":"Fetches a custom DLP profile by id.","operationId":"dlp-profiles-get-custom-profile","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"profile_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"discriminator":{"propertyName":"type"},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/dlp_CustomProfile"},{"properties":{"type":{"enum":["custom"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Custom Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedProfile"},{"properties":{"type":{"enum":["predefined"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Predefined Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_IntegrationProfile"},{"properties":{"type":{"enum":["integration"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Integration Profile"}]}},"type":"object"}]}}},"description":"Custom profile response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Custom profile failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get custom profile","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"put":{"description":"Updates a DLP custom profile.","operationId":"dlp-profiles-update-custom-profile","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"profile_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_CustomProfileUpdate"}}},"description":"The updated parameters for the profile.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"discriminator":{"propertyName":"type"},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/dlp_CustomProfile"},{"properties":{"type":{"enum":["custom"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Custom Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedProfile"},{"properties":{"type":{"enum":["predefined"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Predefined Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_IntegrationProfile"},{"properties":{"type":{"enum":["integration"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Integration Profile"}]}},"type":"object"}]}}},"description":"Update custom profile response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Update custom profile failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update custom profile","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/profiles/predefined":{"post":{"description":"Creates a DLP predefined profile. Only supports enabling/disabling entries.","operationId":"dlp-profiles-create-predefined-profile","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_NewPredefinedProfile"}}},"description":"Predefined profiles can not be created. This endpoint will only update an existing predefined profiles settings.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"discriminator":{"propertyName":"type"},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/dlp_CustomProfile"},{"properties":{"type":{"enum":["custom"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Custom Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedProfile"},{"properties":{"type":{"enum":["predefined"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Predefined Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_IntegrationProfile"},{"properties":{"type":{"enum":["integration"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Integration Profile"}]}},"type":"object"}]}}},"description":"Create predefined profile response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Create predefined profile failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create predefined profile","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/profiles/predefined/{profile_id}":{"delete":{"description":"This is a no-op as predefined profiles can't be deleted but is needed for our generated terraform API.","operationId":"dlp-profiles-delete-predefined-profile","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"profile_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]}}},"description":"Delete predefined profile response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Delete predefined profile failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete predefined profile","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Write"]},"get":{"description":"Fetches a predefined DLP profile by id.","operationId":"dlp-profiles-get-predefined-profile","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"profile_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"discriminator":{"propertyName":"type"},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/dlp_CustomProfile"},{"properties":{"type":{"enum":["custom"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Custom Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedProfile"},{"properties":{"type":{"enum":["predefined"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Predefined Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_IntegrationProfile"},{"properties":{"type":{"enum":["integration"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Integration Profile"}]}},"type":"object"}]}}},"description":"Predefined profile response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Predefined profile failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get predefined profile","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"put":{"description":"Updates a DLP predefined profile. Only supports enabling/disabling entries.","operationId":"dlp-profiles-update-predefined-profile","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"profile_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_PredefinedProfileUpdate"}}},"description":"The updated parameters for the predefined profile.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"discriminator":{"propertyName":"type"},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/dlp_CustomProfile"},{"properties":{"type":{"enum":["custom"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Custom Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedProfile"},{"properties":{"type":{"enum":["predefined"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Predefined Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_IntegrationProfile"},{"properties":{"type":{"enum":["integration"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Integration Profile"}]}},"type":"object"}]}}},"description":"Update predefined profile response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Update predefined profile failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update predefined profile","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/profiles/predefined/{profile_id}/config":{"get":{"description":"This is similar to `get_predefined` but only returns entries that are enabled.\nThis is needed for our terraform API\nFetches a predefined DLP profile by id.","operationId":"dlp-profiles-get-predefined-profile-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"profile_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"ai_context_enabled":{"default":false,"type":"boolean"},"allowed_match_count":{"format":"int32","type":"integer"},"confidence_threshold":{"default":"low","nullable":true,"type":"string"},"enabled_entries":{"items":{"format":"uuid","type":"string"},"type":"array"},"entries":{"deprecated":true,"items":{"$ref":"#/components/schemas/dlp_Entry"},"type":"array"},"id":{"description":"The id of the predefined profile (uuid).","format":"uuid","type":"string"},"name":{"description":"The name of the predefined profile.","type":"string"},"ocr_enabled":{"default":false,"type":"boolean"},"open_access":{"description":"Whether this profile can be accessed by anyone.","type":"boolean"}},"required":["id","name","entries","enabled_entries","allowed_match_count","confidence_threshold"],"type":"object"}},"type":"object"}]}}},"description":"Predefined profile response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Predefined profile failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get predefined profile config","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"post":{"description":"This is similar to `update_predefined` but only returns entries that are enabled.\nThis is needed for our terraform API\nCreates a DLP predefined profile. Only supports enabling/disabling entries.","operationId":"dlp-profiles-create-predefined-profile-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"profile_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_PredefinedProfileConfigUpdate"}}},"description":"Predefined profiles can not be created. This endpoint will only update an existing predefined profiles settings.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"ai_context_enabled":{"default":false,"type":"boolean"},"allowed_match_count":{"format":"int32","type":"integer"},"confidence_threshold":{"default":"low","nullable":true,"type":"string"},"enabled_entries":{"items":{"format":"uuid","type":"string"},"type":"array"},"entries":{"deprecated":true,"items":{"$ref":"#/components/schemas/dlp_Entry"},"type":"array"},"id":{"description":"The id of the predefined profile (uuid).","format":"uuid","type":"string"},"name":{"description":"The name of the predefined profile.","type":"string"},"ocr_enabled":{"default":false,"type":"boolean"},"open_access":{"description":"Whether this profile can be accessed by anyone.","type":"boolean"}},"required":["id","name","entries","enabled_entries","allowed_match_count","confidence_threshold"],"type":"object"}},"type":"object"}]}}},"description":"Create predefined profile response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Create predefined profile failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create predefined profile","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Write"]},"put":{"description":"This is similar to `update_predefined` but only returns entries that are enabled.\nThis is needed for our terraform API\nUpdates a DLP predefined profile. Only supports enabling/disabling entries.","operationId":"dlp-profiles-update-predefined-profile-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"profile_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_PredefinedProfileConfigUpdate"}}},"description":"The updated parameters for the predefined profile.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"ai_context_enabled":{"default":false,"type":"boolean"},"allowed_match_count":{"format":"int32","type":"integer"},"confidence_threshold":{"default":"low","nullable":true,"type":"string"},"enabled_entries":{"items":{"format":"uuid","type":"string"},"type":"array"},"entries":{"deprecated":true,"items":{"$ref":"#/components/schemas/dlp_Entry"},"type":"array"},"id":{"description":"The id of the predefined profile (uuid).","format":"uuid","type":"string"},"name":{"description":"The name of the predefined profile.","type":"string"},"ocr_enabled":{"default":false,"type":"boolean"},"open_access":{"description":"Whether this profile can be accessed by anyone.","type":"boolean"}},"required":["id","name","entries","enabled_entries","allowed_match_count","confidence_threshold"],"type":"object"}},"type":"object"}]}}},"description":"Update predefined profile response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Update predefined profile failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update predefined profile config","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/dlp/profiles/{profile_id}":{"get":{"description":"Fetches a DLP profile by ID.","operationId":"dlp-profiles-get-dlp-profile","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"profile_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"discriminator":{"propertyName":"type"},"oneOf":[{"allOf":[{"$ref":"#/components/schemas/dlp_CustomProfile"},{"properties":{"type":{"enum":["custom"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Custom Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_PredefinedProfile"},{"properties":{"type":{"enum":["predefined"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Predefined Profile"},{"allOf":[{"$ref":"#/components/schemas/dlp_IntegrationProfile"},{"properties":{"type":{"enum":["integration"],"type":"string"}},"required":["type"],"type":"object"}],"title":"Integration Profile"}]}},"type":"object"}]}}},"description":"Get profile response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Get profile failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DLP Profile","tags":["DLP Profiles"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]}},"/accounts/{account_id}/dns_firewall":{"get":{"description":"List DNS Firewall clusters for an account","operationId":"dns-firewall-list-dns-firewall-clusters","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-firewall_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of clusters per page","maximum":100,"minimum":1,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-firewall_dns_firewall_response_collection"}}},"description":"List DNS Firewall Clusters response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_dns_firewall_response_collection"},{"$ref":"#/components/schemas/dns-firewall_api-response-common-failure"}],"type":"object"}}},"description":"List DNS Firewall Clusters response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List DNS Firewall Clusters","tags":["DNS Firewall"],"x-api-token-group":["DNS Firewall Write","DNS Firewall Read"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create a DNS Firewall cluster","operationId":"dns-firewall-create-dns-firewall-cluster","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-firewall_dns-firewall-cluster-post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-firewall_dns_firewall_single_response"}}},"description":"Create DNS Firewall Cluster response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_dns_firewall_single_response"},{"$ref":"#/components/schemas/dns-firewall_api-response-common-failure"}],"type":"object"}}},"description":"Create DNS Firewall Cluster response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create DNS Firewall Cluster","tags":["DNS Firewall"],"x-api-token-group":["DNS Firewall Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/dns_firewall/{dns_firewall_id}":{"delete":{"description":"Delete a DNS Firewall cluster","operationId":"dns-firewall-delete-dns-firewall-cluster","parameters":[{"in":"path","name":"dns_firewall_id","required":true,"schema":{"$ref":"#/components/schemas/dns-firewall_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-firewall_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/dns-firewall_identifier"}},"type":"object"}},"type":"object"}],"type":"object"}}},"description":"Delete DNS Firewall Cluster response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/dns-firewall_identifier"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/dns-firewall_api-response-common-failure"}],"type":"object"}}},"description":"Delete DNS Firewall Cluster response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete DNS Firewall Cluster","tags":["DNS Firewall"],"x-api-token-group":["DNS Firewall Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Show a single DNS Firewall cluster for an account","operationId":"dns-firewall-dns-firewall-cluster-details","parameters":[{"in":"path","name":"dns_firewall_id","required":true,"schema":{"$ref":"#/components/schemas/dns-firewall_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-firewall_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-firewall_dns_firewall_single_response"}}},"description":"DNS Firewall Cluster Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_dns_firewall_single_response"},{"$ref":"#/components/schemas/dns-firewall_api-response-common-failure"}],"type":"object"}}},"description":"DNS Firewall Cluster Details response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"DNS Firewall Cluster Details","tags":["DNS Firewall"],"x-api-token-group":["DNS Firewall Write","DNS Firewall Read"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Modify the configuration of a DNS Firewall cluster","operationId":"dns-firewall-update-dns-firewall-cluster","parameters":[{"in":"path","name":"dns_firewall_id","required":true,"schema":{"$ref":"#/components/schemas/dns-firewall_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-firewall_dns-firewall-cluster-patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-firewall_dns_firewall_single_response"}}},"description":"Update DNS Firewall Cluster response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_dns_firewall_single_response"},{"$ref":"#/components/schemas/dns-firewall_api-response-common-failure"}],"type":"object"}}},"description":"Update DNS Firewall Cluster response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update DNS Firewall Cluster","tags":["DNS Firewall"],"x-api-token-group":["DNS Firewall Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report":{"get":{"description":"Retrieves a list of summarised aggregate metrics over a given time period.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.","operationId":"dns-firewall-analytics-table","parameters":[{"in":"path","name":"dns_firewall_id","required":true,"schema":{"$ref":"#/components/schemas/dns-analytics_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-analytics_identifier"}},{"in":"query","name":"metrics","schema":{"$ref":"#/components/schemas/dns-analytics_metrics"}},{"in":"query","name":"dimensions","schema":{"$ref":"#/components/schemas/dns-analytics_dimensions"}},{"in":"query","name":"since","schema":{"$ref":"#/components/schemas/dns-analytics_since"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/dns-analytics_until"}},{"in":"query","name":"limit","schema":{"$ref":"#/components/schemas/dns-analytics_limit"}},{"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/dns-analytics_sort"}},{"in":"query","name":"filters","schema":{"$ref":"#/components/schemas/dns-analytics_filters"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-analytics_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-analytics_report"}},"type":"object"}],"type":"object"}}},"description":"Table response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-analytics_api-response-common-failure"},{"properties":{"result":{"$ref":"#/components/schemas/dns-analytics_report"}},"type":"object"}],"type":"object"}}},"description":"Table response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Table","tags":["DNS Firewall Analytics"],"x-api-token-group":["DNS Firewall Write","DNS Firewall Read"]}},"/accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report/bytime":{"get":{"description":"Retrieves a list of aggregate metrics grouped by time interval.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.","operationId":"dns-firewall-analytics-by-time","parameters":[{"in":"path","name":"dns_firewall_id","required":true,"schema":{"$ref":"#/components/schemas/dns-analytics_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-analytics_identifier"}},{"in":"query","name":"metrics","schema":{"$ref":"#/components/schemas/dns-analytics_metrics"}},{"in":"query","name":"dimensions","schema":{"$ref":"#/components/schemas/dns-analytics_dimensions"}},{"in":"query","name":"since","schema":{"$ref":"#/components/schemas/dns-analytics_since"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/dns-analytics_until"}},{"in":"query","name":"limit","schema":{"$ref":"#/components/schemas/dns-analytics_limit"}},{"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/dns-analytics_sort"}},{"in":"query","name":"filters","schema":{"$ref":"#/components/schemas/dns-analytics_filters"}},{"in":"query","name":"time_delta","schema":{"$ref":"#/components/schemas/dns-analytics_time_delta"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-analytics_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-analytics_report_bytime"}},"type":"object"}],"type":"object"}}},"description":"By Time response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-analytics_api-response-common-failure"},{"properties":{"result":{"$ref":"#/components/schemas/dns-analytics_report_bytime"}},"type":"object"}],"type":"object"}}},"description":"By Time response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"By Time","tags":["DNS Firewall Analytics"],"x-api-token-group":["DNS Firewall Write","DNS Firewall Read"]}},"/accounts/{account_id}/dns_firewall/{dns_firewall_id}/reverse_dns":{"get":{"description":"Show reverse DNS configuration (PTR records) for a DNS Firewall cluster","operationId":"dns-firewall-show-dns-firewall-cluster-reverse-dns","parameters":[{"in":"path","name":"dns_firewall_id","required":true,"schema":{"$ref":"#/components/schemas/dns-firewall_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-firewall_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-firewall_dns_firewall_reverse_dns_response"}}},"description":"Show DNS Firewall Cluster Reverse DNS response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_dns_firewall_reverse_dns_response"},{"$ref":"#/components/schemas/dns-firewall_api-response-common-failure"}],"type":"object"}}},"description":"Show DNS Firewall Cluster Reverse DNS response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Show DNS Firewall Cluster Reverse DNS","tags":["DNS Firewall"],"x-api-token-group":["DNS Firewall Write","DNS Firewall Read"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Update reverse DNS configuration (PTR records) for a DNS Firewall cluster","operationId":"dns-firewall-update-dns-firewall-cluster-reverse-dns","parameters":[{"in":"path","name":"dns_firewall_id","required":true,"schema":{"$ref":"#/components/schemas/dns-firewall_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-firewall_dns-firewall-reverse-dns-patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-firewall_dns_firewall_reverse_dns_response"}}},"description":"Update DNS Firewall Cluster Reverse DNS response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-firewall_dns_firewall_reverse_dns_response"},{"$ref":"#/components/schemas/dns-firewall_api-response-common-failure"}],"type":"object"}}},"description":"Update DNS Firewall Cluster Reverse DNS response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update DNS Firewall Cluster Reverse DNS","tags":["DNS Firewall"],"x-api-token-group":["DNS Firewall Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/dns_settings":{"get":{"description":"Show DNS settings for an account","operationId":"dns-settings-for-an-account-list-dns-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-settings_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_dns_response_single"}}},"description":"Show DNS Settings response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns_response_single"},{"$ref":"#/components/schemas/dns-settings_api-response-common-failure"}],"type":"object"}}},"description":"Show DNS Settings response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Show DNS Settings","tags":["DNS Settings for an Account"],"x-api-token-group":["Account DNS Settings Write","Account DNS Settings Read"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Update DNS settings for an account","operationId":"dns-settings-for-an-account-update-dns-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-settings_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_account_settings_patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_dns_response_single"}}},"description":"Show DNS Settings response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns_response_single"},{"$ref":"#/components/schemas/dns-settings_api-response-common-failure"}],"type":"object"}}},"description":"Show DNS Settings response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update DNS Settings","tags":["DNS Settings for an Account"],"x-api-token-group":["Account DNS Settings Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/dns_settings/views":{"get":{"description":"List DNS Internal Views for an Account","operationId":"dns-views-for-an-account-list-internal-dns-views","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-settings_identifier"}},{"in":"query","name":"name","schema":{"description":"Exact value of the DNS view name. This is a convenience alias for `name.exact`.\n","example":"my view","type":"string"}},{"in":"query","name":"name.exact","schema":{"description":"Exact value of the DNS view name.\n","example":"my view","type":"string"}},{"in":"query","name":"name.contains","schema":{"description":"Substring of the DNS view name.\n","example":"view","type":"string"}},{"in":"query","name":"name.startswith","schema":{"description":"Prefix of the DNS view name.\n","example":"my","type":"string"}},{"in":"query","name":"name.endswith","schema":{"description":"Suffix of the DNS view name.\n","example":"ew","type":"string"}},{"in":"query","name":"zone_id","schema":{"description":"A zone ID that exists in the zones list for the view.\n","example":"ae29bea30e2e427ba9cd8d78b628177b","type":"string"}},{"in":"query","name":"zone_name","schema":{"description":"A zone name that exists in the zones list for the view.\n","example":"www.example.com","type":"string"}},{"in":"query","name":"match","schema":{"$ref":"#/components/schemas/dns-settings_match"}},{"in":"query","name":"page","schema":{"$ref":"#/components/schemas/dns-settings_page"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/dns-settings_per_page"}},{"in":"query","name":"order","schema":{"$ref":"#/components/schemas/dns-settings_order"}},{"in":"query","name":"direction","schema":{"$ref":"#/components/schemas/dns-settings_direction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_dns_view_response_collection"}}},"description":"List Internal DNS Views response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns_view_response_collection"},{"$ref":"#/components/schemas/dns-settings_api-response-common-failure"}],"type":"object"}}},"description":"List Internal DNS Views response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Internal DNS Views","tags":["DNS Internal Views for an Account"],"x-api-token-group":["DNS View Write","DNS View Read"],"x-cfPermissionsRequired":{"enum":["#dns.view:list"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create Internal DNS View for an account","operationId":"dns-views-for-an-account-create-internal-dns-views","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-settings_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_dns-view-post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_dns_view_response_single"}}},"description":"Create Internal DNS View response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns_view_response_single"},{"$ref":"#/components/schemas/dns-settings_api-response-common-failure"}],"type":"object"}}},"description":"Create Internal DNS View response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Internal DNS View","tags":["DNS Internal Views for an Account"],"x-api-token-group":["DNS View Write"],"x-cfPermissionsRequired":{"enum":["#dns.view:create"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/dns_settings/views/{view_id}":{"delete":{"description":"Delete an existing Internal DNS View","operationId":"dns-views-for-an-account-delete-internal-dns-view","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-settings_identifier"}},{"in":"path","name":"view_id","required":true,"schema":{"$ref":"#/components/schemas/dns-settings_identifier"}}],"requestBody":{"content":{"application/json":{}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/dns-settings_identifier"}},"type":"object"}},"type":"object"}}},"description":"Delete Internal DNS View response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/dns-settings_identifier"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/dns-settings_api-response-common-failure"}],"type":"object"}}},"description":"Update Internal DNS View response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Internal DNS View","tags":["DNS Internal Views for an Account"],"x-api-token-group":["DNS View Write"],"x-cfPermissionsRequired":{"enum":["#dns.view:delete"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get DNS Internal View","operationId":"dns-views-for-an-account-get-internal-dns-view","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-settings_identifier"}},{"in":"path","name":"view_id","required":true,"schema":{"$ref":"#/components/schemas/dns-settings_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_dns_view_response_single"}}},"description":"Get DNS Internal View response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns_view_response_single"},{"$ref":"#/components/schemas/dns-settings_api-response-common-failure"}],"type":"object"}}},"description":"List Internal DNS Views response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"DNS Internal View Details","tags":["DNS Internal Views for an Account"],"x-api-token-group":["DNS View Write","DNS View Read"],"x-cfPermissionsRequired":{"enum":["#dns.view:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Update an existing Internal DNS View","operationId":"dns-views-for-an-account-update-internal-dns-view","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dns-settings_identifier"}},{"in":"path","name":"view_id","required":true,"schema":{"$ref":"#/components/schemas/dns-settings_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_dns-view-patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_dns_view_response_single"}}},"description":"Update Internal DNS View response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-settings_dns_view_response_single"},{"$ref":"#/components/schemas/dns-settings_api-response-common-failure"}],"type":"object"}}},"description":"Update Internal DNS View response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Internal DNS View","tags":["DNS Internal Views for an Account"],"x-api-token-group":["DNS View Write"],"x-cfPermissionsRequired":{"enum":["#dns.view:update"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/email-security/investigate":{"get":{"description":"Returns information for each email that matches the search parameter(s).","operationId":"email_security_investigate","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"description":"The beginning of the search date range.\nDefaults to `now - 30 days`.","example":"2022-06-25T14:30:00Z","in":"query","name":"start","schema":{"format":"date-time","type":"string"}},{"description":"The end of the search date range.\nDefaults to `now`.","example":"2022-07-25T14:30:00Z","in":"query","name":"end","schema":{"format":"date-time","type":"string"}},{"description":"The space-delimited term used in the query. The search is case-insensitive.\n\nThe content of the following email metadata fields are searched:\n* alert_id\n* CC\n* From (envelope_from)\n* From Name\n* final_disposition\n* md5 hash (of any attachment)\n* sha1 hash (of any attachment)\n* sha256 hash (of any attachment)\n* name (of any attachment)\n* Reason\n* Received DateTime (yyyy-mm-ddThh:mm:ss)\n* Sent DateTime (yyyy-mm-ddThh:mm:ss)\n* ReplyTo\n* To (envelope_to)\n* To Name\n* Message-ID\n* smtp_helo_server_ip\n* smtp_previous_hop_ip\n* x_originating_ip\n* Subject","example":"bob jones","in":"query","name":"query","schema":{"type":"string"}},{"description":"Determines if the search results will include detections or not.","in":"query","name":"detections_only","schema":{"default":true,"type":"boolean"}},{"description":"Determines if the message action log is included in the response.","in":"query","name":"action_log","schema":{"default":true,"type":"boolean"}},{"description":"The dispositions the search filters by.","in":"query","name":"final_disposition","schema":{"allOf":[{"enum":["MALICIOUS","SUSPICIOUS","SPOOF","SPAM","BULK","NONE"],"type":"string"}]}},{"in":"query","name":"metric","schema":{"type":"string"}},{"description":"The message actions the search filters by.","in":"query","name":"message_action","schema":{"allOf":[{"enum":["PREVIEW","QUARANTINE_RELEASED","MOVED"],"type":"string"}]}},{"example":"me@example.com","in":"query","name":"recipient","schema":{"type":"string"}},{"example":"noreply@example.com","in":"query","name":"sender","schema":{"type":"string"}},{"example":"4Njp3P0STMz2c02Q-2022-12-30T02:44:49","in":"query","name":"alert_id","schema":{"type":"string"}},{"description":"The sender domains the search filters by.","example":"example.com","in":"query","name":"domain","schema":{"type":"string"}},{"example":"\u003c4VAZPrAdg7IGNxdt1DWRNu0gvOeL_iZiwP4BQfo4DaE.Yw-woXuugQbeFhBpzwFQtqq_v2v1HOKznoMBqbciQpE@example.com\u003e","in":"query","name":"message_id","schema":{"type":"string"}},{"in":"query","name":"subject","schema":{"type":"string"}},{"in":"query","name":"cursor","schema":{"type":"string"}},{"description":"The number of results per page.","in":"query","name":"per_page","schema":{"default":20,"format":"int32","minimum":1,"type":"integer"}},{"deprecated":true,"description":"Deprecated: Use cursor pagination instead.","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"nullable":true,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/email-security_MailsearchMessage"},"type":"array"},"result_info":{"$ref":"#/components/schemas/email-security_CursorWithLegacyResultInfo"}},"required":["result","result_info"],"type":"object"}]}}},"description":"Contains the search results for the provided query."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Search email messages","tags":["Email Security"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]}},"/accounts/{account_id}/email-security/investigate/move":{"post":{"operationId":"email_security_post_bulk_message_move","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination":{"enum":["Inbox","JunkEmail","DeletedItems","RecoverableItemsDeletions","RecoverableItemsPurges"],"type":"string"},"postfix_ids":{"items":{"$ref":"#/components/schemas/email-security_PostfixId"},"type":"array"}},"required":["postfix_ids","destination"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/email-security_RetractionResponseItem"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Move multiple messages","tags":["Email Security"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/investigate/preview":{"post":{"operationId":"email_security_post_preview","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"postfix_id":{"$ref":"#/components/schemas/email-security_PostfixId"}},"required":["postfix_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"example":{"screenshot":"iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAYAAADimHc4AAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABgAAAAAQAAAGAAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAAGCgAwAEAAAAAQAAAGAAAAAAtVTeigAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KGV7hBwAACXtJREFUeAHtmwtwXFUZgP9zX7t3b7LNa9M2tGmLDbaWKpL6aBBJHdERQWGkU4u8CraVWmYQYWQUMSoKhZJikYo4Qqc6RVqkKmNHC0K1FGYoM9pqS4FAa9s0aTavfd3d+zq/527YSNvdzWY3m2ySc2c2595z/vOf///+e+4959wTAH5wApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwAhOJABmvzuCz158HXmUp2rCEOlhGbEdFh2qASFAgtiCKMUGgh8FM7IDDp3aQlt12Kfo6rgKAz3ylAQ3rJ/Fg39XYfyx32wUJpJpZ7wiq8LPebuGJaXfuipVKMHJ3YowsRgQC265aE+/quYf2/Le2YDM85aBOn/m7GDHX+m/4W0/B+gpUUNIBwN98rknvif4J+9urC/Tz7OqKBp66+vWSUf9dsvpx62yB0ckpyQDgLxtlS5iyyTx59OuATlFJkOrZYV9l7afItdv/XdSGMigvuQBEHmyqJRLug9DJ+gw2j3y2qIDWcOEPyFef/tHIK8+usaQCEGpdPFd0rEMQC8rZzS5OqXr+JU+JV2+5pjja02sV0mePfm7/I5+eIznm22MF3/U4/p+/L3d23LhxNL0viR7Qs/ETfo/lnIBIsHw0nU/bFiGgLbp0BfnirzanLR/hzJLoAV6QXywJ+C5cNu6N7d/7JD6zat4Is06rbswDENvU/A3sPd6Y1rqxyjRjkDj1zp7RaH5MA3CkpdkL0fAvRsPR4bbhBNtqcNvS7w233nDlxzQAgUp7E+pjPhnNyEw/duRefJLdJEU8pGLo7mptnuuTSJNHkeaBIPhMK/6Gbjm7A7ftfTPV3sGWBQpEu1ekrksxxWgQoLr6Tmbbj4tl34iOgmIbPnsLG8w9hKETajqDiX86sCXJe/1a4D4QEnfF2t/6fjq5UsojFTNQu21v0Z4UIxKA4LqL6nwyfQ3DJ8/JBR7x1wGIEmDfsVzEx1xGO3f+xeT6v7xcDEMKjmystXmRSkPtucJ3nWCy4wZ+0l7wfLsY8F2dBQWg46cfDaDVtw+MSLHsKwm98VDky8UypKAA+BVpF8T7i2Vb6eg1IiPyqE7nUN6joL51jUsw2nVBOqUTLc9TGfi965O++dLlomZvBSICyBoQpdyQVP8R4hFfgAQ+Spb8/PBwfc87AGWadrcR7x5ue+NS3qK2OxQFpcq72jGi7CXGvlGYYUAz7LGi7e6Shftba/x5ma1UB9ZDL2khlz1iuHWGOvJ+BJl65DNDKZ8I5UL17E515a4jri+OEbsoq096l2QeP3iXaR5N4MurH8SWliH5DimQqUHUezMVTah8tVx7wHUIdy6/gv3N7YlhRcHseOsOc9HBKL54S9Z1rrwCcLxlQdWEopzJGfbdGG7Y+XAyABK9MZNYxvx4t2r2vv067l55ayaZvAJgQ0zPpHAi5StT52xjnwfQ9cnWI9kfP5kcZ+8LM9i2EXfffE86kbwCMBuOmiCnXW1I18a4zCO+KuiVrZtSxqMVn5o6zyc1g+/+EF+47uYz6+Y8vg0/vPhygQjLRFH5JLXNWgx3+oGW5GazM33M61o+Z96VnpV//WOqsrF9SbInpK7zStnwVdDqmuQvbHk1VT9rAI63Lq6qJnQTNfRlkAin6kz4VKit/5ZvzZ7ksz/lrPmHy6KsF7CXQoGHp1JXOmoqUnuRMj6CEq0ff6Ay2tVDQ52TB77INmME6lecCd9FLlfUPFUg+oHqRp+Pzk08mtJ1Vg/oallQVlZR/i/a3/GBlNBkSIWqGW2iR7vCs3pX2tksvtQi2frBU1TvLnwEKChgls2ZWv75x7pOC4C7O8GbMNvYGD8wGaAD27QrT2s4KsrON6UVz+8cymd8fZUPYvLzZk9bEzjmUOJZy5VAw29J8+PXnRaAWGvjIQx3z89aM89CEmhwRMUXQVGRmOMC+x5AWOr+2NIKSwl7Ggoish8lRKDsSxplTVnuTwTU2aZzQwCMszehxXYu2AIhCQDKpvvERAImUGIK7jXSePJHWWpRHWw7wQYLcaDolplA0GLnukWddvmmpw+khpnDcQvfXF8DAlkKhnkhmEY52IYKlqGiZWho2z5KDYWtEPtpondGRr3eKlDKFsqDAQhvaLxfCHV/J2OFQgpkL2g152mw6rl4Pg4X0nSx6iL7PwQ4tF0GpXOAYchDIdIxMFIKHkRQKz2m8W4nWzcqz2SDUvfhS5KVO+9vXFhm9B5gd0gm2YLzhepze8G2goiCA6J7dxN31y0bxxKbBcUdz9psJ3ryjgc2d2Gb0m0KaDGTbHbHs/7Ozh1IUGC5wHoDEsthZQjUrWMTBMtheQSphQJYyFKB9Q6Kznup24Mck3Uvk1IITaP73iAtTFkeB+6/oxao8jHWA2ex3lVLEQPEtmqpZVewfxKpQjOmYLx/OpjR6mzqlfqFTyQDEHrogufESN/l2YQnXBmLuhyY+YpBjS/5177WM5R/+I9bA+Cl66ye0DUYbfcMJZ9LuVgz/wQJbrh4uho+wb4R5nUz5NJOact4/WznQ8VHylbuOZDJUNx97Vazu2P5SDMi5bNAKpetpfZkhe8SdyeYEfUVdlZ2ZgBwx5UVjoL7zWB7/ZllI3GNiW425vDVrBkJZeNaR/iUFnns4g+93wd89qpqC+Jtjh4uCvxkW1YMBDNhfvD9DU/Wc0VwBoff+FKz5JDwPrTNrC/Rglm5/zyIkVMF65kICmyHzRPeO5w+2Ow4dE7qumgpmwsIk2JXQw4E43H9n65Y75am8x2HfC2HKgWLEG+1I4BU1L2nBRs5GgrcLZM1t+9vd9vy+jx3j0abbhuypu0TSNnkWPbJBpWtV/w6VS6gsDR1XvQU6Vapa4qkJvrVaRTEMFvAsB2drcewQ/Q5BNj0JOSjA1NtljdFFwY/Srgzlwp1QNaVTx1inNU77dV12gU4qjSoI1XHictn5dla71l5KfnBdIjXl1U2oNcMKTh9SgfaPazthoHaXjswuBQ/8/ZX4ymdHVFHU+tmimoo4Ul4JBmdBFt5khDVBJtbS1junvt0REtO/tx6RLaSjIg+kKZ0oclktCibx//fP0HzCIIlCwnPFLn2+LHJsa8nBYSnnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACk4DA/wDoepVZ2hARhAAAAABJRU5ErkJggg=="},"properties":{"screenshot":{"description":"A base64 encoded PNG image of the email.","type":"string"}},"required":["screenshot"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Preview for non-detection messages","tags":["Email Security"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/investigate/release":{"post":{"operationId":"email_security_post_release","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"A list of messages identfied by their `postfix_id`s that should be released.","items":{"$ref":"#/components/schemas/email-security_PostfixId"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/email-security_ReleaseResponse"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Release messages from quarantine","tags":["Email Security"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/investigate/{postfix_id}":{"get":{"operationId":"email_security_get_message","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"postfix_id","required":true,"schema":{"description":"The identifier of the message.","example":"4Njp3P0STMz2c02Q","title":"postfix_id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"allOf":[{"properties":{"action_log":{},"alert_id":{"nullable":true,"type":"string"},"client_recipients":{"items":{"type":"string"},"type":"array"},"delivery_mode":{"allOf":[{"$ref":"#/components/schemas/email-security_MessageDeliveryMode"},{"nullable":true,"type":"string"}]},"detection_reasons":{"items":{"type":"string"},"type":"array"},"edf_hash":{"nullable":true,"type":"string"},"envelope_from":{"nullable":true,"type":"string"},"envelope_to":{"items":{"type":"string"},"nullable":true,"type":"array"},"final_disposition":{"allOf":[{"$ref":"#/components/schemas/email-security_DispositionLabel"},{"nullable":true,"type":"string"}]},"findings":{"items":{"properties":{"attachment":{"nullable":true,"type":"string"},"detail":{"nullable":true,"type":"string"},"detection":{"allOf":[{"$ref":"#/components/schemas/email-security_DispositionLabel"},{"nullable":true,"type":"string"}]},"field":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"portion":{"nullable":true,"type":"string"},"reason":{"nullable":true,"type":"string"},"score":{"format":"double","nullable":true,"type":"number"},"value":{"nullable":true,"type":"string"}},"type":"object"},"nullable":true,"type":"array"},"from":{"nullable":true,"type":"string"},"from_name":{"nullable":true,"type":"string"},"htmltext_structure_hash":{"nullable":true,"type":"string"},"is_phish_submission":{"type":"boolean"},"is_quarantined":{"type":"boolean"},"message_id":{"nullable":true,"type":"string"},"postfix_id":{"$ref":"#/components/schemas/email-security_PostfixId"},"properties":{"properties":{"allowlisted_pattern":{"type":"string"},"allowlisted_pattern_type":{"allOf":[{"enum":["quarantine_release","acceptable_sender","allowed_sender","allowed_recipient","domain_similarity","domain_recency","managed_acceptable_sender","outbound_ndr"],"type":"string"}]},"blocklisted_message":{"type":"boolean"},"blocklisted_pattern":{"type":"string"},"whitelisted_pattern_type":{"allOf":[{"enum":["quarantine_release","acceptable_sender","allowed_sender","allowed_recipient","domain_similarity","domain_recency","managed_acceptable_sender","outbound_ndr"],"type":"string"}]}},"type":"object"},"replyto":{"nullable":true,"type":"string"},"sent_date":{"nullable":true,"type":"string"},"subject":{"nullable":true,"type":"string"},"threat_categories":{"items":{"type":"string"},"nullable":true,"type":"array"},"to":{"items":{"type":"string"},"nullable":true,"type":"array"},"to_name":{"items":{"type":"string"},"nullable":true,"type":"array"},"ts":{"type":"string"},"validation":{"allOf":[{"properties":{"comment":{"nullable":true,"type":"string"},"dkim":{"allOf":[{"$ref":"#/components/schemas/email-security_ValidationStatus"},{"nullable":true,"type":"string"}]},"dmarc":{"allOf":[{"$ref":"#/components/schemas/email-security_ValidationStatus"},{"nullable":true,"type":"string"}]},"spf":{"allOf":[{"$ref":"#/components/schemas/email-security_ValidationStatus"},{"nullable":true,"type":"string"}]}},"type":"object"},{"nullable":true,"type":"object"}]}},"required":["ts","client_recipients","postfix_id","detection_reasons","action_log","is_quarantined","is_phish_submission","properties"],"type":"object"},{"properties":{"id":{"type":"string","x-auditable":true}},"required":["id"],"type":"object"}],"example":{"action_log":[],"alert_id":"4Njp3P0STMz2c02Q-2022-12-30T02:44:49","client_recipients":["email@example.com"],"delivery_mode":"DIRECT","detection_reasons":["Selector is a source of spam/uce : Smtp-Helo-Server-Ip=\u003cb\u003e127.0.0[dot]186\u003c/b\u003e"],"edf_hash":null,"envelope_from":"d1994@example.com","envelope_to":["email@example.com"],"final_disposition":"MALICIOUS","findings":null,"from":"d1994@example.com","from_name":"Sender Name","htmltext_structure_hash":null,"id":"47JJcT1w6GztQV7-email@example.com","is_phish_submission":false,"is_quarantined":false,"message_id":"\u003c4VAZPrAdg7IGNxdt1DWRNu0gvOeL_iZiwP4BQfo4DaE.Yw-woXuugQbeFhBpzwFQtqq_v2v1HOKznoMBqbciQpE@example.com\u003e","postfix_id":"47JJcT1w6GztQV7","properties":{},"replyto":"email@example.com","sent_date":"2019-11-21T00:22:01","subject":"listen, I highly recommend u to read that email, just to ensure not a thing will take place","threat_categories":["IPReputation","ASNReputation"],"to":["email@example.com"],"to_name":["Recipient Name"],"ts":"2019-11-20T23:22:01","validation":{"comment":null,"dkim":"pass","dmarc":"none","spf":"fail"}}}},"required":["result"],"type":"object"}]}}},"description":"Contains the email message details."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get message details","tags":["Email Security"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]}},"/accounts/{account_id}/email-security/investigate/{postfix_id}/detections":{"get":{"description":"Returns detection details such as threat categories and sender information for non-benign messages.","operationId":"email_security_get_message_detections","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"postfix_id","required":true,"schema":{"description":"The identifier of the message.","example":"4Njp3P0STMz2c02Q","title":"postfix_id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"example":{"action":"QUARANTINED","attachments":[],"final_disposition":"MALICIOUS","headers":[{"name":"From","value":"Sender Name \u003cd1994@example.com\u003e"},{"name":"Subject","value":"listen, I highly recommend u to read that email, just to ensure not a thing will take place"}],"links":[{"href":"https://example.com","text":"Click here!"}],"sender_info":{"as_name":"AS0","as_number":0,"geo":"US/-/-","ip":"127.0.0.1","pld":"example.com"},"threat_categories":[{"description":null,"id":1234,"name":"IP Reputation"}],"validation":{"comment":null,"dkim":"pass","dmarc":"none","spf":"fail"}},"properties":{"action":{"type":"string"},"attachments":{"items":{"$ref":"#/components/schemas/email-security_Attachment"},"type":"array"},"final_disposition":{"allOf":[{"$ref":"#/components/schemas/email-security_DispositionLabel"},{"nullable":true,"type":"string"}]},"headers":{"items":{"$ref":"#/components/schemas/email-security_MessageHeader"},"type":"array"},"links":{"items":{"$ref":"#/components/schemas/email-security_Link"},"type":"array"},"sender_info":{"properties":{"as_name":{"description":"The name of the autonomous system.","nullable":true,"type":"string"},"as_number":{"description":"The number of the autonomous system.","format":"int64","nullable":true,"type":"integer"},"geo":{"nullable":true,"type":"string"},"ip":{"nullable":true,"type":"string"},"pld":{"nullable":true,"type":"string"}},"type":"object"},"threat_categories":{"items":{"$ref":"#/components/schemas/email-security_ThreatCategory"},"type":"array"},"validation":{"properties":{"comment":{"nullable":true,"type":"string"},"dkim":{"allOf":[{"$ref":"#/components/schemas/email-security_ValidationStatus"},{"nullable":true,"type":"string"}]},"dmarc":{"allOf":[{"$ref":"#/components/schemas/email-security_ValidationStatus"},{"nullable":true,"type":"string"}]},"spf":{"allOf":[{"$ref":"#/components/schemas/email-security_ValidationStatus"},{"nullable":true,"type":"string"}]}},"type":"object"}},"required":["validation","headers","threat_categories","sender_info","links","action","attachments"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"Contains the email message details."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get message detection details","tags":["Email Security"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]}},"/accounts/{account_id}/email-security/investigate/{postfix_id}/move":{"post":{"operationId":"email_security_post_message_move","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"postfix_id","required":true,"schema":{"description":"The identifier of the message.","example":"4Njp3P0STMz2c02Q","title":"postfix_id","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination":{"enum":["Inbox","JunkEmail","DeletedItems","RecoverableItemsDeletions","RecoverableItemsPurges"],"type":"string"}},"required":["destination"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/email-security_RetractionResponseItem"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Move a message","tags":["Email Security"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/investigate/{postfix_id}/preview":{"get":{"description":"Returns a preview of the message body as a base64 encoded PNG image for non-benign messages.","operationId":"email_security_get_message_preview","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"postfix_id","required":true,"schema":{"description":"The identifier of the message.","example":"4Njp3P0STMz2c02Q","title":"postfix_id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"example":{"screenshot":"iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAYAAADimHc4AAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABgAAAAAQAAAGAAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAAGCgAwAEAAAAAQAAAGAAAAAAtVTeigAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KGV7hBwAACXtJREFUeAHtmwtwXFUZgP9zX7t3b7LNa9M2tGmLDbaWKpL6aBBJHdERQWGkU4u8CraVWmYQYWQUMSoKhZJikYo4Qqc6RVqkKmNHC0K1FGYoM9pqS4FAa9s0aTavfd3d+zq/527YSNvdzWY3m2ySc2c2595z/vOf///+e+4959wTAH5wApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwAhOJABmvzuCz158HXmUp2rCEOlhGbEdFh2qASFAgtiCKMUGgh8FM7IDDp3aQlt12Kfo6rgKAz3ylAQ3rJ/Fg39XYfyx32wUJpJpZ7wiq8LPebuGJaXfuipVKMHJ3YowsRgQC265aE+/quYf2/Le2YDM85aBOn/m7GDHX+m/4W0/B+gpUUNIBwN98rknvif4J+9urC/Tz7OqKBp66+vWSUf9dsvpx62yB0ckpyQDgLxtlS5iyyTx59OuATlFJkOrZYV9l7afItdv/XdSGMigvuQBEHmyqJRLug9DJ+gw2j3y2qIDWcOEPyFef/tHIK8+usaQCEGpdPFd0rEMQC8rZzS5OqXr+JU+JV2+5pjja02sV0mePfm7/I5+eIznm22MF3/U4/p+/L3d23LhxNL0viR7Qs/ETfo/lnIBIsHw0nU/bFiGgLbp0BfnirzanLR/hzJLoAV6QXywJ+C5cNu6N7d/7JD6zat4Is06rbswDENvU/A3sPd6Y1rqxyjRjkDj1zp7RaH5MA3CkpdkL0fAvRsPR4bbhBNtqcNvS7w233nDlxzQAgUp7E+pjPhnNyEw/duRefJLdJEU8pGLo7mptnuuTSJNHkeaBIPhMK/6Gbjm7A7ftfTPV3sGWBQpEu1ekrksxxWgQoLr6Tmbbj4tl34iOgmIbPnsLG8w9hKETajqDiX86sCXJe/1a4D4QEnfF2t/6fjq5UsojFTNQu21v0Z4UIxKA4LqL6nwyfQ3DJ8/JBR7x1wGIEmDfsVzEx1xGO3f+xeT6v7xcDEMKjmystXmRSkPtucJ3nWCy4wZ+0l7wfLsY8F2dBQWg46cfDaDVtw+MSLHsKwm98VDky8UypKAA+BVpF8T7i2Vb6eg1IiPyqE7nUN6joL51jUsw2nVBOqUTLc9TGfi965O++dLlomZvBSICyBoQpdyQVP8R4hFfgAQ+Spb8/PBwfc87AGWadrcR7x5ue+NS3qK2OxQFpcq72jGi7CXGvlGYYUAz7LGi7e6Shftba/x5ma1UB9ZDL2khlz1iuHWGOvJ+BJl65DNDKZ8I5UL17E515a4jri+OEbsoq096l2QeP3iXaR5N4MurH8SWliH5DimQqUHUezMVTah8tVx7wHUIdy6/gv3N7YlhRcHseOsOc9HBKL54S9Z1rrwCcLxlQdWEopzJGfbdGG7Y+XAyABK9MZNYxvx4t2r2vv067l55ayaZvAJgQ0zPpHAi5StT52xjnwfQ9cnWI9kfP5kcZ+8LM9i2EXfffE86kbwCMBuOmiCnXW1I18a4zCO+KuiVrZtSxqMVn5o6zyc1g+/+EF+47uYz6+Y8vg0/vPhygQjLRFH5JLXNWgx3+oGW5GazM33M61o+Z96VnpV//WOqsrF9SbInpK7zStnwVdDqmuQvbHk1VT9rAI63Lq6qJnQTNfRlkAin6kz4VKit/5ZvzZ7ksz/lrPmHy6KsF7CXQoGHp1JXOmoqUnuRMj6CEq0ff6Ay2tVDQ52TB77INmME6lecCd9FLlfUPFUg+oHqRp+Pzk08mtJ1Vg/oallQVlZR/i/a3/GBlNBkSIWqGW2iR7vCs3pX2tksvtQi2frBU1TvLnwEKChgls2ZWv75x7pOC4C7O8GbMNvYGD8wGaAD27QrT2s4KsrON6UVz+8cymd8fZUPYvLzZk9bEzjmUOJZy5VAw29J8+PXnRaAWGvjIQx3z89aM89CEmhwRMUXQVGRmOMC+x5AWOr+2NIKSwl7Ggoish8lRKDsSxplTVnuTwTU2aZzQwCMszehxXYu2AIhCQDKpvvERAImUGIK7jXSePJHWWpRHWw7wQYLcaDolplA0GLnukWddvmmpw+khpnDcQvfXF8DAlkKhnkhmEY52IYKlqGiZWho2z5KDYWtEPtpondGRr3eKlDKFsqDAQhvaLxfCHV/J2OFQgpkL2g152mw6rl4Pg4X0nSx6iL7PwQ4tF0GpXOAYchDIdIxMFIKHkRQKz2m8W4nWzcqz2SDUvfhS5KVO+9vXFhm9B5gd0gm2YLzhepze8G2goiCA6J7dxN31y0bxxKbBcUdz9psJ3ryjgc2d2Gb0m0KaDGTbHbHs/7Ozh1IUGC5wHoDEsthZQjUrWMTBMtheQSphQJYyFKB9Q6Kznup24Mck3Uvk1IITaP73iAtTFkeB+6/oxao8jHWA2ex3lVLEQPEtmqpZVewfxKpQjOmYLx/OpjR6mzqlfqFTyQDEHrogufESN/l2YQnXBmLuhyY+YpBjS/5177WM5R/+I9bA+Cl66ye0DUYbfcMJZ9LuVgz/wQJbrh4uho+wb4R5nUz5NJOact4/WznQ8VHylbuOZDJUNx97Vazu2P5SDMi5bNAKpetpfZkhe8SdyeYEfUVdlZ2ZgBwx5UVjoL7zWB7/ZllI3GNiW425vDVrBkJZeNaR/iUFnns4g+93wd89qpqC+Jtjh4uCvxkW1YMBDNhfvD9DU/Wc0VwBoff+FKz5JDwPrTNrC/Rglm5/zyIkVMF65kICmyHzRPeO5w+2Ow4dE7qumgpmwsIk2JXQw4E43H9n65Y75am8x2HfC2HKgWLEG+1I4BU1L2nBRs5GgrcLZM1t+9vd9vy+jx3j0abbhuypu0TSNnkWPbJBpWtV/w6VS6gsDR1XvQU6Vapa4qkJvrVaRTEMFvAsB2drcewQ/Q5BNj0JOSjA1NtljdFFwY/Srgzlwp1QNaVTx1inNU77dV12gU4qjSoI1XHictn5dla71l5KfnBdIjXl1U2oNcMKTh9SgfaPazthoHaXjswuBQ/8/ZX4ymdHVFHU+tmimoo4Ul4JBmdBFt5khDVBJtbS1junvt0REtO/tx6RLaSjIg+kKZ0oclktCibx//fP0HzCIIlCwnPFLn2+LHJsa8nBYSnnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACk4DA/wDoepVZ2hARhAAAAABJRU5ErkJggg=="},"properties":{"screenshot":{"description":"A base64 encoded PNG image of the email.","type":"string"}},"required":["screenshot"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"Contains a preview of the email."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get email preview","tags":["Email Security"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]}},"/accounts/{account_id}/email-security/investigate/{postfix_id}/raw":{"get":{"description":"Returns the raw eml of any non-benign message.","operationId":"email_security_get_message_raw","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"postfix_id","required":true,"schema":{"description":"The identifier of the message.","example":"4Njp3P0STMz2c02Q","title":"postfix_id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"example":{"raw":"MIME-Version: 1.0\nContent-Type: text/plain; charset=\"utf-8\"\n\nFrom: sender@example.com\nTo: recipient@example.com\nSubject: Test Email\n\nThis is a test email."},"properties":{"raw":{"description":"A UTF-8 encoded eml file of the email.","type":"string"}},"required":["raw"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"Contains the raw content of the email."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get raw email content","tags":["Email Security"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]}},"/accounts/{account_id}/email-security/investigate/{postfix_id}/reclassify":{"post":{"operationId":"email_security_post_reclassify","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"postfix_id","required":true,"schema":{"description":"The identifier of the message.","example":"4Njp3P0STMz2c02Q","title":"postfix_id","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"eml_content":{"description":"Base64 encoded content of the EML file","type":"string"},"escalated_submission_id":{"type":"string","x-auditable":true},"expected_disposition":{"enum":["NONE","BULK","MALICIOUS","SPAM","SPOOF","SUSPICIOUS"],"type":"string"}},"required":["expected_disposition"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"type":"object"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Change email classfication","tags":["Email Security"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/investigate/{postfix_id}/trace":{"get":{"operationId":"email_security_get_message_trace","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"postfix_id","required":true,"schema":{"description":"The identifier of the message.","example":"4Njp3P0STMz2c02Q","title":"postfix_id","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"properties":{"inbound":{"properties":{"lines":{"items":{"$ref":"#/components/schemas/email-security_TraceLine"},"nullable":true,"type":"array"},"pending":{"nullable":true,"type":"boolean"}},"type":"object"},"outbound":{"properties":{"lines":{"items":{"$ref":"#/components/schemas/email-security_TraceLine"},"nullable":true,"type":"array"},"pending":{"nullable":true,"type":"boolean"}},"type":"object"}},"required":["inbound","outbound"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"Contains the email trace."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get email trace","tags":["Email Security"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]}},"/accounts/{account_id}/email-security/settings/allow_policies":{"get":{"description":"Lists, searches, and sorts an account’s email allow policies.","operationId":"email_security_list_allow_policies","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"description":"The page number of paginated results.","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"}},{"description":"The number of results per page.","in":"query","name":"per_page","schema":{"default":20,"format":"int32","minimum":1,"type":"integer"}},{"description":"The field to sort by.","in":"query","name":"order","schema":{"enum":["pattern","created_at"],"type":"string"}},{"description":"The sorting direction.","in":"query","name":"direction","schema":{"allOf":[{"$ref":"#/components/schemas/email-security_SortingDirection"}]}},{"description":"Allows searching in multiple properties of a record simultaneously.\nThis parameter is intended for human users, not automation. Its exact\nbehavior is intentionally left unspecified and is subject to change\nin the future.","in":"query","name":"search","schema":{"type":"string"}},{"deprecated":true,"in":"query","name":"is_sender","schema":{"type":"boolean"}},{"in":"query","name":"is_trusted_sender","schema":{"type":"boolean"}},{"deprecated":true,"in":"query","name":"is_recipient","schema":{"type":"boolean"}},{"in":"query","name":"is_exempt_recipient","schema":{"type":"boolean"}},{"deprecated":true,"in":"query","name":"is_spoof","schema":{"type":"boolean"}},{"in":"query","name":"is_acceptable_sender","schema":{"type":"boolean"}},{"in":"query","name":"verify_sender","schema":{"type":"boolean"}},{"in":"query","name":"pattern_type","schema":{"allOf":[{"$ref":"#/components/schemas/email-security_PatternType"}]}},{"in":"query","name":"pattern","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/email-security_AllowPolicy"},"type":"array"},"result_info":{"$ref":"#/components/schemas/email-security_ResultInfo"}},"required":["result","result_info"],"type":"object"}]}}},"description":"Contains a list of allow policies for the account."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List email allow policies","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]},"post":{"operationId":"email_security_create_allow_policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email-security_CreateAllowPolicy"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"allOf":[{"additionalProperties":false,"example":{"comments":"Trust all messages send from test@example.com","is_acceptable_sender":false,"is_exempt_recipient":false,"is_recipient":false,"is_regex":false,"is_sender":true,"is_spoof":false,"is_trusted_sender":true,"pattern":"test@example.com","pattern_type":"EMAIL","verify_sender":true},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_acceptable_sender":{"description":"Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions.\nNote: This will not exempt messages with Malicious or Suspicious dispositions.","type":"boolean","x-auditable":true},"is_exempt_recipient":{"description":"Messages to this recipient will bypass all detections.","type":"boolean","x-auditable":true},"is_recipient":{"deprecated":true,"type":"boolean","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"is_sender":{"deprecated":true,"type":"boolean","x-auditable":true},"is_spoof":{"deprecated":true,"type":"boolean","x-auditable":true},"is_trusted_sender":{"description":"Messages from this sender will bypass all detections and link following.","type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true},"pattern_type":{"$ref":"#/components/schemas/email-security_PatternType"},"verify_sender":{"description":"Enforce DMARC, SPF or DKIM authentication.\nWhen on, Email Security only honors policies that pass authentication.","type":"boolean","x-auditable":true}},"required":["is_exempt_recipient","is_trusted_sender","is_acceptable_sender","pattern","is_regex","verify_sender","pattern_type"],"type":"object"},{"properties":{"created_at":{"format":"date-time","type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/email-security_AllowPolicyId"},"last_modified":{"format":"date-time","type":"string","x-auditable":true}},"required":["id","created_at","last_modified"],"type":"object"}],"example":{"comments":"Trust all messages send from test@example.com","created_at":"2023-11-14T22:13:20Z","id":2401,"is_acceptable_sender":false,"is_exempt_recipient":false,"is_recipient":false,"is_regex":false,"is_sender":true,"is_spoof":false,"is_trusted_sender":true,"last_modified":"2023-11-14T22:13:20Z","pattern":"test@example.com","pattern_type":"EMAIL","verify_sender":true}}},"required":["result"],"type":"object"}]}}},"description":"Contains the newly created policy."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create an email allow policy","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/settings/allow_policies/batch":{"post":{"description":"Send a Batch of Allow Policies API calls to be executed together.","operationId":"email_security_batch_allow_policies","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"deletes":{"items":{"properties":{"id":{"description":"The unique identifier for the allow policy.","example":2401,"format":"int32","title":"identifier","type":"integer"}},"required":["id"],"type":"object"},"type":"array"},"patches":{"items":{"allOf":[{"$ref":"#/components/schemas/email-security_UpdateAllowPolicy"},{"properties":{"id":{"$ref":"#/components/schemas/email-security_AllowPolicyId"}},"required":["id"],"type":"object"}]},"type":"array"},"posts":{"items":{"$ref":"#/components/schemas/email-security_CreateAllowPolicy"},"type":"array"},"puts":{"items":{"allOf":[{"$ref":"#/components/schemas/email-security_CreateAllowPolicy"},{"properties":{"id":{"$ref":"#/components/schemas/email-security_AllowPolicyId"}},"required":["id"],"type":"object"}]},"type":"array"}},"required":["deletes","patches","puts","posts"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"properties":{"deletes":{"items":{"properties":{"id":{"description":"The unique identifier for the allow policy.","example":2401,"format":"int32","title":"identifier","type":"integer"}},"required":["id"],"type":"object"},"type":"array"},"patches":{"items":{"$ref":"#/components/schemas/email-security_AllowPolicy"},"type":"array"},"posts":{"items":{"$ref":"#/components/schemas/email-security_AllowPolicy"},"type":"array"},"puts":{"items":{"$ref":"#/components/schemas/email-security_AllowPolicy"},"type":"array"}},"required":["deletes","patches","puts","posts"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Batch Allow Policies","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}":{"delete":{"operationId":"email_security_delete_allow_policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AllowPolicyId"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"properties":{"id":{"description":"The unique identifier for the allow policy.","example":2401,"format":"int32","title":"identifier","type":"integer"}},"required":["id"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete an email allow policy","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]},"get":{"operationId":"email_security_get_allow_policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AllowPolicyId"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"allOf":[{"additionalProperties":false,"example":{"comments":"Trust all messages send from test@example.com","is_acceptable_sender":false,"is_exempt_recipient":false,"is_recipient":false,"is_regex":false,"is_sender":true,"is_spoof":false,"is_trusted_sender":true,"pattern":"test@example.com","pattern_type":"EMAIL","verify_sender":true},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_acceptable_sender":{"description":"Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions.\nNote: This will not exempt messages with Malicious or Suspicious dispositions.","type":"boolean","x-auditable":true},"is_exempt_recipient":{"description":"Messages to this recipient will bypass all detections.","type":"boolean","x-auditable":true},"is_recipient":{"deprecated":true,"type":"boolean","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"is_sender":{"deprecated":true,"type":"boolean","x-auditable":true},"is_spoof":{"deprecated":true,"type":"boolean","x-auditable":true},"is_trusted_sender":{"description":"Messages from this sender will bypass all detections and link following.","type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true},"pattern_type":{"$ref":"#/components/schemas/email-security_PatternType"},"verify_sender":{"description":"Enforce DMARC, SPF or DKIM authentication.\nWhen on, Email Security only honors policies that pass authentication.","type":"boolean","x-auditable":true}},"required":["is_exempt_recipient","is_trusted_sender","is_acceptable_sender","pattern","is_regex","verify_sender","pattern_type"],"type":"object"},{"properties":{"created_at":{"format":"date-time","type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/email-security_AllowPolicyId"},"last_modified":{"format":"date-time","type":"string","x-auditable":true}},"required":["id","created_at","last_modified"],"type":"object"}],"example":{"comments":"Trust all messages send from test@example.com","created_at":"2023-11-14T22:13:20Z","id":2401,"is_acceptable_sender":false,"is_exempt_recipient":false,"is_recipient":false,"is_regex":false,"is_sender":true,"is_spoof":false,"is_trusted_sender":true,"last_modified":"2023-11-14T22:13:20Z","pattern":"test@example.com","pattern_type":"EMAIL","verify_sender":true}}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get an email allow policy","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]},"patch":{"operationId":"email_security_update_allow_policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AllowPolicyId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email-security_UpdateAllowPolicy"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"allOf":[{"additionalProperties":false,"example":{"comments":"Trust all messages send from test@example.com","is_acceptable_sender":false,"is_exempt_recipient":false,"is_recipient":false,"is_regex":false,"is_sender":true,"is_spoof":false,"is_trusted_sender":true,"pattern":"test@example.com","pattern_type":"EMAIL","verify_sender":true},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_acceptable_sender":{"description":"Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions.\nNote: This will not exempt messages with Malicious or Suspicious dispositions.","type":"boolean","x-auditable":true},"is_exempt_recipient":{"description":"Messages to this recipient will bypass all detections.","type":"boolean","x-auditable":true},"is_recipient":{"deprecated":true,"type":"boolean","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"is_sender":{"deprecated":true,"type":"boolean","x-auditable":true},"is_spoof":{"deprecated":true,"type":"boolean","x-auditable":true},"is_trusted_sender":{"description":"Messages from this sender will bypass all detections and link following.","type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true},"pattern_type":{"$ref":"#/components/schemas/email-security_PatternType"},"verify_sender":{"description":"Enforce DMARC, SPF or DKIM authentication.\nWhen on, Email Security only honors policies that pass authentication.","type":"boolean","x-auditable":true}},"required":["is_exempt_recipient","is_trusted_sender","is_acceptable_sender","pattern","is_regex","verify_sender","pattern_type"],"type":"object"},{"properties":{"created_at":{"format":"date-time","type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/email-security_AllowPolicyId"},"last_modified":{"format":"date-time","type":"string","x-auditable":true}},"required":["id","created_at","last_modified"],"type":"object"}],"example":{"comments":"Trust all messages send from test@example.com","created_at":"2023-11-14T22:13:20Z","id":2401,"is_acceptable_sender":false,"is_exempt_recipient":false,"is_recipient":false,"is_regex":false,"is_sender":true,"is_spoof":false,"is_trusted_sender":true,"last_modified":"2023-11-14T22:13:20Z","pattern":"test@example.com","pattern_type":"EMAIL","verify_sender":true}}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update an email allow policy","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/settings/block_senders":{"get":{"operationId":"email_security_list_blocked_senders","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"description":"The page number of paginated results.","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"}},{"description":"The number of results per page.","in":"query","name":"per_page","schema":{"default":20,"format":"int32","minimum":1,"type":"integer"}},{"description":"The field to sort by.","in":"query","name":"order","schema":{"enum":["pattern","created_at"],"type":"string"}},{"description":"The sorting direction.","in":"query","name":"direction","schema":{"allOf":[{"$ref":"#/components/schemas/email-security_SortingDirection"}]}},{"description":"Allows searching in multiple properties of a record simultaneously.\nThis parameter is intended for human users, not automation. Its exact\nbehavior is intentionally left unspecified and is subject to change\nin the future.","in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"pattern_type","schema":{"allOf":[{"$ref":"#/components/schemas/email-security_PatternType"}]}},{"in":"query","name":"pattern","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/email-security_BlockedSender"},"type":"array"},"result_info":{"$ref":"#/components/schemas/email-security_ResultInfo"}},"required":["result","result_info"],"type":"object"}]}}},"description":"Contains a list of blocked senders for the account."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List blocked email senders","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]},"post":{"operationId":"email_security_create_blocked_sender","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email-security_CreateBlockedSender"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"allOf":[{"additionalProperties":false,"example":{"comments":"block sender with email test@example.com","is_regex":false,"pattern":"test@example.com","pattern_type":"EMAIL"},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true},"pattern_type":{"$ref":"#/components/schemas/email-security_PatternType"}},"required":["pattern","is_regex","pattern_type"],"type":"object"},{"properties":{"created_at":{"format":"date-time","type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/email-security_BlockedSenderId"},"last_modified":{"format":"date-time","type":"string","x-auditable":true}},"required":["id","created_at","last_modified"],"type":"object"}],"example":{"comments":"block sender with email test@example.com","created_at":"2023-11-14T22:13:20Z","id":2402,"is_regex":false,"last_modified":"2023-11-14T22:13:20Z","pattern":"test@example.com","pattern_type":"EMAIL"}}},"required":["result"],"type":"object"}]}}},"description":"Contains the newly created pattern."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a blocked email sender","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/settings/block_senders/batch":{"post":{"description":"Send a Batch of Block Senders API calls to be executed together.","operationId":"email_security_batch_blocked_senders","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"deletes":{"items":{"properties":{"id":{"description":"The unique identifier for the allow policy.","example":2402,"format":"int32","title":"identifier","type":"integer"}},"required":["id"],"type":"object"},"type":"array"},"patches":{"items":{"allOf":[{"$ref":"#/components/schemas/email-security_UpdateBlockedSender"},{"properties":{"id":{"$ref":"#/components/schemas/email-security_BlockedSenderId"}},"required":["id"],"type":"object"}]},"type":"array"},"posts":{"items":{"$ref":"#/components/schemas/email-security_CreateBlockedSender"},"type":"array"},"puts":{"items":{"allOf":[{"$ref":"#/components/schemas/email-security_CreateBlockedSender"},{"properties":{"id":{"$ref":"#/components/schemas/email-security_BlockedSenderId"}},"required":["id"],"type":"object"}]},"type":"array"}},"required":["deletes","patches","puts","posts"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"properties":{"deletes":{"items":{"properties":{"id":{"description":"The unique identifier for the allow policy.","example":2402,"format":"int32","title":"identifier","type":"integer"}},"required":["id"],"type":"object"},"type":"array"},"patches":{"items":{"$ref":"#/components/schemas/email-security_BlockedSender"},"type":"array"},"posts":{"items":{"$ref":"#/components/schemas/email-security_BlockedSender"},"type":"array"},"puts":{"items":{"$ref":"#/components/schemas/email-security_BlockedSender"},"type":"array"}},"required":["deletes","patches","puts","posts"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Batch Block Senders","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}":{"delete":{"operationId":"email_security_delete_blocked_sender","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"pattern_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_BlockedSenderId"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"properties":{"id":{"description":"The unique identifier for the allow policy.","example":2402,"format":"int32","title":"identifier","type":"integer"}},"required":["id"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a blocked email sender","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]},"get":{"operationId":"email_security_get_blocked_sender","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"pattern_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_BlockedSenderId"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"allOf":[{"additionalProperties":false,"example":{"comments":"block sender with email test@example.com","is_regex":false,"pattern":"test@example.com","pattern_type":"EMAIL"},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true},"pattern_type":{"$ref":"#/components/schemas/email-security_PatternType"}},"required":["pattern","is_regex","pattern_type"],"type":"object"},{"properties":{"created_at":{"format":"date-time","type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/email-security_BlockedSenderId"},"last_modified":{"format":"date-time","type":"string","x-auditable":true}},"required":["id","created_at","last_modified"],"type":"object"}],"example":{"comments":"block sender with email test@example.com","created_at":"2023-11-14T22:13:20Z","id":2402,"is_regex":false,"last_modified":"2023-11-14T22:13:20Z","pattern":"test@example.com","pattern_type":"EMAIL"}}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a blocked email sender","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]},"patch":{"operationId":"email_security_update_blocked_sender","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"pattern_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_BlockedSenderId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email-security_UpdateBlockedSender"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"allOf":[{"additionalProperties":false,"example":{"comments":"block sender with email test@example.com","is_regex":false,"pattern":"test@example.com","pattern_type":"EMAIL"},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true},"pattern_type":{"$ref":"#/components/schemas/email-security_PatternType"}},"required":["pattern","is_regex","pattern_type"],"type":"object"},{"properties":{"created_at":{"format":"date-time","type":"string","x-auditable":true},"id":{"$ref":"#/components/schemas/email-security_BlockedSenderId"},"last_modified":{"format":"date-time","type":"string","x-auditable":true}},"required":["id","created_at","last_modified"],"type":"object"}],"example":{"comments":"block sender with email test@example.com","created_at":"2023-11-14T22:13:20Z","id":2402,"is_regex":false,"last_modified":"2023-11-14T22:13:20Z","pattern":"test@example.com","pattern_type":"EMAIL"}}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update a blocked email sender","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/settings/domains":{"delete":{"operationId":"email_security_delete_domains","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"properties":{"id":{"description":"The unique identifier for the domain.","example":2400,"format":"int32","type":"integer"}},"required":["id"],"type":"object"},"minItems":1,"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"items":{"properties":{"id":{"description":"The unique identifier for the domain.","example":2400,"format":"int32","type":"integer"}},"required":["id"],"type":"object"},"minItems":1,"type":"array"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Unprotect multiple email domains","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]},"get":{"description":"Lists, searches, and sorts an account’s email domains.","operationId":"email_security_list_domains","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"description":"The page number of paginated results.","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"}},{"description":"The number of results per page.","in":"query","name":"per_page","schema":{"default":20,"format":"int32","minimum":1,"type":"integer"}},{"description":"The field to sort by.","in":"query","name":"order","schema":{"enum":["domain","created_at"],"type":"string"}},{"description":"The sorting direction.","in":"query","name":"direction","schema":{"allOf":[{"$ref":"#/components/schemas/email-security_SortingDirection"}]}},{"description":"Allows searching in multiple properties of a record simultaneously.\nThis parameter is intended for human users, not automation. Its exact\nbehavior is intentionally left unspecified and is subject to change\nin the future.","in":"query","name":"search","schema":{"type":"string"}},{"description":"Filters response to domains with the provided delivery mode.","in":"query","name":"allowed_delivery_mode","schema":{"allOf":[{"$ref":"#/components/schemas/email-security_DeliveryMode"}]}},{"description":"Filters results by the provided domains, allowing for multiple occurrences.","example":"domain=example.com\u0026domain=example.xyz","in":"query","name":"domain","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Filters response to domains with the currently active delivery mode.","in":"query","name":"active_delivery_mode","schema":{"allOf":[{"$ref":"#/components/schemas/email-security_DeliveryMode"}]}},{"description":"Filters response to domains with the provided integration ID.","in":"query","name":"integration_id","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/email-security_Domain"},"type":"array"},"result_info":{"$ref":"#/components/schemas/email-security_ResultInfo"}},"required":["result","result_info"],"type":"object"}]}}},"description":"Contains a list of domains for the account."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List protected email domains","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]}},"/accounts/{account_id}/email-security/settings/domains/{domain_id}":{"delete":{"operationId":"email_security_delete_domain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"domain_id","required":true,"schema":{"description":"The unique identifier for the domain.","example":2400,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"properties":{"id":{"description":"The unique identifier for the domain.","example":2400,"format":"int32","type":"integer"}},"required":["id"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"Deletes the domain with the provided id."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Unprotect an email domain","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]},"get":{"operationId":"email_security_get_domain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"domain_id","required":true,"schema":{"description":"The unique identifier for the domain.","example":2400,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"example":{"allowed_delivery_modes":["API"],"authorization":null,"created_at":"2023-11-14T22:13:20Z","dmarc_status":"good","domain":"example.com","drop_dispositions":["MALICIOUS","SPAM"],"emails_processed":null,"folder":"Inbox","id":2400,"inbox_provider":"Microsoft","integration_id":"a5dbb180-60ea-4578-84bb-d01a5d4e50c3","ip_restrictions":[],"last_modified":"2023-11-14T22:13:20Z","lookback_hops":2,"o365_tenant_id":"c3c3239d-8858-47df-9618-0e2d9bdf6aa8","regions":["GLOBAL"],"require_tls_inbound":false,"require_tls_outbound":true,"spf_status":"good","transport":"example.com"},"properties":{"allowed_delivery_modes":{"items":{"$ref":"#/components/schemas/email-security_DeliveryMode"},"type":"array"},"authorization":{"allOf":[{"properties":{"authorized":{"type":"boolean"},"status_message":{"nullable":true,"type":"string"},"timestamp":{"format":"date-time","type":"string"}},"required":["authorized","timestamp"],"type":"object"},{"nullable":true,"type":"object"}]},"created_at":{"format":"date-time","type":"string"},"dmarc_status":{"allOf":[{"enum":["none","good","invalid"],"type":"string"},{"nullable":true,"type":"string"}]},"domain":{"type":"string"},"drop_dispositions":{"items":{"$ref":"#/components/schemas/email-security_DispositionLabel"},"type":"array"},"emails_processed":{"allOf":[{"properties":{"timestamp":{"format":"date-time","type":"string"},"total_emails_processed":{"format":"int32","minimum":0,"type":"integer"},"total_emails_processed_previous":{"format":"int32","minimum":0,"type":"integer"}},"required":["total_emails_processed","total_emails_processed_previous","timestamp"],"type":"object"},{"nullable":true,"type":"object"}]},"folder":{"allOf":[{"$ref":"#/components/schemas/email-security_ScannableFolder"},{"nullable":true,"type":"string"}]},"id":{"description":"The unique identifier for the domain.","example":2400,"format":"int32","type":"integer"},"inbox_provider":{"allOf":[{"enum":["Microsoft","Google"],"type":"string"},{"nullable":true,"type":"string"}]},"integration_id":{"format":"uuid","nullable":true,"type":"string"},"ip_restrictions":{"example":["192.0.2.0/24","2001:db8::/32"],"items":{"type":"string"},"type":"array"},"last_modified":{"format":"date-time","type":"string"},"lookback_hops":{"format":"int32","type":"integer"},"o365_tenant_id":{"nullable":true,"type":"string"},"regions":{"items":{"enum":["GLOBAL","AU","DE","IN","US"],"type":"string"},"type":"array"},"require_tls_inbound":{"nullable":true,"type":"boolean"},"require_tls_outbound":{"nullable":true,"type":"boolean"},"spf_status":{"allOf":[{"enum":["none","good","neutral","open","invalid"],"type":"string"},{"nullable":true,"type":"string"}]},"transport":{"type":"string"}},"required":["id","created_at","last_modified","domain","allowed_delivery_modes","lookback_hops","ip_restrictions","transport","drop_dispositions","regions"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get an email domain","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]},"patch":{"operationId":"email_security_update_domain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"domain_id","required":true,"schema":{"description":"The unique identifier for the domain.","example":2400,"format":"int32","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"allowed_delivery_modes":{"items":{"$ref":"#/components/schemas/email-security_DeliveryMode"},"type":"array"},"domain":{"type":"string","x-auditable":true},"drop_dispositions":{"items":{"$ref":"#/components/schemas/email-security_DispositionLabel"},"type":"array"},"folder":{"allOf":[{"$ref":"#/components/schemas/email-security_ScannableFolder"}]},"integration_id":{"format":"uuid","type":"string","x-auditable":true},"ip_restrictions":{"example":["192.0.2.0/24","2001:db8::/32"],"items":{"type":"string","x-auditable":true},"type":"array"},"lookback_hops":{"format":"int32","maximum":20,"minimum":1,"type":"integer","x-auditable":true},"regions":{"items":{"enum":["GLOBAL","AU","DE","IN","US"],"type":"string"},"type":"array"},"require_tls_inbound":{"type":"boolean","x-auditable":true},"require_tls_outbound":{"type":"boolean","x-auditable":true},"transport":{"type":"string","x-auditable":true}},"required":["ip_restrictions"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"example":{"allowed_delivery_modes":["API"],"authorization":null,"created_at":"2023-11-14T22:13:20Z","dmarc_status":"good","domain":"example.com","drop_dispositions":["MALICIOUS","SPAM"],"emails_processed":null,"folder":"Inbox","id":2400,"inbox_provider":"Microsoft","integration_id":"a5dbb180-60ea-4578-84bb-d01a5d4e50c3","ip_restrictions":[],"last_modified":"2023-11-14T22:13:20Z","lookback_hops":2,"o365_tenant_id":"c3c3239d-8858-47df-9618-0e2d9bdf6aa8","regions":["GLOBAL"],"require_tls_inbound":false,"require_tls_outbound":true,"spf_status":"good","transport":"example.com"},"properties":{"allowed_delivery_modes":{"items":{"$ref":"#/components/schemas/email-security_DeliveryMode"},"type":"array"},"authorization":{"allOf":[{"properties":{"authorized":{"type":"boolean"},"status_message":{"nullable":true,"type":"string"},"timestamp":{"format":"date-time","type":"string"}},"required":["authorized","timestamp"],"type":"object"},{"nullable":true,"type":"object"}]},"created_at":{"format":"date-time","type":"string"},"dmarc_status":{"allOf":[{"enum":["none","good","invalid"],"type":"string"},{"nullable":true,"type":"string"}]},"domain":{"type":"string"},"drop_dispositions":{"items":{"$ref":"#/components/schemas/email-security_DispositionLabel"},"type":"array"},"emails_processed":{"allOf":[{"properties":{"timestamp":{"format":"date-time","type":"string"},"total_emails_processed":{"format":"int32","minimum":0,"type":"integer"},"total_emails_processed_previous":{"format":"int32","minimum":0,"type":"integer"}},"required":["total_emails_processed","total_emails_processed_previous","timestamp"],"type":"object"},{"nullable":true,"type":"object"}]},"folder":{"allOf":[{"$ref":"#/components/schemas/email-security_ScannableFolder"},{"nullable":true,"type":"string"}]},"id":{"description":"The unique identifier for the domain.","example":2400,"format":"int32","type":"integer"},"inbox_provider":{"allOf":[{"enum":["Microsoft","Google"],"type":"string"},{"nullable":true,"type":"string"}]},"integration_id":{"format":"uuid","nullable":true,"type":"string"},"ip_restrictions":{"example":["192.0.2.0/24","2001:db8::/32"],"items":{"type":"string"},"type":"array"},"last_modified":{"format":"date-time","type":"string"},"lookback_hops":{"format":"int32","type":"integer"},"o365_tenant_id":{"nullable":true,"type":"string"},"regions":{"items":{"enum":["GLOBAL","AU","DE","IN","US"],"type":"string"},"type":"array"},"require_tls_inbound":{"nullable":true,"type":"boolean"},"require_tls_outbound":{"nullable":true,"type":"boolean"},"spf_status":{"allOf":[{"enum":["none","good","neutral","open","invalid"],"type":"string"},{"nullable":true,"type":"string"}]},"transport":{"type":"string"}},"required":["id","created_at","last_modified","domain","allowed_delivery_modes","lookback_hops","ip_restrictions","transport","drop_dispositions","regions"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update an email domain","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/settings/impersonation_registry":{"get":{"description":"Lists, searches, and sorts entries in the impersonation registry.","operationId":"email_security_list_display_names","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"description":"The page number of paginated results.","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"}},{"description":"The number of results per page.","in":"query","name":"per_page","schema":{"default":20,"format":"int32","minimum":1,"type":"integer"}},{"description":"The field to sort by.","in":"query","name":"order","schema":{"enum":["name","email","created_at"],"type":"string"}},{"description":"The sorting direction.","in":"query","name":"direction","schema":{"allOf":[{"$ref":"#/components/schemas/email-security_SortingDirection"}]}},{"description":"Allows searching in multiple properties of a record simultaneously.\nThis parameter is intended for human users, not automation. Its exact\nbehavior is intentionally left unspecified and is subject to change\nin the future.","in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"provenance","schema":{"allOf":[{"enum":["A1S_INTERNAL","SNOOPY-CASB_OFFICE_365","SNOOPY-OFFICE_365","SNOOPY-GOOGLE_DIRECTORY"],"type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/email-security_DisplayName"},"type":"array"},"result_info":{"$ref":"#/components/schemas/email-security_ResultInfo"}},"required":["result","result_info"],"type":"object"}]}}},"description":"Contains the list of impersonation registry entries for the account."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List entries in impersonation registry","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]},"post":{"operationId":"email_security_create_display_name","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email-security_CreateDisplayName"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"allOf":[{"properties":{"email":{"type":"string","x-auditable":true},"is_email_regex":{"type":"boolean","x-auditable":true},"name":{"maxLength":1024,"type":"string","x-auditable":true}},"required":["name","email","is_email_regex"],"type":"object"},{"properties":{"comments":{"nullable":true,"type":"string"},"created_at":{"format":"date-time","type":"string"},"directory_id":{"allOf":[{"format":"int64","type":"integer"},{"nullable":true,"type":"integer"}]},"directory_node_id":{"allOf":[{"format":"int64","type":"integer"},{"nullable":true,"type":"integer"}]},"external_directory_node_id":{"deprecated":true,"nullable":true,"type":"string"},"id":{"example":2403,"format":"int32","title":"identifier","type":"integer"},"last_modified":{"format":"date-time","type":"string"},"provenance":{"nullable":true,"type":"string"}},"required":["id","created_at","last_modified"],"type":"object"}]}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create an entry in impersonation registry","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}":{"delete":{"operationId":"email_security_delete_display_name","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"display_name_id","required":true,"schema":{"example":2403,"format":"int32","title":"identifier","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"properties":{"id":{"example":2403,"format":"int32","title":"identifier","type":"integer"}},"required":["id"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete an entry from impersonation registry","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]},"get":{"operationId":"email_security_get_display_name","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"display_name_id","required":true,"schema":{"example":2403,"format":"int32","title":"identifier","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"allOf":[{"properties":{"email":{"type":"string","x-auditable":true},"is_email_regex":{"type":"boolean","x-auditable":true},"name":{"maxLength":1024,"type":"string","x-auditable":true}},"required":["name","email","is_email_regex"],"type":"object"},{"properties":{"comments":{"nullable":true,"type":"string"},"created_at":{"format":"date-time","type":"string"},"directory_id":{"allOf":[{"format":"int64","type":"integer"},{"nullable":true,"type":"integer"}]},"directory_node_id":{"allOf":[{"format":"int64","type":"integer"},{"nullable":true,"type":"integer"}]},"external_directory_node_id":{"deprecated":true,"nullable":true,"type":"string"},"id":{"example":2403,"format":"int32","title":"identifier","type":"integer"},"last_modified":{"format":"date-time","type":"string"},"provenance":{"nullable":true,"type":"string"}},"required":["id","created_at","last_modified"],"type":"object"}]}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get an entry in impersonation registry","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]},"patch":{"operationId":"email_security_update_display_name","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"display_name_id","required":true,"schema":{"example":2403,"format":"int32","title":"identifier","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"email":{"nullable":true,"type":"string","x-auditable":true},"is_email_regex":{"nullable":true,"type":"boolean","x-auditable":true},"name":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"allOf":[{"properties":{"email":{"type":"string","x-auditable":true},"is_email_regex":{"type":"boolean","x-auditable":true},"name":{"maxLength":1024,"type":"string","x-auditable":true}},"required":["name","email","is_email_regex"],"type":"object"},{"properties":{"comments":{"nullable":true,"type":"string"},"created_at":{"format":"date-time","type":"string"},"directory_id":{"allOf":[{"format":"int64","type":"integer"},{"nullable":true,"type":"integer"}]},"directory_node_id":{"allOf":[{"format":"int64","type":"integer"},{"nullable":true,"type":"integer"}]},"external_directory_node_id":{"deprecated":true,"nullable":true,"type":"string"},"id":{"example":2403,"format":"int32","title":"identifier","type":"integer"},"last_modified":{"format":"date-time","type":"string"},"provenance":{"nullable":true,"type":"string"}},"required":["id","created_at","last_modified"],"type":"object"}]}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update an entry in impersonation registry","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/settings/sending_domain_restrictions/batch":{"post":{"description":"Send a Batch of `sending_domain_restrictions` API calls to be executed together.","operationId":"email_security_batch_sending_domain_restrictions","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"deletes":{"items":{"properties":{"id":{"format":"int32","title":"identifier","type":"integer"}},"required":["id"],"type":"object"},"type":"array"}},"required":["deletes"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"properties":{"deletes":{"items":{"properties":{"id":{"format":"int32","title":"identifier","type":"integer"}},"required":["id"],"type":"object"},"type":"array"}},"required":["deletes"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Batch Sending Domain Restrictions","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/settings/trusted_domains":{"get":{"description":"Lists, searches, and sorts an account’s trusted email domains.","operationId":"email_security_list_trusted_domains","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"description":"The page number of paginated results.","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"}},{"description":"The number of results per page.","in":"query","name":"per_page","schema":{"default":20,"format":"int32","minimum":1,"type":"integer"}},{"description":"The field to sort by.","in":"query","name":"order","schema":{"enum":["pattern","created_at"],"type":"string"}},{"description":"The sorting direction.","in":"query","name":"direction","schema":{"allOf":[{"$ref":"#/components/schemas/email-security_SortingDirection"}]}},{"description":"Allows searching in multiple properties of a record simultaneously.\nThis parameter is intended for human users, not automation. Its exact\nbehavior is intentionally left unspecified and is subject to change\nin the future.","in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"is_recent","schema":{"type":"boolean"}},{"in":"query","name":"is_similarity","schema":{"type":"boolean"}},{"in":"query","name":"pattern","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/email-security_TrustedDomain"},"type":"array"},"result_info":{"$ref":"#/components/schemas/email-security_ResultInfo"}},"required":["result","result_info"],"type":"object"}]}}},"description":"Contains the list of trusted domains for the account."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List trusted email domains","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]},"post":{"operationId":"email_security_create_trusted_domain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/email-security_CreateTrustedDomain"},{"items":{"$ref":"#/components/schemas/email-security_CreateTrustedDomain"},"type":"array"}]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"oneOf":[{"$ref":"#/components/schemas/email-security_TrustedDomain"},{"items":{"$ref":"#/components/schemas/email-security_TrustedDomain"},"type":"array"}]}},"required":["result"],"type":"object"}]}}},"description":"Contains the new trusted domain in the shape of the request body."},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a trusted email domain","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/settings/trusted_domains/batch":{"post":{"description":"Send a Batch of Trusted Domains API calls to be executed together.","operationId":"email_security_batch_trusted_domains","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"deletes":{"items":{"properties":{"id":{"description":"The unique identifier for the trusted domain.","example":2401,"format":"int32","title":"identifier","type":"integer"}},"required":["id"],"type":"object"},"type":"array"},"patches":{"items":{"allOf":[{"$ref":"#/components/schemas/email-security_UpdateTrustedDomain"},{"properties":{"id":{"$ref":"#/components/schemas/email-security_TrustedDomainId"}},"required":["id"],"type":"object"}]},"type":"array"},"posts":{"items":{"$ref":"#/components/schemas/email-security_CreateTrustedDomain"},"type":"array"},"puts":{"items":{"allOf":[{"$ref":"#/components/schemas/email-security_CreateTrustedDomain"},{"properties":{"id":{"$ref":"#/components/schemas/email-security_TrustedDomainId"}},"required":["id"],"type":"object"}]},"type":"array"}},"required":["deletes","patches","puts","posts"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"properties":{"deletes":{"items":{"properties":{"id":{"description":"The unique identifier for the trusted domain.","example":2401,"format":"int32","title":"identifier","type":"integer"}},"required":["id"],"type":"object"},"type":"array"},"patches":{"items":{"$ref":"#/components/schemas/email-security_TrustedDomain"},"type":"array"},"posts":{"items":{"$ref":"#/components/schemas/email-security_TrustedDomain"},"type":"array"},"puts":{"items":{"$ref":"#/components/schemas/email-security_TrustedDomain"},"type":"array"}},"required":["deletes","patches","puts","posts"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Batch Trusted Domains","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}":{"delete":{"operationId":"email_security_delete_trusted_domain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"trusted_domain_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_TrustedDomainId"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"properties":{"id":{"description":"The unique identifier for the trusted domain.","example":2401,"format":"int32","title":"identifier","type":"integer"}},"required":["id"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a trusted email domain","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]},"get":{"operationId":"email_security_get_trusted_domain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"trusted_domain_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_TrustedDomainId"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"allOf":[{"additionalProperties":false,"example":{"comments":null,"is_recent":true,"is_regex":false,"is_similarity":false,"pattern":"example.com"},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_recent":{"description":"Select to prevent recently registered domains from triggering a\nSuspicious or Malicious disposition.","type":"boolean","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"is_similarity":{"description":"Select for partner or other approved domains that have similar\nspelling to your connected domains. Prevents listed domains from\ntriggering a Spoof disposition.","type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true}},"required":["is_recent","is_similarity","is_regex","pattern"],"type":"object"},{"properties":{"created_at":{"format":"date-time","type":"string","x-auditable":true},"id":{"description":"The unique identifier for the trusted domain.","example":2401,"format":"int32","title":"identifier","type":"integer"},"last_modified":{"format":"date-time","type":"string","x-auditable":true}},"required":["id","created_at","last_modified"],"type":"object"}],"example":{"comments":null,"created_at":"2023-11-14T22:13:20Z","id":2401,"is_recent":true,"is_regex":false,"is_similarity":false,"last_modified":"2023-11-14T22:13:20Z","pattern":"example.com"}}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a trusted email domain","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write","Cloud Email Security: Read"]},"patch":{"operationId":"email_security_update_trusted_domain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"in":"path","name":"trusted_domain_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_TrustedDomainId"}}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"comments":{"maxLength":1024,"type":"string","x-auditable":true},"is_recent":{"description":"Select to prevent recently registered domains from triggering a\nSuspicious or Malicious disposition.","type":"boolean","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"is_similarity":{"description":"Select for partner or other approved domains that have similar\nspelling to your connected domains. Prevents listed domains from\ntriggering a Spoof disposition.","type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"allOf":[{"additionalProperties":false,"example":{"comments":null,"is_recent":true,"is_regex":false,"is_similarity":false,"pattern":"example.com"},"properties":{"comments":{"maxLength":1024,"nullable":true,"type":"string","x-auditable":true},"is_recent":{"description":"Select to prevent recently registered domains from triggering a\nSuspicious or Malicious disposition.","type":"boolean","x-auditable":true},"is_regex":{"type":"boolean","x-auditable":true},"is_similarity":{"description":"Select for partner or other approved domains that have similar\nspelling to your connected domains. Prevents listed domains from\ntriggering a Spoof disposition.","type":"boolean","x-auditable":true},"pattern":{"maxLength":1024,"minLength":1,"type":"string","x-auditable":true}},"required":["is_recent","is_similarity","is_regex","pattern"],"type":"object"},{"properties":{"created_at":{"format":"date-time","type":"string","x-auditable":true},"id":{"description":"The unique identifier for the trusted domain.","example":2401,"format":"int32","title":"identifier","type":"integer"},"last_modified":{"format":"date-time","type":"string","x-auditable":true}},"required":["id","created_at","last_modified"],"type":"object"}],"example":{"comments":null,"created_at":"2023-11-14T22:13:20Z","id":2401,"is_recent":true,"is_regex":false,"is_similarity":false,"last_modified":"2023-11-14T22:13:20Z","pattern":"example.com"}}},"required":["result"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update a trusted email domain","tags":["Email Security Settings"],"x-api-token-group":["Cloud Email Security: Write"]}},"/accounts/{account_id}/email-security/submissions":{"get":{"description":"This endpoint returns information for submissions to made to reclassify emails.","operationId":"email_security_submissions","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email-security_AccountId"}},{"description":"The beginning of the search date range.\nDefaults to `now - 30 days`.","example":"2022-06-25T14:30:00Z","in":"query","name":"start","schema":{"format":"date-time","type":"string"}},{"description":"The end of the search date range.\nDefaults to `now`.","example":"2022-07-25T14:30:00Z","in":"query","name":"end","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"type","schema":{"allOf":[{"enum":["TEAM","USER"],"type":"string"}]}},{"in":"query","name":"submission_id","schema":{"type":"string"}},{"in":"query","name":"original_disposition","schema":{"allOf":[{"enum":["MALICIOUS","SUSPICIOUS","SPOOF","SPAM","BULK","NONE"],"type":"string"}]}},{"in":"query","name":"requested_disposition","schema":{"allOf":[{"enum":["MALICIOUS","SUSPICIOUS","SPOOF","SPAM","BULK","NONE"],"type":"string"}]}},{"in":"query","name":"outcome_disposition","schema":{"allOf":[{"enum":["MALICIOUS","SUSPICIOUS","SPOOF","SPAM","BULK","NONE"],"type":"string"}]}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"query","schema":{"nullable":true,"type":"string"}},{"description":"The page number of paginated results.","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"}},{"description":"The number of results per page.","in":"query","name":"per_page","schema":{"default":20,"format":"int32","minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/email-security_ApiResponseCommon"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/email-security_Submission"},"type":"array"},"result_info":{"$ref":"#/components/schemas/email-security_ResultInfo"}},"required":["result","result_info"],"type":"object"}]}}},"description":""},"4XX":{"$ref":"#/components/responses/email-security_ClientError"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get reclassify submissions","tags":["Email Security"],"x-api-token-group":null}},"/accounts/{account_id}/email/routing/addresses":{"get":{"description":"Lists existing destination addresses.","operationId":"email-routing-destination-addresses-list-destination-addresses","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"direction","schema":{"default":"asc","description":"Sorts results in an ascending or descending order.","enum":["asc","desc"],"example":"asc","type":"string"}},{"in":"query","name":"verified","schema":{"default":true,"description":"Filter by verified destination addresses.","enum":[true,false],"example":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_destination_addresses_response_collection"}}},"description":"List destination addresses response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List destination addresses","tags":["Email Routing destination addresses"],"x-api-token-group":["Email Routing Addresses Write","Email Routing Addresses Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.email.routing.address.list"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a destination address to forward your emails to. Destination addresses need to be verified before they can be used.","operationId":"email-routing-destination-addresses-create-a-destination-address","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_create_destination_address_properties"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_destination_address_response_single"}}},"description":"Create a destination address response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a destination address","tags":["Email Routing destination addresses"],"x-api-token-group":["Email Routing Addresses Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.email.routing.address.create"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/email/routing/addresses/{destination_address_identifier}":{"delete":{"description":"Deletes a specific destination address.","operationId":"email-routing-destination-addresses-delete-destination-address","parameters":[{"in":"path","name":"destination_address_identifier","required":true,"schema":{"$ref":"#/components/schemas/email_destination_address_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_destination_address_response_single"}}},"description":"Delete destination address response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete destination address","tags":["Email Routing destination addresses"],"x-api-token-group":["Email Routing Addresses Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.email.routing.address.delete"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Gets information for a specific destination email already created.","operationId":"email-routing-destination-addresses-get-a-destination-address","parameters":[{"in":"path","name":"destination_address_identifier","required":true,"schema":{"$ref":"#/components/schemas/email_destination_address_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_destination_address_response_single"}}},"description":"Get a destination address response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a destination address","tags":["Email Routing destination addresses"],"x-api-token-group":["Email Routing Addresses Write","Email Routing Addresses Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.email.routing.address.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration":{"get":{"description":"List all event notification rules for a bucket.","operationId":"r2-get-event-notification-configs","parameters":[{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_bucket-config"}},"type":"object"}]}}},"description":"Read Configuration response."},"404":{"content":{"application/json":{"example":{"errors":[{"code":11015,"message":"workers.api.error.no_configs_found_for_bucket"}],"messages":[],"result":null,"success":false},"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"No Configuration Found response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Read Configuration failure."}},"security":[{"api_token":[]}],"summary":"List Event Notification Rules","tags":["R2 Bucket"],"x-api-token-group":["Workers R2 Storage Write","Workers R2 Storage Read"]}},"/accounts/{account_id}/event_notifications/r2/{bucket_name}/configuration/queues/{queue_id}":{"delete":{"description":"Delete an event notification rule. **If no body is provided, all rules for specified queue will be deleted**.","operationId":"r2-event-notification-delete-config","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/r2_queue_identifier"}},{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ruleIds":{"description":"Array of rule ids to delete.","items":{"description":"rule ids to be deleted.","type":"string"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"type":"object"}]}}},"description":"Delete Configuration response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Delete Configuration failure."}},"security":[{"api_token":[]}],"summary":"Delete Event Notification Rules","tags":["R2 Bucket"],"x-api-token-group":["Workers R2 Storage Write"]},"get":{"description":"Get a single event notification rule.","operationId":"r2-get-event-notification-config","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/r2_queue_identifier"}},{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"default":"default","description":"The bucket jurisdiction.","enum":["default","eu","fedramp"],"type":"string","x-stainless-param":"jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_queues-config"}},"type":"object"}]}}},"description":"Read Configuration response."},"404":{"content":{"application/json":{"example":{"errors":[{"code":11015,"message":"workers.api.error.no_configs_found_for_bucket"}],"messages":[],"result":null,"success":false},"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"No Configuration Found response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Read Configuration failure."}},"security":[{"api_token":[]}],"summary":"Get Event Notification Rule","tags":["R2 Bucket"],"x-api-token-group":["Workers R2 Storage Write","Workers R2 Storage Read"]},"put":{"description":"Create event notification rule.","operationId":"r2-put-event-notification-config","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/r2_queue_identifier"}},{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"rules":{"description":"Array of rules to drive notifications.","items":{"$ref":"#/components/schemas/r2_rule"},"minItems":1,"type":"array"}},"required":["rules"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"type":"object"}]}}},"description":"Create Configuration response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Create Configuration failure."}},"security":[{"api_token":[]}],"summary":"Create Event Notification Rule","tags":["R2 Bucket"],"x-api-token-group":["Workers R2 Storage Write"]}},"/accounts/{account_id}/event_subscriptions/subscriptions":{"get":{"description":"Get a paginated list of event subscriptions with optional sorting and filtering","operationId":"subscriptions-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"description":"Page number for pagination","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"Number of items per page","in":"query","name":"per_page","schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Field to sort by","in":"query","name":"order","schema":{"default":"name","enum":["created_at","name","enabled","source"],"type":"string"}},{"description":"Sort direction","in":"query","name":"direction","schema":{"default":"asc","enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mq_event-subscription"},"type":"array"},"result_info":{"properties":{"count":{"description":"Number of items in current page","type":"integer"},"page":{"description":"Current page number","type":"integer"},"per_page":{"description":"Items per page","type":"integer"},"total_count":{"description":"Total number of items","type":"integer"},"total_pages":{"description":"Total number of pages","type":"integer"}},"required":["count","total_count","page","per_page","total_pages"],"type":"object"}},"type":"object"}],"type":"object"}}},"description":"List of event subscriptions"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Event Subscriptions","tags":["Queue"],"x-api-token-group":["Queues Write","Queues Read","Workers Scripts Write","Workers Scripts Read"]},"post":{"description":"Create a new event subscription for a queue","operationId":"subscriptions-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination":{"$ref":"#/components/schemas/mq_event-destination"},"enabled":{"description":"Whether the subscription is active","type":"boolean","x-auditable":true},"events":{"description":"List of event types this subscription handles","items":{"type":"string"},"minItems":1,"type":"array","x-auditable":true},"name":{"description":"Name of the subscription","type":"string","x-auditable":true},"source":{"$ref":"#/components/schemas/mq_event-source"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"$ref":"#/components/schemas/mq_event-subscription"}},"type":"object"}],"type":"object"}}},"description":"Successfully created event subscription"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Invalid request body or validation errors"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Queue does not exist or resource not found on source"},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Multiple subscriptions on same resource not supported"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Event Subscription","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"]}},"/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}":{"delete":{"description":"Delete an existing event subscription","operationId":"subscriptions-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"$ref":"#/components/schemas/mq_event-subscription"}},"type":"object"}],"type":"object"}}},"description":"Successfully created event subscription"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Event Subscription","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"]},"get":{"description":"Get details about an existing event subscription","operationId":"subscriptions-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"$ref":"#/components/schemas/mq_event-subscription"}},"type":"object"}],"type":"object"}}},"description":"Details about an event subscription"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Event subscription does not exist"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Event Subscription","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"]},"patch":{"description":"Update an existing event subscription","operationId":"subscriptions-patch","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"subscription_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination":{"$ref":"#/components/schemas/mq_event-destination"},"enabled":{"description":"Whether the subscription is active","type":"boolean","x-auditable":true},"events":{"description":"List of event types this subscription handles","items":{"type":"string"},"minItems":1,"type":"array","x-auditable":true},"name":{"description":"Name of the subscription","type":"string","x-auditable":true}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"$ref":"#/components/schemas/mq_event-subscription"}},"type":"object"}],"type":"object"}}},"description":"Successfully created event subscription"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Invalid request body or validation errors"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Queue does not exist or resource not found on source"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Event Subscription","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"]}},"/accounts/{account_id}/firewall/access_rules/rules":{"get":{"description":"Fetches IP Access rules of an account. These rules apply to all the zones in the account. You can filter the results using several optional parameters.","operationId":"ip-access-rules-for-an-account-list-ip-access-rules","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_account_identifier"}},{"in":"query","name":"mode","schema":{"$ref":"#/components/schemas/firewall_schemas-mode"}},{"in":"query","name":"configuration.target","schema":{"description":"Defines the target to search in existing rules.","enum":["ip","ip_range","asn","country"],"example":"ip","type":"string"}},{"in":"query","name":"configuration.value","schema":{"description":"Defines the target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.\nNotes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.","example":"198.51.100.4","type":"string"}},{"in":"query","name":"notes","schema":{"description":"Defines the string to search for in the notes of existing IP Access rules.\nNotes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.","example":"my note","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"Defines the search requirements. When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.","enum":["any","all"],"type":"string"}},{"in":"query","name":"page","schema":{"description":"Defines the requested page within paginated list of results.","example":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"description":"Defines the maximum number of results requested.","example":20,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Defines the field used to sort returned rules.","enum":["configuration.target","configuration.value","mode"],"example":"mode","type":"string"}},{"in":"query","name":"direction","schema":{"description":"Defines the direction used to sort returned rules.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_response_collection"}}},"description":"List IP Access rules response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_response_collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"List IP Access rules response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List IP Access rules","tags":["IP Access rules for an account"],"x-api-token-group":["Account Firewall Access Rules Write","Account Firewall Access Rules Read"],"x-cfPermissionsRequired":{"enum":["#waf:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a new IP Access rule for an account. The rule will apply to all zones in the account.\n\nNote: To create an IP Access rule that applies to a single zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.","operationId":"ip-access-rules-for-an-account-create-an-ip-access-rule","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"configuration":{"$ref":"#/components/schemas/firewall_configuration"},"mode":{"$ref":"#/components/schemas/firewall_schemas-mode"},"notes":{"allOf":[{"$ref":"#/components/schemas/firewall_notes"},{"default":""}]}},"required":["mode","configuration"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_response_single"}}},"description":"Create an IP Access rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Create an IP Access rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create an IP Access rule","tags":["IP Access rules for an account"],"x-api-token-group":["Account Firewall Access Rules Write"],"x-cfPermissionsRequired":{"enum":["#waf:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/firewall/access_rules/rules/{rule_id}":{"delete":{"description":"Deletes an existing IP Access rule defined at the account level.\n\nNote: This operation will affect all zones in the account.","operationId":"ip-access-rules-for-an-account-delete-an-ip-access-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_rule_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_api-response-single-id"}}},"description":"Delete an IP Access rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_api-response-single-id"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Delete an IP Access rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an IP Access rule","tags":["IP Access rules for an account"],"x-api-token-group":["Account Firewall Access Rules Write"],"x-cfPermissionsRequired":{"enum":["#waf:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the details of an IP Access rule defined at the account level.","operationId":"ip-access-rules-for-an-account-get-an-ip-access-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_rule_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_response_single"}}},"description":"Get an IP Access rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Get an IP Access rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get an IP Access rule","tags":["IP Access rules for an account"],"x-api-token-group":["Account Firewall Access Rules Write","Account Firewall Access Rules Read"],"x-cfPermissionsRequired":{"enum":["#waf:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates an IP Access rule defined at the account level.\n\nNote: This operation will affect all zones in the account.","operationId":"ip-access-rules-for-an-account-update-an-ip-access-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_rule_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_schemas-rule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_response_single"}}},"description":"Update an IP Access rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update an IP Access rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an IP Access rule","tags":["IP Access rules for an account"],"x-api-token-group":["Account Firewall Access Rules Write"],"x-cfPermissionsRequired":{"enum":["#waf:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/gateway":{"get":{"description":"Retrieve information about the current Zero Trust account.","operationId":"zero-trust-accounts-get-zero-trust-account-information","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_gateway_account"}}},"description":"Zero Trust account information response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"type":"object"},{"$ref":"#/components/schemas/zero-trust-gateway_gateway_account"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}]}}},"description":"Zero Trust account information response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Zero Trust account information","tags":["Zero Trust accounts"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"post":{"description":"Create a Zero Trust account for an existing Cloudflare account.","operationId":"zero-trust-accounts-create-zero-trust-account","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_gateway_account"}}},"description":"Create Zero Trust account response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"type":"object"},{"$ref":"#/components/schemas/zero-trust-gateway_gateway_account"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}]}}},"description":"Create Zero Trust account response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Zero Trust account","tags":["Zero Trust accounts"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/gateway/app_types":{"get":{"description":"List all application and application type mappings.","operationId":"zero-trust-gateway-application-and-application-type-mappings-list-application-and-application-type-mappings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_app-types_components-schemas-response_collection"}}},"description":"List application and application type mappings response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_app-types_components-schemas-response_collection"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}]}}},"description":"List application and application type mappings response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List application and application type mappings","tags":["Zero Trust Gateway application and application type mappings"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]}},"/accounts/{account_id}/gateway/apps/review_status":{"get":{"description":"Retrieve the statuses of your applications.","operationId":"zero-trust-applications-review-status-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_applications_review_status_response"}}},"description":"List applications review status response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_applications_review_status_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"List applications review status failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List applications review statuses","tags":["Zero Trust applications review status"]},"put":{"description":"Update the statuses of your applications.","operationId":"zero-trust-applications-review-status-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"approved_apps":{"$ref":"#/components/schemas/zero-trust-gateway_approved_apps"},"in_review_apps":{"$ref":"#/components/schemas/zero-trust-gateway_in_review_apps"},"unapproved_apps":{"$ref":"#/components/schemas/zero-trust-gateway_unapproved_apps"}},"required":["approved_apps","unapproved_apps","in_review_apps"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_applications_review_status_response"}}},"description":"Update applications review status response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_applications_review_status_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Update applications review status failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update applications review statuses","tags":["Zero Trust applications review status"]}},"/accounts/{account_id}/gateway/audit_ssh_settings":{"get":{"description":"Retrieve all Zero Trust Audit SSH and SSH with Access for Infrastructure settings for an account.","operationId":"zero-trust-get-audit-ssh-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response"}}},"description":"Get Zero Trust SSH settings response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Get Zero Trust SSH settings response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Zero Trust SSH settings","tags":["Zero Trust SSH Settings"]},"put":{"description":"Update Zero Trust Audit SSH and SSH with Access for Infrastructure settings for an account.","operationId":"zero-trust-update-audit-ssh-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"public_key":{"$ref":"#/components/schemas/zero-trust-gateway_public_key"}},"required":["public_key"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response"}}},"description":"Update Zero Trust SSH settings response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Update Zero Trust SSH settings response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Zero Trust SSH settings","tags":["Zero Trust SSH Settings"]}},"/accounts/{account_id}/gateway/audit_ssh_settings/rotate_seed":{"post":{"description":"Rotate the SSH account seed that generates the host key identity when connecting through the Cloudflare SSH Proxy.","operationId":"zero-trust-rotate-ssh-account-seed","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response"}}},"description":"Rotate Zero Trust SSH account seed response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_audit_ssh_settings_components-schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Rotate Zero Trust SSH account seed response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Rotate Zero Trust SSH account seed","tags":["Zero Trust SSH Settings"]}},"/accounts/{account_id}/gateway/categories":{"get":{"description":"List all categories.","operationId":"zero-trust-gateway-categories-list-categories","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_categories_components-schemas-response_collection"}}},"description":"List categories response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_categories_components-schemas-response_collection"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"List categories response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List categories","tags":["Zero Trust Gateway categories"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]}},"/accounts/{account_id}/gateway/certificates":{"get":{"description":"List all Zero Trust certificates for an account.","operationId":"zero-trust-certificates-list-zero-trust-certificates","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_response_collection"}}},"description":"Lists Zero Trust certificates response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_response_collection"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Lists Zero Trust certificates response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Zero Trust certificates","tags":["Zero Trust certificates"]},"post":{"description":"Create a new Zero Trust certificate.","operationId":"zero-trust-certificates-create-zero-trust-certificate","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_generate-cert-request"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_single_response"}}},"description":"Creates Zero Trust certificate response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Creates Zero Trust certificate response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Zero Trust certificate","tags":["Zero Trust certificates"]}},"/accounts/{account_id}/gateway/certificates/{certificate_id}":{"delete":{"description":"Delete a gateway-managed Zero Trust certificate. You must deactivate the certificate from the edge (inactive) before deleting it.","operationId":"zero-trust-certificates-delete-zero-trust-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_single_response"}}},"description":"Deletes Zero Trust certificate response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}]}}},"description":"Deletes Zero Trust certificate response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Zero Trust certificate","tags":["Zero Trust certificates"]},"get":{"description":"Get a single Zero Trust certificate.","operationId":"zero-trust-certificates-zero-trust-certificate-details","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_single_response"}}},"description":"Gets Zero Trust certificate details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Gets Zero Trust certificate details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Zero Trust certificate details","tags":["Zero Trust certificates"]}},"/accounts/{account_id}/gateway/certificates/{certificate_id}/activate":{"post":{"description":"Bind a single Zero Trust certificate to the edge.","operationId":"zero-trust-certificates-activate-zero-trust-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_single_response"}}},"description":"Activates Zero Trust certificate details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}]}}},"description":"Activates Zero Trust certificate details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Activate a Zero Trust certificate","tags":["Zero Trust certificates"]}},"/accounts/{account_id}/gateway/certificates/{certificate_id}/deactivate":{"post":{"description":"Unbind a single Zero Trust certificate from the edge.","operationId":"zero-trust-certificates-deactivate-zero-trust-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_single_response"}}},"description":"Deactivate Zero Trust certificate details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Deactivate Zero Trust certificate details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Deactivate a Zero Trust certificate","tags":["Zero Trust certificates"]}},"/accounts/{account_id}/gateway/configuration":{"get":{"description":"Retrieve the current Zero Trust account configuration.","operationId":"zero-trust-accounts-get-zero-trust-account-configuration","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_gateway_account_config"}}},"description":"Zero Trust account configuration response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_gateway_account_config"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}]}}},"description":"Zero Trust account configuration response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Zero Trust account configuration","tags":["Zero Trust accounts"]},"patch":{"description":"Update (PATCH) a single subcollection of settings such as `antivirus`, `tls_decrypt`, `activity_log`, `block_page`, `browser_isolation`, `fips`, `body_scanning`, or `certificate` without updating the entire configuration object. This endpoint returns an error if any settings collection lacks proper configuration.","operationId":"zero-trust-accounts-patch-zero-trust-account-configuration","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_gateway-account-settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_gateway_account_config"}}},"description":"Zero Trust account configuration response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_gateway_account_config"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}]}}},"description":"Zero Trust account configuration response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Zero Trust account configuration","tags":["Zero Trust accounts"]},"put":{"description":"Update the current Zero Trust account configuration.","operationId":"zero-trust-accounts-update-zero-trust-account-configuration.","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_gateway-account-settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_gateway_account_config"}}},"description":"Zero Trust account configuration response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_gateway_account_config"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}]}}},"description":"Zero Trust account configuration response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Zero Trust account configuration","tags":["Zero Trust accounts"]}},"/accounts/{account_id}/gateway/configuration/custom_certificate":{"get":{"deprecated":true,"description":"Retrieve the current Zero Trust certificate configuration.","operationId":"zero-trust-accounts-get-zero-trust-certificate-configuration","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_custom-certificate-settings"}}},"description":"Zero Trust account configuration response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_custom-certificate-settings"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}]}}},"description":"Zero Trust account configuration response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Zero Trust certificate configuration","tags":["Zero Trust accounts"]}},"/accounts/{account_id}/gateway/lists":{"get":{"description":"Fetch all Zero Trust lists for an account.","operationId":"zero-trust-lists-list-zero-trust-lists","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}},{"in":"query","name":"type","schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-type"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-response_collection"}}},"description":"List Zero Trust lists response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_schemas-response_collection"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"List Zero Trust lists response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Zero Trust lists","tags":["Zero Trust lists"]},"post":{"description":"Creates a new Zero Trust list.","operationId":"zero-trust-lists-create-zero-trust-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/zero-trust-gateway_description"},"items":{"$ref":"#/components/schemas/zero-trust-gateway_items-input"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_name"},"type":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-type"}},"required":["name","type"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_single_response_with_list_items"}}},"description":"Create Zero Trust list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_single_response_with_list_items"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Create Zero Trust list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Zero Trust list","tags":["Zero Trust lists"]}},"/accounts/{account_id}/gateway/lists/{list_id}":{"delete":{"description":"Deletes a Zero Trust list.","operationId":"zero-trust-lists-delete-zero-trust-list","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_empty_response"}}},"description":"Delete Zero Trust list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_empty_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Delete Zero Trust list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Zero Trust list","tags":["Zero Trust lists"]},"get":{"description":"Fetch a single Zero Trust list.","operationId":"zero-trust-lists-zero-trust-list-details","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_list_single_response"}}},"description":"Get Zero Trust list details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_list_single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Get Zero Trust list details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Zero Trust list details","tags":["Zero Trust lists"]},"patch":{"description":"Appends or removes an item from a configured Zero Trust list.","operationId":"zero-trust-lists-patch-zero-trust-list","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"append":{"$ref":"#/components/schemas/zero-trust-gateway_items-input"},"remove":{"description":"Lists of item values you want to remove.","items":{"$ref":"#/components/schemas/zero-trust-gateway_value"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_list_single_response"}}},"description":"Patch Zero Trust list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_list_single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Patch Zero Trust list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Zero Trust list.","tags":["Zero Trust lists"]},"put":{"description":"Updates a configured Zero Trust list. Skips updating list items if not included in the payload. A non empty list items will overwrite the existing list.","operationId":"zero-trust-lists-update-zero-trust-list","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/zero-trust-gateway_description"},"items":{"$ref":"#/components/schemas/zero-trust-gateway_items-input"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_name"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_list_single_response"}}},"description":"Update Zero Trust list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_list_single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Update Zero Trust list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Zero Trust list","tags":["Zero Trust lists"]}},"/accounts/{account_id}/gateway/lists/{list_id}/items":{"get":{"description":"Fetch all items in a single Zero Trust list.","operationId":"zero-trust-lists-zero-trust-list-items","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_list_item_response_collection"}}},"description":"Get Zero Trust list items response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_list_item_response_collection"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Get Zero Trust list items response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Zero Trust list items","tags":["Zero Trust lists"]}},"/accounts/{account_id}/gateway/locations":{"get":{"description":"List Zero Trust Gateway locations for an account.","operationId":"zero-trust-gateway-locations-list-zero-trust-gateway-locations","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-response_collection"}}},"description":"Lists Zero Trust Gateway locations response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-response_collection"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Lists Zero Trust Gateway locations response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Zero Trust Gateway locations","tags":["Zero Trust Gateway locations"],"x-api-token-group":["Cloudflare Zero Trust Secure DNS Locations Write","Zero Trust Read","Zero Trust Write"]},"post":{"description":"Create a new Zero Trust Gateway location.","operationId":"zero-trust-gateway-locations-create-zero-trust-gateway-location","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"client_default":{"$ref":"#/components/schemas/zero-trust-gateway_client-default"},"dns_destination_ips_id":{"$ref":"#/components/schemas/zero-trust-gateway_dns-destination-ips-id-write"},"ecs_support":{"$ref":"#/components/schemas/zero-trust-gateway_ecs-support"},"endpoints":{"$ref":"#/components/schemas/zero-trust-gateway_endpoints"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-name"},"networks":{"$ref":"#/components/schemas/zero-trust-gateway_ipv4_networks"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-single_response"}}},"description":"Creates a Zero Trust Gateway location response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Creates a Zero Trust Gateway location response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a Zero Trust Gateway location","tags":["Zero Trust Gateway locations"],"x-api-token-group":["Cloudflare Zero Trust Secure DNS Locations Write","Zero Trust Write"]}},"/accounts/{account_id}/gateway/locations/{location_id}":{"delete":{"description":"Delete a configured Zero Trust Gateway location.","operationId":"zero-trust-gateway-locations-delete-zero-trust-gateway-location","parameters":[{"in":"path","name":"location_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_empty_response"}}},"description":"Deletes a Zero Trust Gateway location response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_empty_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Deletes a Zero Trust Gateway location response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a Zero Trust Gateway location","tags":["Zero Trust Gateway locations"],"x-api-token-group":["Cloudflare Zero Trust Secure DNS Locations Write","Zero Trust Write"]},"get":{"description":"Get a single Zero Trust Gateway location.","operationId":"zero-trust-gateway-locations-zero-trust-gateway-location-details","parameters":[{"in":"path","name":"location_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-single_response"}}},"description":"Gets Zero Trust Gateway location details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Gets Zero Trust Gateway location details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Zero Trust Gateway location details","tags":["Zero Trust Gateway locations"],"x-api-token-group":["Cloudflare Zero Trust Secure DNS Locations Write","Zero Trust Read","Zero Trust Write"]},"put":{"description":"Update a configured Zero Trust Gateway location.","operationId":"zero-trust-gateway-locations-update-zero-trust-gateway-location","parameters":[{"in":"path","name":"location_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"client_default":{"$ref":"#/components/schemas/zero-trust-gateway_client-default"},"dns_destination_ips_id":{"$ref":"#/components/schemas/zero-trust-gateway_dns-destination-ips-id-write"},"ecs_support":{"$ref":"#/components/schemas/zero-trust-gateway_ecs-support"},"endpoints":{"$ref":"#/components/schemas/zero-trust-gateway_endpoints"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-name"},"networks":{"$ref":"#/components/schemas/zero-trust-gateway_ipv4_networks"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-single_response"}}},"description":"Updates a Zero Trust Gateway location response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Updates a Zero Trust Gateway location response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a Zero Trust Gateway location","tags":["Zero Trust Gateway locations"],"x-api-token-group":["Cloudflare Zero Trust Secure DNS Locations Write","Zero Trust Write"]}},"/accounts/{account_id}/gateway/logging":{"get":{"description":"Retrieve the current logging settings for the Zero Trust account.","operationId":"zero-trust-accounts-get-logging-settings-for-the-zero-trust-account","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response"}}},"description":"Logging settings retrieval response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}]}}},"description":"Logging settings retrieval response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get logging settings for the Zero Trust account","tags":["Zero Trust accounts"]},"put":{"description":"Update logging settings for the current Zero Trust account.","operationId":"zero-trust-accounts-update-logging-settings-for-the-zero-trust-account","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_gateway-account-logging-settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response"}}},"description":"Logging settings update response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_gateway-account-logging-settings-response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}]}}},"description":"Logging settings update response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Zero Trust account logging settings","tags":["Zero Trust accounts"]}},"/accounts/{account_id}/gateway/pacfiles":{"get":{"description":"List all Zero Trust Gateway PAC files for an account.","operationId":"zero-trust-gateway-pacfiles-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_pacfiles_components-schemas-response_collection"}}},"description":"Returns a list of PAC files response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_pacfiles_components-schemas-response_collection"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Returns a list of PAC files response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List PAC files","tags":["Zero Trust Gateway PAC files"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"post":{"description":"Create a new Zero Trust Gateway PAC file.","operationId":"zero-trust-gateway-pacfiles-create-pacfile","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"contents":{"$ref":"#/components/schemas/zero-trust-gateway_contents"},"description":{"$ref":"#/components/schemas/zero-trust-gateway_pacfiles_components-schemas-description"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_pacfiles_components-schemas-name"},"slug":{"description":"URL-friendly version of the PAC file name. If not provided, it will be auto-generated","example":"pac_devops","type":"string","x-auditable":true}},"required":["name","contents"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_pacfiles_components-schemas-single_response"}}},"description":"Returns a created PAC file response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_pacfiles_components-schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Returns a created PAC file response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a PAC file","tags":["Zero Trust Gateway PAC files"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/gateway/proxy_endpoints":{"get":{"description":"List all Zero Trust Gateway proxy endpoints for an account.","operationId":"zero-trust-gateway-proxy-endpoints-list-proxy-endpoints","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-response_collection"}}},"description":"Returns a list of proxy endpoints response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-response_collection"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Returns a list of proxy endpoints response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List proxy endpoints","tags":["Zero Trust Gateway proxy endpoints"]},"post":{"description":"Create a new Zero Trust Gateway proxy endpoint.","operationId":"zero-trust-gateway-proxy-endpoints-create-proxy-endpoint","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"discriminator":{"mapping":{"identity":"#/components/schemas/zero-trust-gateway_proxy-endpoint-identity-create","ip":"#/components/schemas/zero-trust-gateway_proxy-endpoint-ip-create"},"propertyName":"kind"},"oneOf":[{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoint-ip-create"},{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoint-identity-create"}],"properties":{"kind":{"default":"ip","description":"The proxy endpoint kind.","enum":["ip","identity"],"type":"string"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response"}}},"description":"Returns a created proxy endpoint response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Returns a created proxy endpoint response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a proxy endpoint","tags":["Zero Trust Gateway proxy endpoints"]}},"/accounts/{account_id}/gateway/proxy_endpoints/{proxy_endpoint_id}":{"delete":{"description":"Delete a configured Zero Trust Gateway proxy endpoint.","operationId":"zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint","parameters":[{"in":"path","name":"proxy_endpoint_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_empty_response"}}},"description":"Returns a deleted proxy endpoint response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"type":"object"},{"$ref":"#/components/schemas/zero-trust-gateway_empty_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Returns a deleted proxy endpoint response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a proxy endpoint","tags":["Zero Trust Gateway proxy endpoints"]},"get":{"description":"Get a single Zero Trust Gateway proxy endpoint.","operationId":"zero-trust-gateway-proxy-endpoints-proxy-endpoint-details","parameters":[{"in":"path","name":"proxy_endpoint_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response"}}},"description":"Returns a proxy endpoint response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"type":"object"},{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Returns a proxy endpoint response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a proxy endpoint","tags":["Zero Trust Gateway proxy endpoints"]},"patch":{"description":"Update a configured Zero Trust Gateway proxy endpoint.","operationId":"zero-trust-gateway-proxy-endpoints-update-proxy-endpoint","parameters":[{"in":"path","name":"proxy_endpoint_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ips":{"$ref":"#/components/schemas/zero-trust-gateway_ips"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-name"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response"}}},"description":"Returns an updated proxy endpoint response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_proxy-endpoints_components-schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Returns an updated proxy endpoint response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a proxy endpoint","tags":["Zero Trust Gateway proxy endpoints"]}},"/accounts/{account_id}/gateway/rules":{"get":{"description":"List Zero Trust Gateway rules for an account.","operationId":"zero-trust-gateway-rules-list-zero-trust-gateway-rules","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_rules_components-schemas-response_collection"}}},"description":"List Zero Trust Gateway rules response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"type":"object"},{"$ref":"#/components/schemas/zero-trust-gateway_rules_components-schemas-response_collection"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"List Zero Trust Gateway rules response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Zero Trust Gateway rules","tags":["Zero Trust Gateway rules"]},"post":{"description":"Create a new Zero Trust Gateway rule.","operationId":"zero-trust-gateway-rules-create-zero-trust-gateway-rule","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"$ref":"#/components/schemas/zero-trust-gateway_action"},"description":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-description"},"device_posture":{"$ref":"#/components/schemas/zero-trust-gateway_device_posture"},"enabled":{"$ref":"#/components/schemas/zero-trust-gateway_enabled"},"expiration":{"$ref":"#/components/schemas/zero-trust-gateway_expiration"},"filters":{"$ref":"#/components/schemas/zero-trust-gateway_filters"},"identity":{"$ref":"#/components/schemas/zero-trust-gateway_identity"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/zero-trust-gateway_precedence"},"rule_settings":{"$ref":"#/components/schemas/zero-trust-gateway_rule-settings"},"schedule":{"$ref":"#/components/schemas/zero-trust-gateway_schedule"},"traffic":{"$ref":"#/components/schemas/zero-trust-gateway_traffic"}},"required":["name","action"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-single_response"}}},"description":"Create a Zero Trust Gateway rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"type":"object"},{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Create a Zero Trust Gateway rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a Zero Trust Gateway rule","tags":["Zero Trust Gateway rules"]}},"/accounts/{account_id}/gateway/rules/tenant":{"get":{"description":"List Zero Trust Gateway rules for the parent account of an account in the MSP configuration.","operationId":"zero-trust-gateway-rules-list-zero-trust-gateway-rules-tenant","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_rules_components-schemas-response_collection"}}},"description":"List Zero Trust Gateway rules response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"type":"object"},{"$ref":"#/components/schemas/zero-trust-gateway_rules_components-schemas-response_collection"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"List Zero Trust Gateway rules response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Zero Trust Gateway rules inherited from the parent account","tags":["Zero Trust Gateway rules"]}},"/accounts/{account_id}/gateway/rules/{rule_id}":{"delete":{"description":"Delete a Zero Trust Gateway rule.","operationId":"zero-trust-gateway-rules-delete-zero-trust-gateway-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_empty_response"}}},"description":"Delete a Zero Trust Gateway rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_empty_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Delete a Zero Trust Gateway rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a Zero Trust Gateway rule","tags":["Zero Trust Gateway rules"]},"get":{"description":"Get a single Zero Trust Gateway rule.","operationId":"zero-trust-gateway-rules-zero-trust-gateway-rule-details","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-single_response"}}},"description":"Get Zero Trust Gateway rule details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"type":"object"},{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}]}}},"description":"Get Zero Trust Gateway rule details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Zero Trust Gateway rule details.","tags":["Zero Trust Gateway rules"]},"put":{"description":"Update a configured Zero Trust Gateway rule.","operationId":"zero-trust-gateway-rules-update-zero-trust-gateway-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"$ref":"#/components/schemas/zero-trust-gateway_action"},"description":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-description"},"device_posture":{"$ref":"#/components/schemas/zero-trust-gateway_device_posture"},"enabled":{"$ref":"#/components/schemas/zero-trust-gateway_enabled"},"expiration":{"$ref":"#/components/schemas/zero-trust-gateway_expiration"},"filters":{"$ref":"#/components/schemas/zero-trust-gateway_filters"},"identity":{"$ref":"#/components/schemas/zero-trust-gateway_identity"},"name":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/zero-trust-gateway_precedence"},"rule_settings":{"$ref":"#/components/schemas/zero-trust-gateway_rule-settings"},"schedule":{"$ref":"#/components/schemas/zero-trust-gateway_schedule"},"traffic":{"$ref":"#/components/schemas/zero-trust-gateway_traffic"}},"required":["name","action"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-single_response"}}},"description":"Update a Zero Trust Gateway rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"type":"object"},{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}]}}},"description":"Update a Zero Trust Gateway rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a Zero Trust Gateway rule","tags":["Zero Trust Gateway rules"]}},"/accounts/{account_id}/gateway/rules/{rule_id}/reset_expiration":{"post":{"description":"Resets the expiration of a Zero Trust Gateway Rule if its duration elapsed and it has a default duration. The Zero Trust Gateway Rule must have values  for both `expiration.expires_at` and `expiration.duration`.","operationId":"zero-trust-gateway-rules-reset-expiration-zero-trust-gateway-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-uuid"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/zero-trust-gateway_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-single_response"}}},"description":"Reset the expiration of a Zero Trust Gateway rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zero-trust-gateway_components-schemas-single_response"},{"$ref":"#/components/schemas/zero-trust-gateway_api-response-common-failure"}],"type":"object"}}},"description":"Reset the expiration of a Zero Trust Gateway rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Reset the expiration of a Zero Trust Gateway Rule","tags":["Zero Trust Gateway rules"]}},"/accounts/{account_id}/hyperdrive/configs":{"get":{"description":"Returns a list of Hyperdrives.","operationId":"list-hyperdrive","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/hyperdrive_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-config-response"},"type":"array"}},"type":"object"}]}}},"description":"List Hyperdrives Response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hyperdrive_api-response-common-failure"}}},"description":"List Hyperdrives Failure Response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Hyperdrives","tags":["Hyperdrive"],"x-api-token-group":["Hyperdrive Write","Hyperdrive Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.hyperdrive.database.list"]}},"post":{"description":"Creates and returns a new Hyperdrive configuration.","operationId":"create-hyperdrive","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/hyperdrive_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-config"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-config-response"}},"type":"object"}]}}},"description":"Create Hyperdrive Response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hyperdrive_api-response-common-failure"}}},"description":"Create Hyperdrive Failure Response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Hyperdrive","tags":["Hyperdrive"],"x-api-token-group":["Hyperdrive Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.hyperdrive.database.create"]}}},"/accounts/{account_id}/hyperdrive/configs/{hyperdrive_id}":{"delete":{"description":"Deletes the specified Hyperdrive.","operationId":"delete-hyperdrive","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/hyperdrive_identifier"}},{"in":"path","name":"hyperdrive_id","required":true,"schema":{"$ref":"#/components/schemas/hyperdrive_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]}}},"description":"Delete Hyperdrive Response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hyperdrive_api-response-common-failure"}}},"description":"Delete Hyperdrive Failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Hyperdrive","tags":["Hyperdrive"],"x-api-token-group":["Hyperdrive Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.hyperdrive.database.delete"]}},"get":{"description":"Returns the specified Hyperdrive configuration.","operationId":"get-hyperdrive","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/hyperdrive_identifier"}},{"in":"path","name":"hyperdrive_id","required":true,"schema":{"$ref":"#/components/schemas/hyperdrive_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-config-response"}},"type":"object"}]}}},"description":"Get Hyperdrive Response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hyperdrive_api-response-common-failure"}}},"description":"Get Hyperdrive Failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Hyperdrive","tags":["Hyperdrive"],"x-api-token-group":["Hyperdrive Write","Hyperdrive Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.hyperdrive.database.read"]}},"patch":{"description":"Patches and returns the specified Hyperdrive configuration. Custom caching settings are not kept if caching is disabled.","operationId":"patch-hyperdrive","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/hyperdrive_identifier"}},{"in":"path","name":"hyperdrive_id","required":true,"schema":{"$ref":"#/components/schemas/hyperdrive_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-config-patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-config-response"}},"type":"object"}]}}},"description":"Patch Hyperdrive Response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hyperdrive_api-response-common-failure"}}},"description":"Patch Hyperdrive Failure Response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Hyperdrive","tags":["Hyperdrive"],"x-api-token-group":["Hyperdrive Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.hyperdrive.database.update"]}},"put":{"description":"Updates and returns the specified Hyperdrive configuration.","operationId":"update-hyperdrive","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/hyperdrive_identifier"}},{"in":"path","name":"hyperdrive_id","required":true,"schema":{"$ref":"#/components/schemas/hyperdrive_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-config"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/hyperdrive_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/hyperdrive_hyperdrive-config-response"}},"type":"object"}]}}},"description":"Update Hyperdrive Response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hyperdrive_api-response-common-failure"}}},"description":"Update Hyperdrive Failure Response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Hyperdrive","tags":["Hyperdrive"],"x-api-token-group":["Hyperdrive Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.hyperdrive.database.update"]}}},"/accounts/{account_id}/iam/permission_groups":{"get":{"description":"List all the permissions groups for an account.","operationId":"account-permission-group-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"query","name":"id","schema":{"description":"ID of the permission group to be fetched.","example":"6d7f2f5f5b1d4a0e9081fdc98d432fd1","maxLength":32,"minLength":32,"type":"string"}},{"in":"query","name":"name","schema":{"description":"Name of the permission group to be fetched.","example":"NameOfThePermissionGroup","type":"string"}},{"in":"query","name":"label","schema":{"description":"Label of the permission group to be fetched.","example":"labelOfThePermissionGroup","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_collection_permission_groups_response"}}},"description":"List Permission Groups response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"List Permission Groups response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Account Permission Groups","tags":["Account Permission Groups"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","DNS View Write","DNS View Read","SCIM Provisioning","Load Balancers Account Write","Load Balancers Account Read","Zero Trust: PII Read","DDoS Botnet Feed Write","DDoS Botnet Feed Read","Workers R2 Storage Write","Workers R2 Storage Read","DDoS Protection Write","DDoS Protection Read","Workers Tail Read","Workers KV Storage Write","Workers KV Storage Read","Workers Scripts Write","Workers Scripts Read","Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read","Account Firewall Access Rules Write","Account Firewall Access Rules Read","DNS Firewall Write","DNS Firewall Read","Billing Write","Billing Read","Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.iam.permission-group.list"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/iam/permission_groups/{permission_group_id}":{"get":{"description":"Get information about a specific permission group in an account.","operationId":"account-permission-group-details","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"permission_group_id","required":true,"schema":{"$ref":"#/components/schemas/iam_permission_group_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_permission_groups_response"}}},"description":"Permission Group Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Permission Group Details response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Permission Group Details","tags":["Account Permission Groups"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","DNS View Write","DNS View Read","SCIM Provisioning","Load Balancers Account Write","Load Balancers Account Read","Zero Trust: PII Read","DDoS Botnet Feed Write","DDoS Botnet Feed Read","Workers R2 Storage Write","Workers R2 Storage Read","DDoS Protection Write","DDoS Protection Read","Workers Tail Read","Workers KV Storage Write","Workers KV Storage Read","Workers Scripts Write","Workers Scripts Read","Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read","Account Firewall Access Rules Write","Account Firewall Access Rules Read","DNS Firewall Write","DNS Firewall Read","Billing Write","Billing Read","Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.iam.permission-group.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/iam/resource_groups":{"get":{"description":"List all the resource groups for an account.","operationId":"account-resource-group-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"query","name":"id","schema":{"allOf":[{"$ref":"#/components/schemas/iam_resource_group_identifier"}],"description":"ID of the resource group to be fetched."}},{"in":"query","name":"name","schema":{"description":"Name of the resource group to be fetched.","example":"NameOfTheResourceGroup","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_collection_resource_groups_response"}}},"description":"List Resource Groups response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"List Resource Groups response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Resource Groups","tags":["Account Resource Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.iam.resource-group.list"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a new Resource Group under the specified account.","operationId":"account-resource-group-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_request_create_resource_group"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_created_resource_group_response"}}},"description":"Add Resource Group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Add Resource Group response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Resource Group","tags":["Account Resource Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.iam.resource-group.create"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/iam/resource_groups/{resource_group_id}":{"delete":{"description":"Remove a resource group from an account.","operationId":"account-resource-group-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"resource_group_id","required":true,"schema":{"$ref":"#/components/schemas/iam_resource_group_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-single-id"}}},"description":"Remove Resource Group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Remove Member response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Remove Resource Group","tags":["Account Resource Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.iam.resource-group.delete"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get information about a specific resource group in an account.","operationId":"account-resource-group-details","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"resource_group_id","required":true,"schema":{"$ref":"#/components/schemas/iam_resource_group_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_resource_group"}}},"description":"Resource Group Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Resource Group Details response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Resource Group Details","tags":["Account Resource Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.iam.resource-group.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Modify an existing resource group.","operationId":"account-resource-group-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"resource_group_id","required":true,"schema":{"$ref":"#/components/schemas/iam_resource_group_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_request_update_resource_group"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_resource_group"}}},"description":"Update Resource Group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Update Resource Group response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Resource Group","tags":["Account Resource Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.iam.resource-group.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/iam/user_groups":{"get":{"description":"List all the user groups for an account.","operationId":"account-user-group-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"description":"ID of the user group to be fetched.","in":"query","name":"id","schema":{"$ref":"#/components/schemas/iam_user_group_identifier"}},{"in":"query","name":"name","schema":{"description":"Name of the user group to be fetched.","example":"NameOfTheUserGroup","type":"string"}},{"in":"query","name":"fuzzyName","schema":{"description":"A string used for searching for user groups containing that substring.","example":"Foo","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"direction","schema":{"description":"The sort order of returned user groups by name. Default sort order is ascending. To switch to descending, set this parameter to \"desc\"","example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/iam_user_groups"}},"type":"object"}]}}},"description":"List User Group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"List User Group response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List User Groups","tags":["Account User Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.member.list"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a new user group under the specified account.","operationId":"account-user-group-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_create_user_group_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_user_group"}},"type":"object"}]}}},"description":"Add User Group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Add User Group response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create User Group","tags":["Account User Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.member.create"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/iam/user_groups/{user_group_id}":{"delete":{"description":"Remove a user group from an account.","operationId":"account-user-group-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"user_group_id","required":true,"schema":{"$ref":"#/components/schemas/iam_user_group_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-single-id"}}},"description":"Remove User Group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Remove User Group response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Remove User Group","tags":["Account User Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.member.delete"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get information about a specific user group in an account.","operationId":"account-user-group-details","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"user_group_id","required":true,"schema":{"$ref":"#/components/schemas/iam_user_group_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_user_group"}},"type":"object"}]}}},"description":"User Group Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"User Group Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"User Group Details","tags":["Account User Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.member.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Modify an existing user group.","operationId":"account-user-group-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"user_group_id","required":true,"schema":{"$ref":"#/components/schemas/iam_user_group_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_update_user_group_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_user_group"}},"type":"object"}]}}},"description":"Update User Group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Update User Group response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update User Group","tags":["Account User Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.member.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/iam/user_groups/{user_group_id}/members":{"get":{"description":"List all the members attached to a user group.","operationId":"account-user-group-member-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"user_group_id","required":true,"schema":{"$ref":"#/components/schemas/iam_user_group_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":100,"description":"Maximum number of results per page.","maximum":500,"minimum":1,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/iam_user_group_member"},"type":"array"}},"type":"object"}],"title":"List of members attached to a user group"}}},"description":"List User Group Members"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"User Group Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List User Group Members","tags":["Account User Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.member.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Add members to a User Group.","operationId":"account-user-group-member-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"user_group_id","required":true,"schema":{"$ref":"#/components/schemas/iam_user_group_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"properties":{"id":{"$ref":"#/components/schemas/iam_user_group_member_identifier"}},"required":["id"],"type":"object"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_user_group_member"}},"type":"object"}]}}},"description":"Add User Group Member response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Add User Group Member response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Add User Group Members","tags":["Account User Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.member.create"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Replace the set of members attached to a User Group.","operationId":"account-user-group-members-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"user_group_id","required":true,"schema":{"$ref":"#/components/schemas/iam_user_group_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Set/Replace members to a user group.","items":{"properties":{"id":{"$ref":"#/components/schemas/iam_user_group_member_identifier"}},"required":["id"],"type":"object"},"title":"Update User Group Members","type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/iam_user_group_member"},"type":"array"}},"type":"object"}]}}},"description":"Update User Group Members response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Update User Group response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update User Group Members","tags":["Account User Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/iam/user_groups/{user_group_id}/members/{member_id}":{"delete":{"description":"Remove a member from User Group","operationId":"account-user-group-member-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"user_group_id","required":true,"schema":{"$ref":"#/components/schemas/iam_user_group_identifier"}},{"in":"path","name":"member_id","required":true,"schema":{"$ref":"#/components/schemas/iam_user_group_member_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/iam_user_group_member"}},"type":"object"}]}}},"description":"Delete User Group Member response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Delete User Group response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Remove User Group Member","tags":["Account User Groups"],"x-api-token-group":["SCIM Provisioning","Account Settings Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.member.delete"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/images/v1":{"get":{"deprecated":true,"description":"List up to 100 images with one request. Use the optional parameters below to get a specific range of images.","operationId":"cloudflare-images-list-images","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":1000,"description":"Number of items per page.","maximum":10000,"minimum":10,"type":"number"}},{"in":"query","name":"creator","schema":{"description":"Internal user ID set within the creator field. Setting to empty string \"\" will return images where creator field is not set","nullable":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_images_list_response"}}},"description":"List images response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_images_list_response"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"List images response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List images","tags":["Cloudflare Images"],"x-api-token-group":["Images Read","Images Write"]},"post":{"description":"Upload an image with up to 10 Megabytes using a single HTTP POST (multipart/form-data) request.\nAn image can be uploaded by sending an image file or passing an accessible to an API url.\n","operationId":"cloudflare-images-upload-an-image-via-url","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/images_image_basic_upload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_response_single"}}},"description":"Upload an image response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_image_response_single"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"Upload an image response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Upload an image","tags":["Cloudflare Images"],"x-api-token-group":["Images Write"]}},"/accounts/{account_id}/images/v1/keys":{"get":{"description":"Lists your signing keys. These can be found on your Cloudflare Images dashboard.","operationId":"cloudflare-images-keys-list-signing-keys","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_key_response_collection"}}},"description":"List Signing Keys response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_image_key_response_collection"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"List Signing Keys response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Signing Keys","tags":["Cloudflare Images Keys"],"x-api-token-group":["Images Read","Images Write"]}},"/accounts/{account_id}/images/v1/keys/{signing_key_name}":{"delete":{"description":"Delete signing key with specified name. Returns all keys available.\nWhen last key is removed, a new default signing key will be generated.\n","operationId":"cloudflare-images-keys-delete-signing-key","parameters":[{"in":"path","name":"signing_key_name","required":true,"schema":{"$ref":"#/components/schemas/images_signing_key_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_key_response_collection"}}},"description":"Delete Signing Key response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_image_key_response_collection"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"Delete Signing Key response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Signing Key","tags":["Cloudflare Images Keys"]},"put":{"description":"Create a new signing key with specified name. Returns all keys available.","operationId":"cloudflare-images-keys-add-signing-key","parameters":[{"in":"path","name":"signing_key_name","required":true,"schema":{"$ref":"#/components/schemas/images_signing_key_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_key_response_collection"}}},"description":"Add Signing Key response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_image_key_response_collection"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"Add Signing Key response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a new Signing Key","tags":["Cloudflare Images Keys"]}},"/accounts/{account_id}/images/v1/stats":{"get":{"description":"Fetch image statistics details for Cloudflare Images. The returned statistics detail storage usage, including the current image count vs this account's allowance.","operationId":"cloudflare-images-images-usage-statistics","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_images_stats_response"}}},"description":"Images usage statistics response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_images_stats_response"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"Images usage statistics response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Images usage statistics","tags":["Cloudflare Images"],"x-api-token-group":["Images Read","Images Write"]}},"/accounts/{account_id}/images/v1/variants":{"get":{"description":"Lists existing variants.","operationId":"cloudflare-images-variants-list-variants","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_variant_list_response"}}},"description":"List variants response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_image_variant_list_response"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"List variants response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List variants","tags":["Cloudflare Images Variants"],"x-api-token-group":["Images Read","Images Write"]},"post":{"description":"Specify variants that allow you to resize images for different use cases.","operationId":"cloudflare-images-variants-create-a-variant","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_variant_definition"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_variant_simple_response"}}},"description":"Create a variant response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_image_variant_simple_response"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"Create a variant response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a variant","tags":["Cloudflare Images Variants"],"x-api-token-group":["Images Write"]}},"/accounts/{account_id}/images/v1/variants/{variant_id}":{"delete":{"description":"Deleting a variant purges the cache for all images associated with the variant.","operationId":"cloudflare-images-variants-delete-a-variant","parameters":[{"in":"path","name":"variant_id","required":true,"schema":{"$ref":"#/components/schemas/images_image_variant_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_deleted_response"}}},"description":"Delete a variant response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_deleted_response"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"Delete a variant response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a variant","tags":["Cloudflare Images Variants"],"x-api-token-group":["Images Write"]},"get":{"description":"Fetch details for a single variant.","operationId":"cloudflare-images-variants-variant-details","parameters":[{"in":"path","name":"variant_id","required":true,"schema":{"$ref":"#/components/schemas/images_image_variant_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_variant_simple_response"}}},"description":"Variant details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_image_variant_simple_response"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"Variant details response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Variant details","tags":["Cloudflare Images Variants"],"x-api-token-group":["Images Read","Images Write"]},"patch":{"description":"Updating a variant purges the cache for all images associated with the variant.","operationId":"cloudflare-images-variants-update-a-variant","parameters":[{"in":"path","name":"variant_id","required":true,"schema":{"$ref":"#/components/schemas/images_image_variant_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_variant_patch_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_variant_simple_response"}}},"description":"Update a variant response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_image_variant_simple_response"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"Update a variant response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update a variant","tags":["Cloudflare Images Variants"],"x-api-token-group":["Images Write"]}},"/accounts/{account_id}/images/v1/{image_id}":{"delete":{"description":"Delete an image on Cloudflare Images. On success, all copies of the image are deleted and purged from cache.","operationId":"cloudflare-images-delete-image","parameters":[{"in":"path","name":"image_id","required":true,"schema":{"$ref":"#/components/schemas/images_image_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_deleted_response"}}},"description":"Delete image response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_deleted_response"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"Delete image response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete image","tags":["Cloudflare Images"],"x-api-token-group":["Images Write"]},"get":{"description":"Fetch details for a single image.","operationId":"cloudflare-images-image-details","parameters":[{"in":"path","name":"image_id","required":true,"schema":{"$ref":"#/components/schemas/images_image_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_response_single"}}},"description":"Image details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_image_response_single"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"Image details response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Image details","tags":["Cloudflare Images"],"x-api-token-group":["Images Read","Images Write"]},"patch":{"description":"Update image access control. On access control change, all copies of the image are purged from cache.","operationId":"cloudflare-images-update-image","parameters":[{"in":"path","name":"image_id","required":true,"schema":{"$ref":"#/components/schemas/images_image_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_patch_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_response_single"}}},"description":"Update image response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_image_response_single"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"Update image response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update image","tags":["Cloudflare Images"],"x-api-token-group":["Images Write"]}},"/accounts/{account_id}/images/v1/{image_id}/blob":{"get":{"description":"Fetch base image. For most images this will be the originally uploaded file. For larger images it can be a near-lossless version of the original.","operationId":"cloudflare-images-base-image","parameters":[{"in":"path","name":"image_id","required":true,"schema":{"$ref":"#/components/schemas/images_image_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"Base image response. Returns uploaded image data."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_image_response_blob"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"Base image response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Base image","tags":["Cloudflare Images"],"x-api-token-group":["Images Read","Images Write"]}},"/accounts/{account_id}/images/v2":{"get":{"description":"List up to 10000 images with one request. Use the optional parameters below to get a specific range of images.\nEndpoint returns continuation_token if more images are present.\n","operationId":"cloudflare-images-list-images-v2","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}},{"in":"query","name":"continuation_token","schema":{"description":"Continuation token for a next page. List images V2 returns continuation_token","nullable":true,"type":"string"}},{"in":"query","name":"per_page","schema":{"default":1000,"description":"Number of items per page.","maximum":10000,"minimum":10,"type":"number"}},{"in":"query","name":"sort_order","schema":{"default":"desc","description":"Sorting order by upload time.","enum":["asc","desc"],"type":"string"}},{"in":"query","name":"creator","schema":{"description":"Internal user ID set within the creator field. Setting to empty string \"\" will return images where creator field is not set","nullable":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_images_list_response_v2"}}},"description":"List images response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_images_list_response_v2"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"List images response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List images V2","tags":["Cloudflare Images"],"x-api-token-group":["Images Read","Images Write"]}},"/accounts/{account_id}/images/v2/direct_upload":{"post":{"description":"Direct uploads allow users to upload images without API keys. A common use case are web apps, client-side applications, or mobile devices where users upload content directly to Cloudflare Images. This method creates a draft record for a future image. It returns an upload URL and an image identifier. To verify if the image itself has been uploaded, send an image details request (accounts/:account_identifier/images/v1/:identifier), and check that the `draft: true` property is not present.","operationId":"cloudflare-images-create-authenticated-direct-upload-url-v-2","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/images_account_identifier"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/images_image_direct_upload_request_v2"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_image_direct_upload_response_v2"}}},"description":"Create authenticated direct upload URL V2 response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_image_direct_upload_response_v2"},{"$ref":"#/components/schemas/images_api-response-common-failure"}]}}},"description":"Create authenticated direct upload URL V2 response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create authenticated direct upload URL V2","tags":["Cloudflare Images"],"x-api-token-group":["Images Write"]}},"/accounts/{account_id}/infrastructure/targets":{"get":{"description":"Lists and sorts an account’s targets. Filters are optional and are ANDed\ntogether.","operationId":"infra-targets-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/infra_AccountTag"}},{"description":"Hostname of a target","in":"query","name":"hostname","schema":{"nullable":true,"type":"string"}},{"description":"Partial match to the hostname of a target","in":"query","name":"hostname_contains","schema":{"nullable":true,"type":"string"}},{"description":"Private virtual network identifier of the target","in":"query","name":"virtual_network_id","schema":{"format":"uuid","nullable":true,"type":"string"}},{"description":"IPv4 address of the target","in":"query","name":"ip_v4","schema":{"nullable":true,"type":"string"}},{"description":"IPv6 address of the target","in":"query","name":"ip_v6","schema":{"nullable":true,"type":"string"}},{"description":"Date and time at which the target was created before (inclusive)","in":"query","name":"created_before","schema":{"format":"date-time","nullable":true,"type":"string"}},{"description":"Date and time at which the target was created after (inclusive)","in":"query","name":"created_after","schema":{"format":"date-time","nullable":true,"type":"string"}},{"description":"Date and time at which the target was modified before (inclusive)","in":"query","name":"modified_before","schema":{"format":"date-time","nullable":true,"type":"string"}},{"description":"Date and time at which the target was modified after (inclusive)","in":"query","name":"modified_after","schema":{"format":"date-time","nullable":true,"type":"string"}},{"description":"Filters for targets that have any of the following IP addresses. Specify\n`ips` multiple times in query parameter to build list of candidates.","in":"query","name":"ips","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Filters for targets that have any of the following UUIDs. Specify\n`target_ids` multiple times in query parameter to build list of\ncandidates.","in":"query","name":"target_ids","schema":{"items":{"format":"uuid","type":"string"},"type":"array"}},{"description":"Filters for targets whose IP addresses look like the specified string.\nSupports `*` as a wildcard character","in":"query","name":"ip_like","schema":{"nullable":true,"type":"string"}},{"description":"Defines an IPv4 filter range's starting value (inclusive). Requires\n`ipv4_end` to be specified as well.","in":"query","name":"ipv4_start","schema":{"nullable":true,"type":"string"}},{"description":"Defines an IPv4 filter range's ending value (inclusive). Requires\n`ipv4_start` to be specified as well.","in":"query","name":"ipv4_end","schema":{"nullable":true,"type":"string"}},{"description":"Defines an IPv6 filter range's starting value (inclusive). Requires\n`ipv6_end` to be specified as well.","in":"query","name":"ipv6_start","schema":{"nullable":true,"type":"string"}},{"description":"Defines an IPv6 filter range's ending value (inclusive). Requires\n`ipv6_start` to be specified as well.","in":"query","name":"ipv6_end","schema":{"nullable":true,"type":"string"}},{"description":"Current page in the response","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"}},{"description":"Max amount of entries returned per page","in":"query","name":"per_page","schema":{"default":1000,"format":"int32","maximum":1000,"minimum":1,"type":"integer"}},{"description":"The field to sort by.","in":"query","name":"order","schema":{"enum":["hostname","created_at"],"type":"string"}},{"description":"The sorting direction.","in":"query","name":"direction","schema":{"allOf":[{"$ref":"#/components/schemas/infra_SortingDirection"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/infra_api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/infra_TargetArray"}},"type":"object"}]}}},"description":"Successfully retrieved all targets in the account"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_api-response-common-failure"}}},"description":"Failed to retrieve all targets in the account"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List all targets","tags":["Infrastructure Access Targets"]},"post":{"operationId":"infra-targets-post","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/infra_AccountTag"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"hostname":{"description":"A non-unique field that refers to a target. Case insensitive, maximum\nlength of 255 characters, supports the use of special characters dash\nand period, does not support spaces, and must start and end with an\nalphanumeric character.","example":"infra-access-target","type":"string","x-auditable":true},"ip":{"$ref":"#/components/schemas/infra_IPInfo"}},"required":["hostname","ip"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/infra_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/infra_Target"}},"type":"object"}]}}},"description":"Successfully created the target"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_api-response-common-failure"}}},"description":"Failed to create the target"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create new target","tags":["Infrastructure Access Targets"]}},"/accounts/{account_id}/infrastructure/targets/batch":{"delete":{"deprecated":true,"description":"Removes one or more targets.","operationId":"infra-targets-delete-batch","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/infra_AccountTag"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"target_ids":{"description":"List of target IDs to bulk delete","items":{"$ref":"#/components/schemas/infra_TargetId"},"type":"array"}},"required":["target_ids"],"type":"object"}}},"required":true},"responses":{"200":{"description":"Successfully deleted the targets"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_api-response-common-failure"}}},"description":"Failed to delete the targets"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete targets (Deprecated)","tags":["Infrastructure Access Targets"]},"put":{"description":"Adds one or more targets.","operationId":"infra-targets-put-batch","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/infra_AccountTag"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"properties":{"hostname":{"description":"A non-unique field that refers to a target. Case insensitive, maximum\nlength of 255 characters, supports the use of special characters dash\nand period, does not support spaces, and must start and end with an\nalphanumeric character.","example":"infra-access-target","type":"string","x-auditable":true},"ip":{"$ref":"#/components/schemas/infra_IPInfo"}},"required":["hostname","ip"],"type":"object"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/infra_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/infra_TargetArray"}},"type":"object"}]}}},"description":"Successfully created the targets"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_api-response-common-failure"}}},"description":"Failed to create the targets"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create new targets","tags":["Infrastructure Access Targets"]}},"/accounts/{account_id}/infrastructure/targets/batch_delete":{"post":{"description":"Removes one or more targets.","operationId":"infra-targets-delete-batch-post","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/infra_AccountTag"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"target_ids":{"description":"List of target IDs to bulk delete","items":{"$ref":"#/components/schemas/infra_TargetId"},"type":"array"}},"required":["target_ids"],"type":"object"}}},"required":true},"responses":{"200":{"description":"Successfully deleted the targets"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_api-response-common-failure"}}},"description":"Failed to delete the targets"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete targets","tags":["Infrastructure Access Targets"]}},"/accounts/{account_id}/infrastructure/targets/{target_id}":{"delete":{"operationId":"infra-targets-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/infra_AccountTag"}},{"in":"path","name":"target_id","required":true,"schema":{"$ref":"#/components/schemas/infra_TargetId"}}],"responses":{"200":{"description":"Successfully deleted the target"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_api-response-common-failure"}}},"description":"Failed to delete the target"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete target","tags":["Infrastructure Access Targets"]},"get":{"operationId":"infra-targets-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/infra_AccountTag"}},{"in":"path","name":"target_id","required":true,"schema":{"$ref":"#/components/schemas/infra_TargetId"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/infra_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/infra_Target"}},"type":"object"}]}}},"description":"Successfully retrieved the target"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_api-response-common-failure"}}},"description":"Failed to retrieve the target"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get target","tags":["Infrastructure Access Targets"]},"put":{"operationId":"infra-targets-put","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/infra_AccountTag"}},{"in":"path","name":"target_id","required":true,"schema":{"$ref":"#/components/schemas/infra_TargetId"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"hostname":{"description":"A non-unique field that refers to a target. Case insensitive, maximum\nlength of 255 characters, supports the use of special characters dash\nand period, does not support spaces, and must start and end with an\nalphanumeric character.","example":"infra-access-target","type":"string","x-auditable":true},"ip":{"$ref":"#/components/schemas/infra_IPInfo"}},"required":["hostname","ip"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/infra_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/infra_Target"}},"type":"object"}]}}},"description":"Successfully updated the target"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infra_api-response-common-failure"}}},"description":"Failed to update the target"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update target","tags":["Infrastructure Access Targets"]}},"/accounts/{account_id}/intel/asn/{asn}":{"get":{"description":"Gets an overview of the Autonomous System Number (ASN) and a list of subnets for it.","operationId":"asn-intelligence-get-asn-overview","parameters":[{"in":"path","name":"asn","required":true,"schema":{"$ref":"#/components/schemas/intel_asn"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/intel_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/intel_asn_components-schemas-response"}}},"description":"Get ASN Overview response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/intel_asn_components-schemas-response"},{"$ref":"#/components/schemas/intel_api-response-common-failure"}]}}},"description":"Get ASN Overview response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get ASN Overview.","tags":["ASN Intelligence"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/asn/{asn}/subnets":{"get":{"description":"Get ASN Subnets.","operationId":"asn-intelligence-get-asn-subnets","parameters":[{"in":"path","name":"asn","required":true,"schema":{"$ref":"#/components/schemas/intel_asn"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/intel_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"asn":{"$ref":"#/components/schemas/intel_asn"},"count":{"$ref":"#/components/schemas/intel_count"},"ip_count_total":{"type":"integer"},"page":{"$ref":"#/components/schemas/intel_page"},"per_page":{"$ref":"#/components/schemas/intel_per_page"},"subnets":{"example":["192.0.2.0/24","2001:DB8::/32"],"items":{"type":"string"},"type":"array"}},"type":"object"}}},"description":"Get ASN Subnets response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"asn":{"$ref":"#/components/schemas/intel_asn"},"count":{"$ref":"#/components/schemas/intel_count"},"ip_count_total":{"type":"integer"},"page":{"$ref":"#/components/schemas/intel_page"},"per_page":{"$ref":"#/components/schemas/intel_per_page"},"subnets":{"example":["192.0.2.0/24","2001:DB8::/32"],"items":{"type":"string"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/intel_api-response-common-failure"}]}}},"description":"Get ASN Subnets response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get ASN Subnets","tags":["ASN Intelligence"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/attack-surface-report/issue-types":{"get":{"operationId":"get-security-center-issue-types","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/security-center_api-response-common"},{"properties":{"result":{"anyOf":[{"items":{"type":"string"},"type":"array"}]}}}]}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Security Center Issues Types","tags":["Security Center Insights"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/attack-surface-report/issues":{"get":{"deprecated":true,"operationId":"get-security-center-issues","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"query","name":"dismissed","schema":{"$ref":"#/components/schemas/security-center_dismissed"}},{"in":"query","name":"issue_class","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"issue_class~neq","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type~neq","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product~neq","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity~neq","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject~neq","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"page","schema":{"allOf":[{"$ref":"#/components/schemas/security-center_page"}],"default":1}},{"in":"query","name":"per_page","schema":{"allOf":[{"$ref":"#/components/schemas/security-center_perPage"}],"default":25}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/security-center_api-response-common"},{"properties":{"result":{"anyOf":[{"properties":{"count":{"$ref":"#/components/schemas/security-center_count"},"issues":{"items":{"$ref":"#/components/schemas/security-center_issue"},"type":"array"},"page":{"$ref":"#/components/schemas/security-center_page"},"per_page":{"$ref":"#/components/schemas/security-center_perPage"}},"type":"object"}]}}}]}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Security Center Issues","tags":["Security Center Insights"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/attack-surface-report/issues/class":{"get":{"deprecated":true,"operationId":"get-security-center-issue-counts-by-class","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"query","name":"dismissed","schema":{"$ref":"#/components/schemas/security-center_dismissed"}},{"in":"query","name":"issue_class","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"issue_class~neq","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type~neq","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product~neq","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity~neq","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject~neq","schema":{"$ref":"#/components/schemas/security-center_subjects"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_valueCountsResponse"}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Security Center Issue Counts by Class","tags":["Security Center Insights"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/attack-surface-report/issues/severity":{"get":{"deprecated":true,"operationId":"get-security-center-issue-counts-by-severity","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"query","name":"dismissed","schema":{"$ref":"#/components/schemas/security-center_dismissed"}},{"in":"query","name":"issue_class","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"issue_class~neq","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type~neq","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product~neq","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity~neq","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject~neq","schema":{"$ref":"#/components/schemas/security-center_subjects"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_valueCountsResponse"}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Security Center Issue Counts by Severity","tags":["Security Center Insights"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/attack-surface-report/issues/type":{"get":{"deprecated":true,"operationId":"get-security-center-issue-counts-by-type","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"query","name":"dismissed","schema":{"$ref":"#/components/schemas/security-center_dismissed"}},{"in":"query","name":"issue_class","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"issue_class~neq","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type~neq","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product~neq","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity~neq","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject~neq","schema":{"$ref":"#/components/schemas/security-center_subjects"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_valueCountsResponse"}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Security Center Issue Counts by Type","tags":["Security Center Insights"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/attack-surface-report/{issue_id}/dismiss":{"put":{"deprecated":true,"operationId":"archive-security-center-insight-deprecated","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"path","name":"issue_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"dismiss":{"default":true,"type":"boolean","x-auditable":true}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/security-center_api-response-single"}]}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Archive Security Center Insight","tags":["Security Center Insights"]}},"/accounts/{account_id}/intel/dns":{"get":{"description":"Gets a list of all the domains that have resolved to a specific IP address.","operationId":"passive-dns-by-ip-get-passive-dns-by-ip","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/intel_identifier"}},{"in":"query","name":"start_end_params","schema":{"$ref":"#/components/schemas/intel_start_end_params"}},{"in":"query","name":"ipv4","schema":{"type":"string"}},{"in":"query","name":"page","schema":{"description":"Requested page within paginated list of results.","example":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"description":"Maximum number of results requested.","example":20,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/intel_components-schemas-single_response"}}},"description":"Get Passive DNS by IP response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/intel_components-schemas-single_response"},{"$ref":"#/components/schemas/intel_api-response-common-failure"}]}}},"description":"Get Passive DNS by IP response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Passive DNS by IP","tags":["Passive DNS by IP"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/domain":{"get":{"description":"Gets security details and statistics about a domain.","operationId":"domain-intelligence-get-domain-details","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/intel_identifier"}},{"in":"query","name":"domain","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/intel_single_response"}}},"description":"Get Domain Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/intel_single_response"},{"$ref":"#/components/schemas/intel_api-response-common-failure"}]}}},"description":"Get Domain Details response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Domain Details","tags":["Domain Intelligence"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/domain-history":{"get":{"description":"Gets historical security threat and content categories currently and previously assigned to a domain.","operationId":"domain-history-get-domain-history","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/intel_identifier"}},{"in":"query","name":"domain","schema":{"example":"example.com","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/intel_response"}}},"description":"Get Domain History response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/intel_response"},{"$ref":"#/components/schemas/intel_api-response-common-failure"}]}}},"description":"Get Domain History response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Domain History","tags":["Domain History"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/domain/bulk":{"get":{"description":"Same as summary.","operationId":"domain-intelligence-get-multiple-domain-details","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/intel_identifier"}},{"description":"Accepts multiple values like `?domain=cloudflare.com\u0026domain=example.com`.","explode":true,"in":"query","name":"domain","schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/intel_collection_response"}}},"description":"Get Multiple Domain Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/intel_collection_response"},{"$ref":"#/components/schemas/intel_api-response-common-failure"}]}}},"description":"Get Multiple Domain Details response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Multiple Domain Details","tags":["Domain Intelligence"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/indicator-feeds":{"get":{"operationId":"custom-indicator-feeds-get-indicator-feeds","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_indicator_feed_response"}}},"description":"Get indicator feeds response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_indicator_feed_response"},{"$ref":"#/components/schemas/custom-indicator-feeds_api_response_common_failure"}]}}},"description":"Get indicator feeds response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get indicator feeds owned by this account","tags":["Custom Indicator Feeds"],"x-api-token-group":["Intel Write","Intel Read"]},"post":{"operationId":"custom-indicator-feeds-create-indicator-feeds","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_create_feed"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_create_feed_response"}}},"description":"Create indicator feed response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_create_feed_response"},{"$ref":"#/components/schemas/custom-indicator-feeds_api_response_common_failure"}]}}},"description":"Get indicator feeds failure response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create new indicator feed","tags":["Custom Indicator Feeds"]}},"/accounts/{account_id}/intel/indicator-feeds/permissions/add":{"put":{"operationId":"custom-indicator-feeds-add-permission","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_permissions_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_permissions_response"}}},"description":"Get indicator feed metadata"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_permissions_response"},{"$ref":"#/components/schemas/custom-indicator-feeds_api_response_common_failure"}]}}},"description":"Get indicator feeds response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Grant permission to indicator feed","tags":["Custom Indicator Feeds"]}},"/accounts/{account_id}/intel/indicator-feeds/permissions/remove":{"put":{"operationId":"custom-indicator-feeds-remove-permission","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_permissions_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_permissions_response"}}},"description":"Get indicator feed metadata"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_permissions_response"},{"$ref":"#/components/schemas/custom-indicator-feeds_api_response_common_failure"}]}}},"description":"Get indicator feeds response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Revoke permission to indicator feed","tags":["Custom Indicator Feeds"]}},"/accounts/{account_id}/intel/indicator-feeds/permissions/view":{"get":{"operationId":"custom-indicator-feeds-view-permissions","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_permission_list_item_response"}}},"description":"Get indicator feed metadata"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_permission_list_item_response"},{"$ref":"#/components/schemas/custom-indicator-feeds_api_response_common_failure"}]}}},"description":"Get indicator feeds response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List indicator feed permissions","tags":["Custom Indicator Feeds"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/indicator-feeds/{feed_id}":{"get":{"operationId":"custom-indicator-feeds-get-indicator-feed-metadata","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_identifier"}},{"in":"path","name":"feed_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_feed_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_indicator_feed_metadata_response"}}},"description":"Get indicator feed metadata"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_indicator_feed_metadata_response"},{"$ref":"#/components/schemas/custom-indicator-feeds_api_response_common_failure"}]}}},"description":"Get indicator feeds response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get indicator feed metadata","tags":["Custom Indicator Feeds"],"x-api-token-group":["Intel Write","Intel Read"]},"put":{"operationId":"custom-indicator-feeds-update-indicator-feed-metadata","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_identifier"}},{"in":"path","name":"feed_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_feed_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_update_public_field_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_update_public_field_response"}}},"description":"Get update public field response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_update_public_field_response"},{"$ref":"#/components/schemas/custom-indicator-feeds_api_response_common_failure"}]}}},"description":"Get update public field response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update indicator feed metadata","tags":["Custom Indicator Feeds"]}},"/accounts/{account_id}/intel/indicator-feeds/{feed_id}/data":{"get":{"operationId":"custom-indicator-feeds-get-indicator-feed-data","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_identifier"}},{"in":"path","name":"feed_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_feed_id"}}],"responses":{"200":{"content":{"text/csv":{"schema":{"type":"string"}}},"description":"Get indicator feed metadata"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_api_response_common_failure"}]}}},"description":"Get indicator feeds response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get indicator feed data","tags":["Custom Indicator Feeds"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/indicator-feeds/{feed_id}/download":{"get":{"operationId":"custom-indicator-feeds-download-indicator-feed-data","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_identifier"}},{"in":"path","name":"feed_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_feed_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_update_feed_response"}}},"description":"Get indicator feed metadata"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_api_response_common_failure"}]}}},"description":"Get indicator feeds response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Download indicator feed data","tags":["Custom Indicator Feeds"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot":{"put":{"operationId":"custom-indicator-feeds-update-indicator-feed-data","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_identifier"}},{"in":"path","name":"feed_id","required":true,"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_feed_id"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"source":{"description":"The file to upload","example":"@/Users/me/test.stix2","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-indicator-feeds_update_feed_response"}}},"description":"Get indicator feed metadata"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-indicator-feeds_api_response_common_failure"}]}}},"description":"Get indicator feeds response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update indicator feed data","tags":["Custom Indicator Feeds"]}},"/accounts/{account_id}/intel/ip":{"get":{"description":"Gets the geolocation, ASN, infrastructure type of the ASN, and any security threat categories of an IP address. **Must provide ip query parameters.** For example, `/intel/ip?ipv4=1.1.1.1` or `/intel/ip?ipv6=2001:db8::1`.","operationId":"ip-intelligence-get-ip-overview","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/intel_identifier"}},{"in":"query","name":"ipv4","schema":{"type":"string"}},{"in":"query","name":"ipv6","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/intel_schemas-response"}}},"description":"Get IP Overview response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/intel_schemas-response"},{"$ref":"#/components/schemas/intel_api-response-common-failure"}]}}},"description":"Get IP Overview response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get IP Overview","tags":["IP Intelligence"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/ip-list":{"get":{"description":"Get IP Lists.","operationId":"ip-list-get-ip-lists","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/intel_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/intel_components-schemas-response"}}},"description":"Get IP Lists response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/intel_components-schemas-response"},{"$ref":"#/components/schemas/intel_api-response-common-failure"}]}}},"description":"Get IP Lists response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get IP Lists","tags":["IP List"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/miscategorization":{"post":{"description":"Allows you to submit requests to change a domain’s category.","operationId":"miscategorization-create-miscategorization","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/intel_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/intel_miscategorization"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/intel_api-response-single"}}},"description":"Create Miscategorization response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/intel_api-response-single"},{"$ref":"#/components/schemas/intel_api-response-common-failure"}]}}},"description":"Create Miscategorization response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Miscategorization","tags":["Miscategorization"]}},"/accounts/{account_id}/intel/sinkholes":{"get":{"operationId":"sinkhole-config-get-sinkholes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/intel-sinkholes_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/intel-sinkholes_get_sinkholes_response"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List sinkholes owned by this account","tags":["Sinkhole Config"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/intel/whois":{"get":{"operationId":"whois-record-get-whois-record","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudforce-one-whois_identifier"}},{"in":"query","name":"domain","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloudforce-one-whois_schemas-single_response"}}},"description":"Get WHOIS Record response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloudforce-one-whois_schemas-single_response"},{"$ref":"#/components/schemas/cloudforce-one-whois_api-response-common-failure"}]}}},"description":"Get WHOIS Record response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get WHOIS Record","tags":["WHOIS Record"],"x-api-token-group":["Intel Write","Intel Read"]}},"/accounts/{account_id}/load_balancers/monitor_groups":{"get":{"description":"List configured monitor groups.","operationId":"account-load-balancer-monitor-groups-list-monitor-groups","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-group-response-collection"}}},"description":"List Monitor Groups response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-group-response-collection"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"List Monitor Groups response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Monitor Groups","tags":["Account Load Balancer Monitor Groups"]},"post":{"description":"Create a new monitor group.","operationId":"account-load-balancer-monitor-groups-create-monitor-group","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-group"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"}}},"description":"Create Monitor Group response"},"412":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Precondition Failed - Referenced monitor does not exist"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Create Monitor Group response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Monitor Group","tags":["Account Load Balancer Monitor Groups"]}},"/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}":{"delete":{"description":"Delete a configured monitor group.","operationId":"account-load-balancer-monitor-groups-delete-monitor-group","parameters":[{"in":"path","name":"monitor_group_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"}}},"description":"Delete Monitor Group response"},"412":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Precondition Failed - Monitor group is in use by one or more pools"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Delete Monitor Group response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Monitor Group","tags":["Account Load Balancer Monitor Groups"]},"get":{"description":"Fetch a single configured monitor group.","operationId":"account-load-balancer-monitor-groups-monitor-group-details","parameters":[{"in":"path","name":"monitor_group_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"}}},"description":"Monitor Group Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Monitor Group Details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Monitor Group Details","tags":["Account Load Balancer Monitor Groups"]},"patch":{"description":"Apply changes to an existing monitor group, overwriting the supplied properties.","operationId":"account-load-balancer-monitor-groups-patch-monitor-group","parameters":[{"in":"path","name":"monitor_group_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-group"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"}}},"description":"Patch Monitor Group response"},"412":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Precondition Failed - Referenced monitor does not exist"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Patch Monitor Group response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Monitor Group","tags":["Account Load Balancer Monitor Groups"]},"put":{"description":"Modify a configured monitor group.","operationId":"account-load-balancer-monitor-groups-update-monitor-group","parameters":[{"in":"path","name":"monitor_group_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-group"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"}}},"description":"Update Monitor Group response"},"412":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Precondition Failed - Referenced monitor does not exist"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-group-single-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Update Monitor Group response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Monitor Group","tags":["Account Load Balancer Monitor Groups"]}},"/accounts/{account_id}/load_balancers/monitor_groups/{monitor_group_id}/references":{"get":{"description":"Get the list of resources that reference the provided monitor group.","operationId":"account-load-balancer-monitor-groups-list-monitor-group-references","parameters":[{"in":"path","name":"monitor_group_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-group-references-response"}}},"description":"List Monitor Group References response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-group-references-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"List Monitor Group References response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Monitor Group References","tags":["Account Load Balancer Monitor Groups"]}},"/accounts/{account_id}/load_balancers/monitors":{"get":{"description":"List configured monitors for an account.","operationId":"account-load-balancer-monitors-list-monitors","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-response-collection"}}},"description":"List Monitors response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-response-collection"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"List Monitors response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Monitors","tags":["Account Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]},"post":{"description":"Create a configured monitor.","operationId":"account-load-balancer-monitors-create-monitor","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-editable"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-response-single"}}},"description":"Create Monitor response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-response-single"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Create Monitor response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Monitor","tags":["Account Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]}},"/accounts/{account_id}/load_balancers/monitors/{monitor_id}":{"delete":{"description":"Delete a configured monitor.","operationId":"account-load-balancer-monitors-delete-monitor","parameters":[{"in":"path","name":"monitor_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_id_response"}}},"description":"Delete Monitor response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_id_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Delete Monitor response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Monitor","tags":["Account Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]},"get":{"description":"List a single configured monitor for an account.","operationId":"account-load-balancer-monitors-monitor-details","parameters":[{"in":"path","name":"monitor_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-response-single"}}},"description":"Monitor Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-response-single"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Monitor Details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Monitor Details","tags":["Account Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]},"patch":{"description":"Apply changes to an existing monitor, overwriting the supplied properties.","operationId":"account-load-balancer-monitors-patch-monitor","parameters":[{"in":"path","name":"monitor_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-editable"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-response-single"}}},"description":"Patch Monitor response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-response-single"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Patch Monitor response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Monitor","tags":["Account Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]},"put":{"description":"Modify a configured monitor.","operationId":"account-load-balancer-monitors-update-monitor","parameters":[{"in":"path","name":"monitor_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-editable"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-response-single"}}},"description":"Update Monitor response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-response-single"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Update Monitor response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Monitor","tags":["Account Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]}},"/accounts/{account_id}/load_balancers/monitors/{monitor_id}/preview":{"post":{"description":"Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.","operationId":"account-load-balancer-monitors-preview-monitor","parameters":[{"in":"path","name":"monitor_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-editable"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_preview_response"}}},"description":"Preview Monitor response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_preview_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Preview Monitor response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Preview Monitor","tags":["Account Load Balancer Monitors"]}},"/accounts/{account_id}/load_balancers/monitors/{monitor_id}/references":{"get":{"description":"Get the list of resources that reference the provided monitor.","operationId":"account-load-balancer-monitors-list-monitor-references","parameters":[{"in":"path","name":"monitor_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-references-response"}}},"description":"List Monitor References response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-references-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"List Monitor References response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Monitor References","tags":["Account Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]}},"/accounts/{account_id}/load_balancers/pools":{"get":{"description":"List configured pools.","operationId":"account-load-balancer-pools-list-pools","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}},{"in":"query","name":"monitor","schema":{"description":"The ID of the Monitor to use for checking the health of origins within this pool.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-response_collection"}}},"description":"List Pools response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-response_collection"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"List Pools response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Pools","tags":["Account Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]},"patch":{"description":"Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`.","operationId":"account-load-balancer-pools-patch-pools","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"notification_email":{"$ref":"#/components/schemas/load-balancing_patch_pools_notification_email"}},"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-response_collection"}}},"description":"Patch Pools response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-response_collection"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Patch Pools response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Pools","tags":["Account Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]},"post":{"description":"Create a new pool.","operationId":"account-load-balancer-pools-create-pool","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/load-balancing_schemas-description"},"enabled":{"$ref":"#/components/schemas/load-balancing_enabled"},"latitude":{"$ref":"#/components/schemas/load-balancing_latitude"},"load_shedding":{"$ref":"#/components/schemas/load-balancing_load_shedding"},"longitude":{"$ref":"#/components/schemas/load-balancing_longitude"},"minimum_origins":{"$ref":"#/components/schemas/load-balancing_minimum_origins"},"monitor":{"$ref":"#/components/schemas/load-balancing_monitor_id"},"monitor_group":{"$ref":"#/components/schemas/load-balancing_monitor_group_id"},"name":{"$ref":"#/components/schemas/load-balancing_name"},"notification_email":{"$ref":"#/components/schemas/load-balancing_notification_email"},"notification_filter":{"$ref":"#/components/schemas/load-balancing_notification_filter"},"origin_steering":{"$ref":"#/components/schemas/load-balancing_origin_steering"},"origins":{"$ref":"#/components/schemas/load-balancing_origins"}},"required":["origins","name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-single_response"}}},"description":"Create Pool response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-single_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Create Pool response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Pool","tags":["Account Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]}},"/accounts/{account_id}/load_balancers/pools/{pool_id}":{"delete":{"description":"Delete a configured pool.","operationId":"account-load-balancer-pools-delete-pool","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-id_response"}}},"description":"Delete Pool response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-id_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Delete Pool response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Pool","tags":["Account Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]},"get":{"description":"Fetch a single configured pool.","operationId":"account-load-balancer-pools-pool-details","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-single_response"}}},"description":"Pool Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-single_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Pool Details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Pool Details","tags":["Account Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]},"patch":{"description":"Apply changes to an existing pool, overwriting the supplied properties.","operationId":"account-load-balancer-pools-patch-pool","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"check_regions":{"$ref":"#/components/schemas/load-balancing_check_regions"},"description":{"$ref":"#/components/schemas/load-balancing_schemas-description"},"disabled_at":{"$ref":"#/components/schemas/load-balancing_schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/load-balancing_enabled"},"latitude":{"$ref":"#/components/schemas/load-balancing_latitude"},"load_shedding":{"$ref":"#/components/schemas/load-balancing_load_shedding"},"longitude":{"$ref":"#/components/schemas/load-balancing_longitude"},"minimum_origins":{"$ref":"#/components/schemas/load-balancing_minimum_origins"},"monitor":{"$ref":"#/components/schemas/load-balancing_monitor_id"},"monitor_group":{"$ref":"#/components/schemas/load-balancing_monitor_group_id"},"name":{"$ref":"#/components/schemas/load-balancing_name"},"notification_email":{"$ref":"#/components/schemas/load-balancing_notification_email"},"notification_filter":{"$ref":"#/components/schemas/load-balancing_notification_filter"},"origin_steering":{"$ref":"#/components/schemas/load-balancing_origin_steering"},"origins":{"$ref":"#/components/schemas/load-balancing_origins"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-single_response"}}},"description":"Patch Pool response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-single_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Patch Pool response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Pool","tags":["Account Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]},"put":{"description":"Modify a configured pool.","operationId":"account-load-balancer-pools-update-pool","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"check_regions":{"$ref":"#/components/schemas/load-balancing_check_regions"},"description":{"$ref":"#/components/schemas/load-balancing_schemas-description"},"disabled_at":{"$ref":"#/components/schemas/load-balancing_schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/load-balancing_enabled"},"latitude":{"$ref":"#/components/schemas/load-balancing_latitude"},"load_shedding":{"$ref":"#/components/schemas/load-balancing_load_shedding"},"longitude":{"$ref":"#/components/schemas/load-balancing_longitude"},"minimum_origins":{"$ref":"#/components/schemas/load-balancing_minimum_origins"},"monitor":{"$ref":"#/components/schemas/load-balancing_monitor_id"},"monitor_group":{"$ref":"#/components/schemas/load-balancing_monitor_group_id"},"name":{"$ref":"#/components/schemas/load-balancing_name"},"notification_email":{"$ref":"#/components/schemas/load-balancing_notification_email"},"notification_filter":{"$ref":"#/components/schemas/load-balancing_notification_filter"},"origin_steering":{"$ref":"#/components/schemas/load-balancing_origin_steering"},"origins":{"$ref":"#/components/schemas/load-balancing_origins"}},"required":["origins","name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-single_response"}}},"description":"Update Pool response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-single_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Update Pool response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Pool","tags":["Account Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]}},"/accounts/{account_id}/load_balancers/pools/{pool_id}/health":{"get":{"description":"Fetch the latest pool health status for a single pool.","operationId":"account-load-balancer-pools-pool-health-details","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_health_details"}}},"description":"Pool Health Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_health_details"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Pool Health Details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Pool Health Details","tags":["Account Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]}},"/accounts/{account_id}/load_balancers/pools/{pool_id}/preview":{"post":{"description":"Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.","operationId":"account-load-balancer-pools-preview-pool","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-editable"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_preview_response"}}},"description":"Preview Pool response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_preview_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Preview Pool response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Preview Pool","tags":["Account Load Balancer Pools"]}},"/accounts/{account_id}/load_balancers/pools/{pool_id}/references":{"get":{"description":"Get the list of resources that reference the provided pool.","operationId":"account-load-balancer-pools-list-pool-references","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_pools-references-response"}}},"description":"List Pool References response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_pools-references-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"List Pool References response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Pool References","tags":["Account Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]}},"/accounts/{account_id}/load_balancers/preview/{preview_id}":{"get":{"description":"Get the result of a previous preview operation using the provided preview_id.","operationId":"account-load-balancer-monitors-preview-result","parameters":[{"in":"path","name":"preview_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-preview_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_preview_result_response"}}},"description":"Preview Result response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_preview_result_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Preview Result response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Preview Result","tags":["Account Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]}},"/accounts/{account_id}/load_balancers/regions":{"get":{"description":"List all region mappings.","operationId":"load-balancer-regions-list-regions","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}},{"in":"query","name":"subdivision_code","schema":{"$ref":"#/components/schemas/load-balancing_subdivision_code_a2"}},{"in":"query","name":"subdivision_code_a2","schema":{"$ref":"#/components/schemas/load-balancing_subdivision_code_a2"}},{"in":"query","name":"country_code_a2","schema":{"description":"Two-letter alpha-2 country code followed in ISO 3166-1.","example":"US","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_region_components-schemas-response_collection"}}},"description":"List Regions response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_region_components-schemas-response_collection"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"List Regions response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Regions","tags":["Load Balancer Regions"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]}},"/accounts/{account_id}/load_balancers/regions/{region_id}":{"get":{"description":"Get a single region mapping.","operationId":"load-balancer-regions-get-region","parameters":[{"in":"path","name":"region_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_region_code"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-single_response"}}},"description":"Get Region response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_components-schemas-single_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Get Region response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Region","tags":["Load Balancer Regions"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]}},"/accounts/{account_id}/load_balancers/search":{"get":{"description":"Search for Load Balancing resources.","operationId":"account-load-balancer-search-search-resources","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-identifier"}},{"in":"query","name":"query","schema":{"default":"","description":"Search query term.","example":"primary","type":"string"}},{"in":"query","name":"references","schema":{"default":"","description":"The type of references to include. \"*\" to include both referral and referrer references. \"\" to not include any reference information.","enum":["","*","referral","referrer"],"example":"*","type":"string"}},{"in":"query","name":"page","schema":{"minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":25,"maximum":1000,"minimum":1,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-paginated-response-collection"},{"$ref":"#/components/schemas/load-balancing_search_result"}]}}},"description":"Search Resources response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/load-balancing_api-paginated-response-collection"},{"$ref":"#/components/schemas/load-balancing_search_result"}]},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Search Resources response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Search Resources","tags":["Account Load Balancer Search"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]}},"/accounts/{account_id}/logpush/datasets/{dataset_id}/fields":{"get":{"description":"Lists all fields available for a dataset. The response result is. an object with key-value pairs, where keys are field names, and values are descriptions.","operationId":"get-accounts-account_id-logpush-datasets-dataset_id-fields","parameters":[{"example":"gateway_dns","in":"path","name":"dataset_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_dataset"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_logpush_field_response_collection"}}},"description":"List fields response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"List fields response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List fields","tags":["Logpush jobs for an account"],"x-api-token-group":["Logs Read"],"x-cfPermissionsRequired":{"enum":["#logs:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/logpush/datasets/{dataset_id}/jobs":{"get":{"description":"Lists Logpush jobs for an account for a dataset.","operationId":"get-accounts-account_id-logpush-datasets-dataset_id-jobs","parameters":[{"example":"gateway_dns","in":"path","name":"dataset_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_dataset"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":[{"dataset":"gateway_dns","destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"error_message":null,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","id":1,"kind":"","last_complete":null,"last_error":null,"max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"name":"example.com","output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["Datetime","DstIP","SrcIP"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"}}],"success":true},"schema":{"$ref":"#/components/schemas/logpush_logpush_job_response_collection"}}},"description":"List Logpush jobs for a dataset response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"List Logpush jobs for a dataset response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Logpush jobs for a dataset","tags":["Logpush jobs for an account"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/logpush/jobs":{"get":{"description":"Lists Logpush jobs for an account.","operationId":"get-accounts-account_id-logpush-jobs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":[{"dataset":"gateway_dns","destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"error_message":null,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","id":1,"kind":"","last_complete":null,"last_error":null,"max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"name":"example.com","output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["Datetime","DstIP","SrcIP"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"}}],"success":true},"schema":{"$ref":"#/components/schemas/logpush_logpush_job_response_collection"}}},"description":"List Logpush jobs response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"List Logpush jobs response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Logpush jobs","tags":["Logpush jobs for an account"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new Logpush job for an account.","operationId":"post-accounts-account_id-logpush-jobs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"example":{"dataset":"gateway_dns","destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","kind":"","max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"name":"example.com","output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["Datetime","DstIP","SrcIP"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"},"ownership_challenge":"00000000000000000000"},"schema":{"properties":{"dataset":{"$ref":"#/components/schemas/logpush_dataset"},"destination_conf":{"$ref":"#/components/schemas/logpush_destination_conf"},"enabled":{"$ref":"#/components/schemas/logpush_enabled"},"filter":{"$ref":"#/components/schemas/logpush_filter"},"frequency":{"$ref":"#/components/schemas/logpush_frequency"},"kind":{"$ref":"#/components/schemas/logpush_kind"},"logpull_options":{"$ref":"#/components/schemas/logpush_logpull_options"},"max_upload_bytes":{"$ref":"#/components/schemas/logpush_max_upload_bytes"},"max_upload_interval_seconds":{"$ref":"#/components/schemas/logpush_max_upload_interval_seconds"},"max_upload_records":{"$ref":"#/components/schemas/logpush_max_upload_records"},"name":{"$ref":"#/components/schemas/logpush_name"},"output_options":{"$ref":"#/components/schemas/logpush_output_options"},"ownership_challenge":{"$ref":"#/components/schemas/logpush_ownership_challenge"}},"required":["destination_conf"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"dataset":"gateway_dns","destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"error_message":null,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","id":1,"kind":"","last_complete":null,"last_error":null,"max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"name":"example.com","output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["Datetime","DstIP","SrcIP"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"}},"success":true},"schema":{"$ref":"#/components/schemas/logpush_logpush_job_response_single"}}},"description":"Create Logpush job response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Create Logpush job response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Logpush job","tags":["Logpush jobs for an account"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/logpush/jobs/{job_id}":{"delete":{"description":"Deletes a Logpush job.","operationId":"delete-accounts-account_id-logpush-jobs-job_id","parameters":[{"in":"path","name":"job_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/logpush_id"}},"type":"object"}},"type":"object"}]}}},"description":"Delete Logpush job response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Delete Logpush job response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Logpush job","tags":["Logpush jobs for an account"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Gets the details of a Logpush job.","operationId":"get-accounts-account_id-logpush-jobs-job_id","parameters":[{"in":"path","name":"job_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"dataset":"gateway_dns","destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"error_message":null,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","id":1,"kind":"","last_complete":null,"last_error":null,"max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"name":"example.com","output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["Datetime","DstIP","SrcIP"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"}},"success":true},"schema":{"$ref":"#/components/schemas/logpush_logpush_job_response_single"}}},"description":"Get Logpush job details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Get Logpush job details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Logpush job details","tags":["Logpush jobs for an account"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a Logpush job.","operationId":"put-accounts-account_id-logpush-jobs-job_id","parameters":[{"in":"path","name":"job_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"example":{"destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","kind":"","max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["Datetime","DstIP","SrcIP"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"},"ownership_challenge":"00000000000000000000"},"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/logpush_destination_conf"},"enabled":{"$ref":"#/components/schemas/logpush_enabled"},"filter":{"$ref":"#/components/schemas/logpush_filter"},"frequency":{"$ref":"#/components/schemas/logpush_frequency"},"kind":{"$ref":"#/components/schemas/logpush_kind"},"logpull_options":{"$ref":"#/components/schemas/logpush_logpull_options"},"max_upload_bytes":{"$ref":"#/components/schemas/logpush_max_upload_bytes"},"max_upload_interval_seconds":{"$ref":"#/components/schemas/logpush_max_upload_interval_seconds"},"max_upload_records":{"$ref":"#/components/schemas/logpush_max_upload_records"},"name":{"$ref":"#/components/schemas/logpush_name"},"output_options":{"$ref":"#/components/schemas/logpush_output_options"},"ownership_challenge":{"$ref":"#/components/schemas/logpush_ownership_challenge"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"dataset":"gateway_dns","destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"error_message":null,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","id":1,"kind":"","last_complete":null,"last_error":null,"max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"name":"example.com","output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["Datetime","DstIP","SrcIP"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"}},"success":true},"schema":{"$ref":"#/components/schemas/logpush_logpush_job_response_single"}}},"description":"Update Logpush job response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Update Logpush job response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Logpush job","tags":["Logpush jobs for an account"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/logpush/ownership":{"post":{"description":"Gets a new ownership challenge sent to your destination.","operationId":"post-accounts-account_id-logpush-ownership","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/logpush_destination_conf"}},"required":["destination_conf"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_get_ownership_response"}}},"description":"Get ownership challenge response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Get ownership challenge response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get ownership challenge","tags":["Logpush jobs for an account"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/logpush/ownership/validate":{"post":{"description":"Validates ownership challenge of the destination.","operationId":"post-accounts-account_id-logpush-ownership-validate","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/logpush_destination_conf"},"ownership_challenge":{"$ref":"#/components/schemas/logpush_ownership_challenge"}},"required":["destination_conf","ownership_challenge"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_validate_ownership_response"}}},"description":"Validate ownership challenge response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Validate ownership challenge response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Validate ownership challenge","tags":["Logpush jobs for an account"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/logpush/validate/destination":{"post":{"description":"Validates destination.","operationId":"delete-accounts-account_id-logpush-validate-destination","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/logpush_destination_conf"}},"required":["destination_conf"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_validate_response"}}},"description":"Validate destination response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Validate destination response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Validate destination","tags":["Logpush jobs for an account"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/logpush/validate/destination/exists":{"post":{"description":"Checks if there is an existing job with a destination.","operationId":"delete-accounts-account_id-logpush-validate-destination-exists","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/logpush_destination_conf"}},"required":["destination_conf"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_destination_exists_response"}}},"description":"Check destination exists response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Check destination exists response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Check destination exists","tags":["Logpush jobs for an account"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/logpush/validate/origin":{"post":{"description":"Validates logpull origin with logpull_options.","operationId":"post-accounts-account_id-logpush-validate-origin","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"logpull_options":{"$ref":"#/components/schemas/logpush_logpull_options"}},"required":["logpull_options"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_validate_response"}}},"description":"Validate origin response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Validate origin response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Validate origin","tags":["Logpush jobs for an account"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/logs/audit":{"get":{"description":"Gets a list of audit logs for an account. \u003cbr /\u003e  \u003cbr /\u003e This is the beta release of Audit Logs Version 2. Since this is a beta version, there may be gaps or missing entries in the available audit logs. Be aware of the following limitations.  \u003cbr /\u003e \u003cul\u003e \u003cli\u003eAudit logs are available only for the past 30 days. \u003cbr /\u003e\u003c/li\u003e \u003cli\u003eError handling is not yet implemented.  \u003cbr /\u003e \u003c/li\u003e \u003c/ul\u003e","operationId":"audit-logs-v2-get-account-audit-logs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"description":"The unique id that identifies the account.","example":"a67e14daa5f8dceeb91fe5449ba496ef","type":"string"}},{"in":"query","name":"account_name","schema":{"description":"Filters by the account name.","items":{"type":"string"},"type":"array"}},{"in":"query","name":"action_result","schema":{"description":"Filters by whether the action was successful or not.","example":"success","items":{"enum":["success","failure"],"type":"string"},"type":"array"}},{"in":"query","name":"action_type","schema":{"description":"Filters by the action type.","items":{"enum":["create","delete","view","update"],"example":"create","type":"string"},"type":"array"}},{"in":"query","name":"actor_context","schema":{"description":"Filters by the actor context.","items":{"enum":["api_key","api_token","dash","oauth","origin_ca_key"],"example":"api_key","type":"string"},"type":"array"}},{"in":"query","name":"actor_email","schema":{"description":"Filters by the actor's email address.","items":{"example":"alice@example.com","format":"email","type":"string"},"type":"array"}},{"in":"query","name":"actor_id","schema":{"description":"Filters by the actor ID. This can be either the Account ID or User ID.","items":{"example":"1d20c3afe174f18b642710cec6298a9d","type":"string"},"type":"array"}},{"in":"query","name":"actor_ip_address","schema":{"description":"The IP address where the action was initiated.","items":{"example":"17.168.228.63","type":"string"},"type":"array"}},{"in":"query","name":"actor_token_id","schema":{"description":"Filters by the API token ID when the actor context is an api_token or oauth.","items":{"example":"144cdb2e39c55e203cf225d8d8208647","type":"string"},"type":"array"}},{"in":"query","name":"actor_token_name","schema":{"description":"Filters by the API token name when the actor context is an api_token or oauth.","items":{"example":"Test Token","type":"string"},"type":"array"}},{"in":"query","name":"actor_type","schema":{"description":"Filters by the actor type.","items":{"enum":["account","cloudflare_admin","system","user"],"example":"account","type":"string"},"type":"array"}},{"in":"query","name":"id","schema":{"description":"Finds a specific log by its ID.","items":{"example":"f174be97-19b1-40d6-954d-70cd5fbd52db","type":"string"},"type":"array"}},{"in":"query","name":"raw_cf_ray_id","schema":{"description":"Filters by the response CF Ray ID.","items":{"example":"8e8dd2156ef28414","type":"string"},"type":"array"}},{"in":"query","name":"raw_method","schema":{"description":"The HTTP method for the API call.","items":{"example":"GET","type":"string"},"type":"array"}},{"in":"query","name":"raw_status_code","schema":{"description":"The response status code that was returned.","items":{"example":200,"type":"integer"},"type":"array"}},{"in":"query","name":"raw_uri","schema":{"description":"Filters by the request URI.","items":{"type":"string"},"type":"array"}},{"in":"query","name":"resource_id","schema":{"description":"Filters by the resource ID.","items":{"type":"string"},"type":"array"}},{"in":"query","name":"resource_product","schema":{"description":"Filters audit logs by the Cloudflare product associated with the changed resource.","items":{"example":"Stream","type":"string"},"type":"array"}},{"in":"query","name":"resource_type","schema":{"description":"Filters audit logs based on the unique type of resource changed by the action.","items":{"example":"Video","type":"string"},"type":"array"}},{"in":"query","name":"resource_scope","schema":{"description":"Filters by the resource scope, specifying whether the resource is associated with an user, an account, or a zone.","items":{"enum":["accounts","user","zones","memberships"],"example":"accounts","type":"string"},"type":"array"}},{"in":"query","name":"zone_id","schema":{"description":"Filters by the zone ID.","items":{"type":"string"},"type":"array"}},{"in":"query","name":"zone_name","schema":{"description":"Filters by the zone name associated with the change.","items":{"example":"example.com","type":"string"},"type":"array"}},{"in":"query","name":"account_name.not","schema":{"description":"Filters out audit logs by the account name.","items":{"type":"string"},"type":"array"}},{"in":"query","name":"action_result.not","schema":{"description":"Filters out audit logs by whether the action was successful or not.","example":"success","items":{"enum":["success","failure"],"type":"string"},"type":"array"}},{"in":"query","name":"action_type.not","schema":{"description":"Filters out audit logs by the action type.","items":{"enum":["create","delete","view","update"],"example":"create","type":"string"},"type":"array"}},{"in":"query","name":"actor_context.not","schema":{"description":"Filters out audit logs by the actor context.","items":{"enum":["api_key","api_token","dash","oauth","origin_ca_key"],"example":"api_key","type":"string"},"type":"array"}},{"in":"query","name":"actor_email.not","schema":{"description":"Filters out audit logs by the actor's email address.","items":{"example":"alice@example.com","format":"email","type":"string"},"type":"array"}},{"in":"query","name":"actor_id.not","schema":{"description":"Filters out audit logs by the actor ID. This can be either the Account ID or User ID.","items":{"example":"1d20c3afe174f18b642710cec6298a9d","type":"string"},"type":"array"}},{"in":"query","name":"actor_ip_address.not","schema":{"description":"Filters out audit logs IP address where the action was initiated.","items":{"example":"17.168.228.63","type":"string"},"type":"array"}},{"in":"query","name":"actor_token_id.not","schema":{"description":"Filters out audit logs by the API token ID when the actor context is an api_token or oauth.","items":{"example":"144cdb2e39c55e203cf225d8d8208647","type":"string"},"type":"array"}},{"in":"query","name":"actor_token_name.not","schema":{"description":"Filters out audit logs by the API token name when the actor context is an api_token or oauth.","items":{"example":"Test Token","type":"string"},"type":"array"}},{"in":"query","name":"actor_type.not","schema":{"description":"Filters out audit logs by the actor type.","items":{"enum":["account","cloudflare_admin","system","user"],"example":"account","type":"string"},"type":"array"}},{"in":"query","name":"id.not","schema":{"description":"Filters out audit logs by their IDs.","items":{"example":"f174be97-19b1-40d6-954d-70cd5fbd52db","type":"string"},"type":"array"}},{"in":"query","name":"raw_cf_ray_id.not","schema":{"description":"Filters out audit logs by the response CF Ray ID.","items":{"example":"8e8dd2156ef28414","type":"string"},"type":"array"}},{"in":"query","name":"raw_method.not","schema":{"description":"Filters out audit logs by the HTTP method for the API call.","items":{"example":"GET","type":"string"},"type":"array"}},{"in":"query","name":"raw_status_code.not","schema":{"description":"Filters out audit logs by the response status code that was returned.","items":{"example":200,"type":"integer"},"type":"array"}},{"in":"query","name":"raw_uri.not","schema":{"description":"Filters out audit logs by the request URI.","items":{"type":"string"},"type":"array"}},{"in":"query","name":"resource_id.not","schema":{"description":"Filters out audit logs by the resource ID.","items":{"type":"string"},"type":"array"}},{"in":"query","name":"resource_product.not","schema":{"description":"Filters out audit logs by the Cloudflare product associated with the changed resource.","items":{"example":"Stream","type":"string"},"type":"array"}},{"in":"query","name":"resource_type.not","schema":{"description":"Filters out audit logs based on the unique type of resource changed by the action.","items":{"example":"Video","type":"string"},"type":"array"}},{"in":"query","name":"resource_scope.not","schema":{"description":"Filters out audit logs by the resource scope, specifying whether the resource is associated with an user, an account, or a zone.","items":{"enum":["accounts","user","zones"],"example":"accounts","type":"string"},"type":"array"}},{"in":"query","name":"zone_id.not","schema":{"description":"Filters out audit logs by the zone ID.","items":{"type":"string"},"type":"array"}},{"in":"query","name":"zone_name.not","schema":{"description":"Filters out audit logs by the zone name associated with the change.","items":{"example":"example.com","type":"string"},"type":"array"}},{"description":"Limits the returned results to logs newer than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339.","in":"query","name":"since","required":true,"schema":{"example":"2024-10-30","format":"date","type":"string"}},{"description":"Limits the returned results to logs older than the specified date. This can be a date string 2019-04-30 (interpreted in UTC) or an absolute timestamp that conforms to RFC3339.","in":"query","name":"before","required":true,"schema":{"example":"2024-10-31","format":"date","type":"string"}},{"in":"query","name":"direction","schema":{"default":"desc","description":"Sets sorting order.","enum":["desc","asc"],"example":"desc","type":"string"}},{"in":"query","name":"limit","schema":{"default":100,"description":"The number limits the objects to return. The cursor attribute may be used to iterate over the next batch of objects if there are more than the limit.","example":25,"maximum":1000,"minimum":1,"type":"number"}},{"in":"query","name":"cursor","schema":{"description":"The cursor is an opaque token used to paginate through large sets of records. It indicates the position from which to continue when requesting the next set of records. A valid cursor value can be obtained from the cursor object in the result_info structure of a previous response.","example":"Q1buH-__DQqqig7SVYXT-SsMOTGY2Z3Y80W-fGgva7yaDdmPKveucH5ddOcHsJRhNb-xUK8agZQqkJSMAENGO8NU6g==","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_audit-logs-v2-response-collection"}}},"description":"Get account audit logs successful response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_schemas-api-response-common-failure"}}},"description":"Get account audit logs failed response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get account audit logs (Version 2, Beta release)","tags":["Audit Logs"],"x-api-token-group":["Account Settings Write","Account Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/logs/control/cmb/config":{"delete":{"description":"Deletes CMB config.","operationId":"delete-accounts-account_id-logs-control-cmb-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logcontrol_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logcontrol_api-response-common"},{"properties":{"result":{"enum":[null],"nullable":true,"type":"object"}}}]}}},"description":"Delete CMB config response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logcontrol_api-response-common-failure"}]}}},"description":"Delete CMB config response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete CMB config","tags":["Logcontrol CMB config for an account"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]}},"get":{"description":"Gets CMB config.","operationId":"get-accounts-account_id-logs-control-cmb-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logcontrol_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logcontrol_cmb_config_response_single"}}},"description":"Get CMB config response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logcontrol_api-response-common-failure"}]}}},"description":"Get CMB config response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get CMB config","tags":["Logcontrol CMB config for an account"],"x-api-token-group":["Logs Write","Logs Read"],"x-cfPermissionsRequired":{"enum":["#logs:read","#analytics:read"]}},"post":{"description":"Updates CMB config.","operationId":"post-accounts-account_id-logs-control-cmb-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/logcontrol_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logcontrol_cmb_config"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logcontrol_cmb_config_response_single"}}},"description":"Update CMB config response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logcontrol_api-response-common-failure"}]}}},"description":"Update CMB config response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update CMB config","tags":["Logcontrol CMB config for an account"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]}}},"/accounts/{account_id}/magic/advanced_dns_protection/configs/dns_protection/rules":{"delete":{"description":"Delete all DNS Protection rules for an account.","operationId":"deleteDnsProtectionRulesForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete all DNS Protection rules response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete all DNS Protection rules.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"List all DNS Protection rules for an account.","operationId":"listDnsProtectionRulesForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The page number for pagination. Defaults to 1.","explode":false,"in":"query","name":"page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The number of items per page. Must be between 10 and 1000. Defaults to 25.","explode":false,"in":"query","name":"per_page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The field to order by. Defaults to 'prefix'.","explode":false,"in":"query","name":"order","schema":{"type":"string","x-auditable":true}},{"description":"The direction of ordering (ASC or DESC). Defaults to 'ASC'.","explode":false,"in":"query","name":"direction","schema":{"type":"string","x-auditable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_dns-protection-rule-list-response"}}},"description":"List all DNS Protection rules response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"List all DNS Protection rules failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List all DNS Protection rules.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"post":{"description":"Create a DNS Protection rule for an account.","operationId":"createDnsProtectionRule","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_NewDnsProtectionRule"}}},"description":"The new DNS Protection rule to add.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_dns-protection-rule-response"}}},"description":"Create DNS Protection rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Create DNS Protection rule failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Create DNS Protection rule.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_dns_protection/configs/dns_protection/rules/{rule_id}":{"delete":{"description":"Delete a DNS Protection rule specified by the given UUID.","operationId":"deleteDnsProtectionRule","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the DNS Protection rule to delete.","in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete DNS Protection rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete DNS Protection rule failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete DNS Protection rule.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"Get a DNS Protection rule specified by the given UUID.","operationId":"getDnsProtectionRule","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the DNS Protection rule.","in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_dns-protection-rule-response"}}},"description":"Get DNS Protection rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Get DNS Protection rule failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get DNS Protection rule.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"patch":{"description":"Update a DNS Protection rule specified by the given UUID.","operationId":"updateDnsProtectionRule","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the DNS Protection rule to update.","in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_DnsProtectionRuleUpdate"}}},"description":"The updates to apply to the DNS Protection rule.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_dns-protection-rule-response"}}},"description":"Update DNS Protection rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Update DNS Protection rule failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update DNS Protection rule.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist":{"delete":{"description":"Delete all allowlist prefixes for an account.","operationId":"deleteAllowlistPrefixesForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete all allowlist prefixes response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete all allowlist prefixes failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete all allowlist prefixes.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"List all allowlist prefixes for an account.","operationId":"listAllowlistPrefixesForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The page number for pagination. Defaults to 1.","explode":false,"in":"query","name":"page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The number of items per page. Must be between 10 and 1000. Defaults to 25.","explode":false,"in":"query","name":"per_page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The field to order by. Defaults to 'prefix'.","explode":false,"in":"query","name":"order","schema":{"type":"string"}},{"description":"The direction of ordering (ASC or DESC). Defaults to 'ASC'.","explode":false,"in":"query","name":"direction","schema":{"type":"string","x-auditable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_infra-prefix-list-response"}}},"description":"List all allowlist prefixes response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"List all allowlist prefixes failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List all allowlist prefixes.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"post":{"description":"Create an allowlist prefix for an account.","operationId":"createAllowlistedPrefix","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_NewInfraPrefix"}}},"description":"The new allowlist prefix to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_infra-prefix-response"}}},"description":"Create allowlist prefix response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Create allowlist prefix failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Create allowlist prefix.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/allowlist/{prefix_id}":{"delete":{"description":"Delete the allowlist prefix for an account given a UUID.","operationId":"deleteAllowlistPrefix","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the allowlist prefix to delete.","in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete allowlist prefix response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete allowlist prefix failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete allowlist prefix.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"Get an allowlist prefix specified by the given UUID.","operationId":"getAllowlistPrefix","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the allowlist prefix.","in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_infra-prefix-response"}}},"description":"Get allowlist prefix response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Get allowlist prefix failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get allowlist prefix.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"patch":{"description":"Update an allowlist prefix specified by the given UUID.","operationId":"updateAllowlistPrefix","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the allowlist prefix to update.","in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_InfraPrefixUpdate"}}},"description":"The updates to apply to the allowlist prefix.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_infra-prefix-response"}}},"description":"Update allowlist prefix response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Update allowlist prefix failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update allowlist prefix.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes":{"delete":{"description":"Delete all prefixes for an account.","operationId":"deletePrefixesForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete all prefixes response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete all prefixes failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete all prefixes.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"List all prefixes for an account.","operationId":"listPrefixesForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The page number for pagination. Defaults to 1.","explode":false,"in":"query","name":"page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The number of items per page. Must be between 10 and 1000. Defaults to 25.","explode":false,"in":"query","name":"per_page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The field to order by. Defaults to 'prefix'.","explode":false,"in":"query","name":"order","schema":{"type":"string","x-auditable":true}},{"description":"The direction of ordering (ASC or DESC). Defaults to 'ASC'.","explode":false,"in":"query","name":"direction","schema":{"type":"string","x-auditable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_prefix-list-response"}}},"description":"List all prefixes response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"List all allowlist prefixes failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List all prefixes.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"post":{"description":"Create a prefix for an account.","operationId":"createPrefix","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_NewPrefix"}}},"description":"The new prefix to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_prefix-response"}}},"description":"Create prefix response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Create prefix failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Create prefix.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/bulk":{"post":{"description":"Create multiple prefixes for an account.","operationId":"bulkCreatePrefixes","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/dos_NewPrefix"},"type":"array"}}},"description":"The list of new prefixes to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_prefix-list-response"}}},"description":"Create multiple prefixes response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Create multiple prefixes failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Create multiple prefixes.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/prefixes/{prefix_id}":{"delete":{"description":"Delete the prefix for an account given a UUID.","operationId":"deletePrefix","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the prefix to delete.","in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete prefix response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete prefix failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete prefix.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"Get a prefix specified by the given UUID.","operationId":"getPrefix","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the prefix.","in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_prefix-response"}}},"description":"Get prefix response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Get prefix failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get prefix.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"patch":{"description":"Update a prefix specified by the given UUID.","operationId":"updatePrefix","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the prefix to update.","in":"path","name":"prefix_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_PrefixUpdate"}}},"description":"The updates to apply to the prefix.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_prefix-response"}}},"description":"Update prefix response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Update prefix failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update prefix.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters":{"delete":{"description":"Delete all SYN Protection filters for an account.","operationId":"deleteSynProtectionFiltersForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete all SYN Protection filters response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete all SYN Protection filters failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete all SYN Protection filters.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"List all SYN Protection filters for an account.","operationId":"listSynProtectionFiltersForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The mode of the filters to get. Optional. Valid values: 'enabled', 'disabled', 'monitoring'.","explode":false,"in":"query","name":"mode","schema":{"type":"string","x-auditable":true}},{"description":"The page number for pagination. Defaults to 1.","explode":false,"in":"query","name":"page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The number of items per page. Must be between 10 and 1000. Defaults to 25.","explode":false,"in":"query","name":"per_page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The field to order by. Defaults to 'prefix'.","explode":false,"in":"query","name":"order","schema":{"type":"string","x-auditable":true}},{"description":"The direction of ordering (ASC or DESC). Defaults to 'ASC'.","explode":false,"in":"query","name":"direction","schema":{"type":"string","x-auditable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_expression-filter-list-response"}}},"description":"List all SYN Protection filters response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"List all SYN Protection filters failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List all SYN Protection filters.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"post":{"description":"Create a SYN Protection filter for an account.","operationId":"createSynProtectionFilter","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_NewExpressionFilter"}}},"description":"The new filter to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_expression-filter-response"}}},"description":"Create SYN Protection filter response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Create SYN Protection filter failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Create a SYN Protection filter.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/filters/{filter_id}":{"delete":{"description":"Delete a SYN Protection filter specified by the given UUID.","operationId":"deleteSynProtectionFilter","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the filter to delete.","in":"path","name":"filter_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete SYN Protection filter response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete SYN Protection filter failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete SYN Protection filter.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"Get a SYN Protection filter specified by the given UUID.","operationId":"getSynProtectionFilter","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the filter to retrieve.","in":"path","name":"filter_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_expression-filter-response"}}},"description":"Get SYN Protection filter response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Get SYN Protection filter failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get SYN Protection filter.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"patch":{"description":"Update a SYN Protection filter specified by the given UUID.","operationId":"updateSynProtectionFilter","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the filter to update.","in":"path","name":"filter_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_ExpressionFilterUpdate"}}},"description":"The updates to apply to the filter.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_expression-filter-response"}}},"description":"Update SYN Protection filter response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Update SYN Protection filter failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update SYN Protection filter.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules":{"delete":{"description":"Delete all SYN Protection rules for an account.","operationId":"deleteSynProtectionRulesForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete all SYN Protection rules response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete all SYN Protection rules failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete all SYN Protection rules.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"List all SYN Protection rules for an account.","operationId":"listSynProtectionRulesForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The page number for pagination. Defaults to 1.","explode":false,"in":"query","name":"page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The number of items per page. Must be between 10 and 1000. Defaults to 25.","explode":false,"in":"query","name":"per_page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The field to order by. Defaults to 'prefix'.","explode":false,"in":"query","name":"order","schema":{"type":"string","x-auditable":true}},{"description":"The direction of ordering (ASC or DESC). Defaults to 'ASC'.","explode":false,"in":"query","name":"direction","schema":{"type":"string","x-auditable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_syn-protection-rule-list-response"}}},"description":"List all SYN Protection rules response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"List all SYN Protection rules failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List all SYN Protection rules.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"post":{"description":"Create a SYN Protection rule for an account.","operationId":"createSynProtectionRule","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_NewSynProtectionRule"}}},"description":"The new SYN Protection rule to add.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_syn-protection-rule-response"}}},"description":"Create SYN Protection rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Create SYN Protection rule failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Create SYN Protection rule.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules/{rule_id}":{"delete":{"description":"Delete a SYN Protection rule specified by the given UUID.","operationId":"deleteSynProtectionRule","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the SYN Protection rule to delete.","in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete SYN Protection rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete SYN Protection rule failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete SYN Protection rule.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"Get a SYN Protection rule specified by the given UUID.","operationId":"getSynProtectionRule","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the SYN Protection rule.","in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_syn-protection-rule-response"}}},"description":"Get SYN Protection rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Get SYN Protection rule failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get SYN Protection rule.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"patch":{"description":"Update a SYN Protection rule specified by the given UUID.","operationId":"updateSynProtectionRule","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the SYN Protection rule to update.","in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_SynProtectionRuleUpdate"}}},"description":"The fields to update on the SYN Protection rule.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_syn-protection-rule-response"}}},"description":"Update SYN Protection rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Update SYN Protection rule failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update SYN Protection rule.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters":{"delete":{"description":"Delete all TCP Flow Protection filters for an account.","operationId":"deleteTcpFlowProtectionFiltersForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete all TCP Flow Protection filters response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete all TCP Flow Protection filters failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete all TCP Flow Protection filters.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"List all TCP Flow Protection filters for an account.","operationId":"listTcpFlowProtectionFiltersForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The mode of the filters to get. Optional. Valid values: 'enabled', 'disabled', 'monitoring'.","explode":false,"in":"query","name":"mode","schema":{"type":"string","x-auditable":true}},{"description":"The page number for pagination. Defaults to 1.","explode":false,"in":"query","name":"page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The number of items per page. Must be between 10 and 1000. Defaults to 25.","explode":false,"in":"query","name":"per_page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The field to order by. Defaults to 'prefix'.","explode":false,"in":"query","name":"order","schema":{"type":"string","x-auditable":true}},{"description":"The direction of ordering (ASC or DESC). Defaults to 'ASC'.","explode":false,"in":"query","name":"direction","schema":{"type":"string","x-auditable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_expression-filter-list-response"}}},"description":"List all TCP Flow Protection filters response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"List all TCP Flow Protection filters failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List all TCP Flow Protection filters.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"post":{"description":"Create a TCP Flow Protection filter for an account.","operationId":"createTcpFlowProtectionFilter","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_NewExpressionFilter"}}},"description":"The new filter to create.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_expression-filter-response"}}},"description":"Create TCP Flow Protection filter response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Create TCP Flow Protection filter failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Create a TCP Flow Protection filter.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters/{filter_id}":{"delete":{"description":"Delete a TCP Flow Protection filter specified by the given UUID.","operationId":"deleteTcpFlowProtectionFilter","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the filter to delete.","in":"path","name":"filter_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete TCP Flow Protection filter response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete TCP Flow Protection filter failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete TCP Flow Protection filter.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"Get a TCP Flow Protection filter specified by the given UUID.","operationId":"getTcpFlowProtectionFilter","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the filter to retrieve.","in":"path","name":"filter_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_expression-filter-response"}}},"description":"Get TCP Flow Protection filter response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Get TCP Flow Protection filter failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get TCP Flow Protection filter.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"patch":{"description":"Update a TCP Flow Protection filter specified by the given UUID.","operationId":"updateTcpFlowProtectionFilter","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the filter to update.","in":"path","name":"filter_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_ExpressionFilterUpdate"}}},"description":"The updates to apply to the filter.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_expression-filter-response"}}},"description":"Update TCP Flow Protection filter response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Update TCP Flow Protection filter failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update TCP Flow Protection filter.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules":{"delete":{"description":"Delete all TCP Flow Protection rules for an account.","operationId":"deleteTcpFlowProtectionRulesForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete all TCP Flow Protection rules response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete all TCP Flow Protection rules failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete all TCP Flow Protection rules.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"List all TCP Flow Protection rules for an account.","operationId":"listTcpFlowProtectionRulesForAccount","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The page number for pagination. Defaults to 1.","explode":false,"in":"query","name":"page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The number of items per page. Must be between 10 and 1000. Defaults to 25.","explode":false,"in":"query","name":"per_page","schema":{"format":"int64","type":"integer","x-auditable":true}},{"description":"The field to order by. Defaults to 'prefix'.","explode":false,"in":"query","name":"order","schema":{"type":"string","x-auditable":true}},{"description":"The direction of ordering (ASC or DESC). Defaults to 'ASC'.","explode":false,"in":"query","name":"direction","schema":{"type":"string","x-auditable":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_tcp-flow-protection-rule-list-response"}}},"description":"List all TCP Flow Protection rules response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"List all TCP Flow Protection rules failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List all TCP Flow Protection rules.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"post":{"description":"Create a TCP Flow Protection rule for an account.","operationId":"createTcpFlowProtectionRule","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_NewTcpFlowProtectionRule"}}},"description":"The new TCP Flow Protection rule.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_tcp-flow-protection-rule-response"}}},"description":"Create TCP Flow Protection rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Create TCP Flow Protection rule failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Create TCP Flow Protection rule.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/rules/{rule_id}":{"delete":{"description":"Delete a TCP Flow Protection rule specified by the given UUID.","operationId":"deleteTcpFlowProtectionRule","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the TCP Flow Protection rule to delete.","in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common"}}},"description":"Delete TCP Flow Protection rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Delete TCP Flow Protection rule failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete TCP Flow Protection rule.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]},"get":{"description":"Get a TCP Flow Protection rule specified by the given UUID.","operationId":"getTcpFlowProtectionRule","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the TCP Flow Protection rule.","in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_tcp-flow-protection-rule-response"}}},"description":"Get TCP Flow Protection rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Get TCP Flow Protection rule failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get TCP Flow Protection rule.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"patch":{"description":"Update a TCP Flow Protection rule specified by the given UUID.","operationId":"updateTcpFlowProtectionRule","parameters":[{"description":"The ID of the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}},{"description":"The UUID of the TCP Flow Protection rule to update.","in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/dos_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_TcpFlowProtectionRuleUpdate"}}},"description":"The updates to apply to the TCP Flow Protection rule.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_tcp-flow-protection-rule-response"}}},"description":"Update TCP Flow Protection rule response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Update TCP Flow Protection rule failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update TCP Flow Protection rule.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_protection_status":{"get":{"description":"Get the protection status of the account.","operationId":"getProtectionStatus","parameters":[{"description":"The account ID.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_protection-status-response"}}},"description":"Get protection status response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Get protection status failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get protection status.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write","DDoS Protection Read"]},"patch":{"description":"Update the protection status of the account.","operationId":"updateProtectionStatus","parameters":[{"description":"The account ID.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/dos_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_UpdateProtectionStatus"}}},"description":"The update to apply to the protection status.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_protection-status-response"}}},"description":"Update protection status response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dos_api-response-common-failure"}}},"description":"Update protection status failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update protection status.","tags":["dos-flowtrackd-api_other"],"x-api-token-group":["DDoS Protection Write"]}},"/accounts/{account_id}/magic/apps":{"get":{"description":"Lists Apps associated with an account.","operationId":"magic-account-apps-list-apps","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_apps_collection_response"}}},"description":"List Apps response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"List Apps response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Apps","tags":["Magic Account Apps"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new App for an account","operationId":"magic-account-apps-add-app","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_add_single_request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_single_response"}}},"description":"Create Account App response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Create Account App response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a new App","tags":["Magic Account Apps"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/apps/{account_app_id}":{"delete":{"description":"Deletes specific Account App.","operationId":"magic-account-apps-delete-app","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_app_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_single_response"}}},"description":"Delete App response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Delete App response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Account App","tags":["Magic Account Apps"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Updates an Account App","operationId":"magic-account-apps-patch-app","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_app_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_single_response"}}},"description":"Update App response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Update App response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an App","tags":["Magic Account Apps"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates an Account App","operationId":"magic-account-apps-update-app","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_app_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_single_response"}}},"description":"Update App response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Update App response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an App","tags":["Magic Account Apps"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/cf_interconnects":{"get":{"description":"Lists interconnects associated with an account.","operationId":"magic-interconnects-list-interconnects","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the response body will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_components-schemas-tunnels_collection_response"}}},"description":"List interconnects response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_components-schemas-tunnels_collection_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"List interconnects response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List interconnects","tags":["Magic Interconnects"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates multiple interconnects associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-interconnects-update-multiple-interconnects","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_components-schemas-modified_tunnels_collection_response"}}},"description":"Update multiple interconnects response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_components-schemas-modified_tunnels_collection_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Update multiple interconnects response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update multiple interconnects","tags":["Magic Interconnects"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id}":{"get":{"description":"Lists details for a specific interconnect.","operationId":"magic-interconnects-list-interconnect-details","parameters":[{"in":"path","name":"cf_interconnect_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the response body will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_components-schemas-tunnel_single_response"}}},"description":"List interconnect Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_components-schemas-tunnel_single_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"List interconnect Details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List interconnect Details","tags":["Magic Interconnects"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a specific interconnect associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-interconnects-update-interconnect","parameters":[{"in":"path","name":"cf_interconnect_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_interconnect_tunnel_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_components-schemas-tunnel_modified_response"}}},"description":"Update interconnect response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_components-schemas-tunnel_modified_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Update interconnect response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update interconnect","tags":["Magic Interconnects"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/cloud/catalog-syncs":{"get":{"description":"List Catalog Syncs (Closed Beta).","operationId":"catalog-syncs-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_read_account_catalog_syncs_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Catalog Syncs","tags":["Catalog Sync"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"]},"post":{"description":"Create a new Catalog Sync (Closed Beta).","operationId":"catalog-syncs-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"header","name":"forwarded","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_create_catalog_sync_request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_create_catalog_sync_response"}}},"description":"Created.","headers":{"location":{"description":"The path to the newly created list.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Unprocessable Entity."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Catalog Sync","tags":["Catalog Sync"],"x-api-token-group":["Magic WAN Write"]}},"/accounts/{account_id}/magic/cloud/catalog-syncs/prebuilt-policies":{"get":{"description":"List prebuilt catalog sync policies (Closed Beta).","operationId":"catalog-syncs-prebuilt-policies-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"description":"Specify type of destination, omit to return all.","in":"query","name":"destination_type","schema":{"$ref":"#/components/schemas/mcn_catalog_sync_destination_type"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_catalog_syncs_prebuilt_policies_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Prebuilt Policies","tags":["Catalog Sync"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"]}},"/accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}":{"delete":{"description":"Delete a Catalog Sync (Closed Beta).","operationId":"catalog-syncs-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"sync_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_catalog_sync_id"}},{"in":"query","name":"delete_destination","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_delete_catalog_sync_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Catalog Sync","tags":["Catalog Sync"],"x-api-token-group":["Magic WAN Write"]},"get":{"description":"Read a Catalog Sync (Closed Beta).","operationId":"catalog-syncs-read","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"sync_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_catalog_sync_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_read_account_catalog_sync_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Read Catalog Sync","tags":["Catalog Sync"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"]},"patch":{"description":"Update a Catalog Sync (Closed Beta).","operationId":"catalog-syncs-patch","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"sync_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_catalog_sync_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_catalog_sync_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_catalog_sync_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Unprocessable Entity."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Catalog Sync","tags":["Catalog Sync"],"x-api-token-group":["Magic WAN Write"]},"put":{"description":"Update a Catalog Sync (Closed Beta).","operationId":"catalog-syncs-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"sync_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_catalog_sync_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_catalog_sync_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_catalog_sync_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Unprocessable Entity."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Catalog Sync","tags":["Catalog Sync"],"x-api-token-group":["Magic WAN Write"]}},"/accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}/refresh":{"post":{"description":"Refresh a Catalog Sync's destination by running the sync policy against latest resource catalog (Closed Beta).","operationId":"catalog-syncs-refresh","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"sync_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_catalog_sync_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_refresh_catalog_sync_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Unprocessable Entity."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Run Catalog Sync","tags":["Catalog Sync"],"x-api-token-group":["Magic WAN Write"]}},"/accounts/{account_id}/magic/cloud/onramps":{"get":{"description":"List On-ramps (Closed Beta).","operationId":"onramps-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"description":"One of [\"updated_at\", \"id\", \"cloud_type\", \"name\"].","in":"query","name":"order_by","schema":{"type":"string"}},{"in":"query","name":"desc","schema":{"type":"boolean"}},{"in":"query","name":"status","schema":{"type":"boolean"}},{"in":"query","name":"vpcs","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_list_onramps_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List On-ramps","tags":["On-ramps"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"]},"post":{"description":"Create a new On-ramp (Closed Beta).","operationId":"onramps-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"header","name":"forwarded","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_create_onramp_request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_create_onramp_response"}}},"description":"Created.","headers":{"location":{"description":"The path to the newly created resource.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Unprocessable Entity."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create On-ramp","tags":["On-ramps"],"x-api-token-group":["Magic WAN Write"]}},"/accounts/{account_id}/magic/cloud/onramps/magic_wan_address_space":{"get":{"description":"Read the Magic WAN Address Space (Closed Beta).","operationId":"onramps-mwan-addr-space-read","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_get_magic_wan_address_space_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Read Magic WAN Address Space","tags":["On-ramps"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"]},"patch":{"description":"Update the Magic WAN Address Space (Closed Beta).","operationId":"onramps-mwan-addr-space-patch","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_magic_wan_address_space_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_magic_wan_address_space_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Unprocessable Entity."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Magic WAN Address Space","tags":["On-ramps"],"x-api-token-group":["Magic WAN Write"]},"put":{"description":"Update the Magic WAN Address Space (Closed Beta).","operationId":"onramps-mwan-addr-space-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_magic_wan_address_space_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_magic_wan_address_space_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Unprocessable Entity."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Magic WAN Address Space","tags":["On-ramps"],"x-api-token-group":["Magic WAN Write"]}},"/accounts/{account_id}/magic/cloud/onramps/{onramp_id}":{"delete":{"description":"Delete an On-ramp (Closed Beta).","operationId":"onramps-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"onramp_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_onramp_id"}},{"in":"query","name":"destroy","schema":{"type":"boolean"}},{"in":"query","name":"force","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_delete_onramp_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete On-ramp","tags":["On-ramps"],"x-api-token-group":["Magic WAN Write"]},"get":{"description":"Read an On-ramp (Closed Beta).","operationId":"onramps-read","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"onramp_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_onramp_id"}},{"in":"query","name":"status","schema":{"type":"boolean"}},{"in":"query","name":"vpcs","schema":{"type":"boolean"}},{"in":"query","name":"post_apply_resources","schema":{"type":"boolean"}},{"in":"query","name":"planned_resources","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_get_onramp_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Read On-ramp","tags":["On-ramps"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"]},"patch":{"description":"Update an On-ramp (Closed Beta).","operationId":"onramps-patch","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"onramp_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_onramp_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_onramp_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_onramp_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Unprocessable Entity."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch On-ramp","tags":["On-ramps"],"x-api-token-group":["Magic WAN Write"]},"put":{"description":"Update an On-ramp (Closed Beta).","operationId":"onramps-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"onramp_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_onramp_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_onramp_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_onramp_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Unprocessable Entity."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update On-ramp","tags":["On-ramps"],"x-api-token-group":["Magic WAN Write"]}},"/accounts/{account_id}/magic/cloud/onramps/{onramp_id}/apply":{"post":{"description":"Apply an On-ramp (Closed Beta).","operationId":"onramps-apply","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"onramp_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_onramp_id"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_good_response"}}},"description":"Accepted."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Apply On-ramp","tags":["On-ramps"],"x-api-token-group":["Magic WAN Write"]}},"/accounts/{account_id}/magic/cloud/onramps/{onramp_id}/export":{"post":{"description":"Export an On-ramp to terraform ready file(s) (Closed Beta).","operationId":"onramps-export","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"onramp_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_onramp_id"}}],"responses":{"201":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"Exported file.","headers":{"Content-Disposition":{"schema":{"example":"attachment; filename=\"exported-file.zip\"","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Export as Terraform","tags":["On-ramps"],"x-api-token-group":["Magic WAN Write"]}},"/accounts/{account_id}/magic/cloud/onramps/{onramp_id}/plan":{"post":{"description":"Plan an On-ramp (Closed Beta).","operationId":"onramps-plan","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"onramp_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_onramp_id"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_good_response"}}},"description":"Accepted."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Plan On-ramp","tags":["On-ramps"],"x-api-token-group":["Magic WAN Write"]}},"/accounts/{account_id}/magic/cloud/providers":{"get":{"description":"List Cloud Integrations (Closed Beta).","operationId":"providers-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"query","name":"status","schema":{"type":"boolean"}},{"description":"One of [\"updated_at\", \"id\", \"cloud_type\", \"name\"].","in":"query","name":"order_by","schema":{"type":"string"}},{"in":"query","name":"desc","schema":{"type":"boolean"}},{"in":"query","name":"cloudflare","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_read_account_providers_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Cloud Integrations","tags":["Cloud Integrations"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"]},"post":{"description":"Create a new Cloud Integration (Closed Beta).","operationId":"providers-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"header","name":"forwarded","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_create_provider_request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_create_provider_response"}}},"description":"Created.","headers":{"location":{"description":"The path to the newly created resource.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Unprocessable Entity."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Cloud Integration","tags":["Cloud Integrations"],"x-api-token-group":["Magic WAN Write"]}},"/accounts/{account_id}/magic/cloud/providers/discover":{"post":{"description":"Run discovery for all Cloud Integrations in an account (Closed Beta).","operationId":"providers-discover-all","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_good_response"}}},"description":"Accepted."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Run Discovery for All Integrations","tags":["Cloud Integrations"],"x-api-token-group":["Magic WAN Write"]}},"/accounts/{account_id}/magic/cloud/providers/{provider_id}":{"delete":{"description":"Delete a Cloud Integration (Closed Beta).","operationId":"providers-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"provider_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_provider_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_delete_provider_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Cloud Integration","tags":["Cloud Integrations"],"x-api-token-group":["Magic WAN Write"]},"get":{"description":"Read a Cloud Integration (Closed Beta).","operationId":"providers-read","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"provider_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_provider_id"}},{"in":"query","name":"status","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_read_account_provider_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Read Cloud Integration","tags":["Cloud Integrations"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"]},"patch":{"description":"Update a Cloud Integration (Closed Beta).","operationId":"providers-patch","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"provider_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_provider_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_provider_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_provider_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Unprocessable Entity."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Cloud Integration","tags":["Cloud Integrations"],"x-api-token-group":["Magic WAN Write"]},"put":{"description":"Update a Cloud Integration (Closed Beta).","operationId":"providers-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"provider_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_provider_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_provider_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_update_provider_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Unprocessable Entity."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Cloud Integration","tags":["Cloud Integrations"],"x-api-token-group":["Magic WAN Write"]}},"/accounts/{account_id}/magic/cloud/providers/{provider_id}/discover":{"post":{"description":"Run discovery for a Cloud Integration (Closed Beta).","operationId":"providers-discover","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"provider_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_provider_id"}},{"in":"query","name":"v2","schema":{"type":"boolean"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_good_response"}}},"description":"Accepted."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Conflict."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Run Discovery","tags":["Cloud Integrations"]}},"/accounts/{account_id}/magic/cloud/providers/{provider_id}/initial_setup":{"get":{"description":"Get initial configuration to complete Cloud Integration setup (Closed Beta).","operationId":"providers-initial-setup","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"provider_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_provider_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_provider_initial_setup_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Cloud Integration Setup Config","tags":["Cloud Integrations"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"]}},"/accounts/{account_id}/magic/cloud/resources":{"get":{"description":"List resources in the Resource Catalog (Closed Beta).","operationId":"resources-catalog-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"query","name":"provider_id","schema":{"type":"string"}},{"in":"query","name":"resource_type","schema":{"items":{"$ref":"#/components/schemas/mcn_resource_type"},"type":"array"}},{"in":"query","name":"resource_id","schema":{"items":{"$ref":"#/components/schemas/mcn_resource_id"},"type":"array"}},{"in":"query","name":"region","schema":{"type":"string"}},{"in":"query","name":"resource_group","schema":{"type":"string"}},{"in":"query","name":"managed","schema":{"type":"boolean"}},{"in":"query","name":"search","schema":{"items":{"type":"string"},"type":"array"}},{"description":"One of [\"id\", \"resource_type\", \"region\"].","in":"query","name":"order_by","schema":{"type":"string"}},{"in":"query","name":"desc","schema":{"type":"boolean"}},{"in":"query","name":"per_page","schema":{"minimum":1,"type":"integer"}},{"in":"query","name":"page","schema":{"minimum":1,"type":"integer"}},{"in":"query","name":"cloudflare","schema":{"type":"boolean"}},{"in":"query","name":"v2","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_read_account_resources_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Resources","tags":["Resources"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"]}},"/accounts/{account_id}/magic/cloud/resources/export":{"get":{"description":"Export resources in the Resource Catalog as a JSON file (Closed Beta).","operationId":"resources-catalog-export","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"query","name":"provider_id","schema":{"type":"string"}},{"in":"query","name":"resource_type","schema":{"items":{"$ref":"#/components/schemas/mcn_resource_type"},"type":"array"}},{"in":"query","name":"resource_id","schema":{"items":{"$ref":"#/components/schemas/mcn_resource_id"},"type":"array"}},{"in":"query","name":"region","schema":{"type":"string"}},{"in":"query","name":"resource_group","schema":{"type":"string"}},{"in":"query","name":"search","schema":{"items":{"type":"string"},"type":"array"}},{"description":"One of [\"id\", \"resource_type\", \"region\"].","in":"query","name":"order_by","schema":{"type":"string"}},{"in":"query","name":"desc","schema":{"type":"boolean"}},{"in":"query","name":"v2","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"Exported file.","headers":{"Content-Disposition":{"schema":{"example":"attachment; filename=\"exported_resources.zip\"","type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Export Resources","tags":["Resources"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"]}},"/accounts/{account_id}/magic/cloud/resources/policy-preview":{"post":{"description":"Preview Rego query result against the latest resource catalog (Closed Beta).","operationId":"resources-catalog-policy-preview","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_resources_catalog_policy_preview_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_resources_catalog_policy_preview_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Unprocessable Entity."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Preview Rego Query","tags":["Resources"]}},"/accounts/{account_id}/magic/cloud/resources/{resource_id}":{"get":{"description":"Read an resource from the Resource Catalog (Closed Beta).","operationId":"resources-catalog-read","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_account_id"}},{"in":"path","name":"resource_id","required":true,"schema":{"$ref":"#/components/schemas/mcn_resource_id"}},{"in":"query","name":"v2","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_read_account_resource_response"}}},"description":"OK."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Bad Request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Invalid Credentials."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Not Found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mcn_bad_response"}}},"description":"Internal Server Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Read Resource","tags":["Resources"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"]}},"/accounts/{account_id}/magic/connectors":{"get":{"operationId":"mconn-connector-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_connector_list_response"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Internal Server Error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Connectors","tags":["Magic Connectors"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"operationId":"mconn-connector-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_connector_create_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_connector_create_response"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Internal Server Error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Add a connector to your account","tags":["Magic Connectors"],"x-api-token-group":["Magic WAN Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/connectors/{connector_id}":{"delete":{"operationId":"mconn-connector-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_account_id"}},{"in":"path","name":"connector_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_connector_delete_response"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Internal Server Error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Remove a connector from your account","tags":["Magic Connectors"],"x-api-token-group":["Magic WAN Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"operationId":"mconn-connector-fetch","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_account_id"}},{"in":"path","name":"connector_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_uuid"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_connector_fetch_response"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Internal Server Error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Fetch Connector","tags":["Magic Connectors"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"operationId":"mconn-connector-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_account_id"}},{"in":"path","name":"connector_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_connector_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_connector_update_response"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Internal Server Error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Edit Connector to update specific properties or Re-provision License Key","tags":["Magic Connectors"],"x-api-token-group":["Magic WAN Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"operationId":"mconn-connector-replace","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_account_id"}},{"in":"path","name":"connector_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_connector_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_connector_update_response"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_bad_response"}}},"description":"Internal Server Error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Replace Connector or Re-provision License Key","tags":["Magic Connectors"],"x-api-token-group":["Magic WAN Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events":{"get":{"operationId":"mconn-connector-telemetry-events-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_account_id"}},{"in":"path","name":"connector_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"from","required":true,"schema":{"type":"number"}},{"in":"query","name":"to","required":true,"schema":{"type":"number"}},{"in":"query","name":"limit","schema":{"type":"number"}},{"in":"query","name":"cursor","schema":{"type":"string"}},{"description":"Filter by event kind","in":"query","name":"k","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_events_get_success"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Internal Server Error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Events","tags":["Magic Connectors"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events/latest":{"get":{"operationId":"mconn-connector-telemetry-events-listLatest","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_account_id"}},{"in":"path","name":"connector_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_events_get_latest_success"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Internal Server Error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get latest Events","tags":["Magic Connectors"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/events/{event_t}.{event_n}":{"get":{"operationId":"mconn-connector-telemetry-events-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_account_id"}},{"in":"path","name":"connector_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"event_t","required":true,"schema":{"type":"number"}},{"in":"path","name":"event_n","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_event_get_success"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Internal Server Error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Event","tags":["Magic Connectors"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots":{"get":{"operationId":"mconn-connector-telemetry-snapshots-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_account_id"}},{"in":"path","name":"connector_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"from","required":true,"schema":{"type":"number"}},{"in":"query","name":"to","required":true,"schema":{"type":"number"}},{"in":"query","name":"limit","schema":{"type":"number"}},{"in":"query","name":"cursor","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_snapshots_get_success"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Internal Server Error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Snapshots","tags":["Magic Connectors"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots/latest":{"get":{"operationId":"mconn-connector-telemetry-snapshots-listLatest","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_account_id"}},{"in":"path","name":"connector_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_snapshots_get_latest_success"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Internal Server Error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get latest Snapshots","tags":["Magic Connectors"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/connectors/{connector_id}/telemetry/snapshots/{snapshot_t}":{"get":{"operationId":"mconn-connector-telemetry-snapshots-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mconn_account_id"}},{"in":"path","name":"connector_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"snapshot_t","required":true,"schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_customer_snapshot_get_success"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Not Found"},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mconn_envelope"}}},"description":"Internal Server Error"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Snapshot","tags":["Magic Connectors"],"x-api-token-group":["Magic WAN Write","Magic WAN Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/gre_tunnels":{"get":{"description":"Lists GRE tunnels associated with an account.","operationId":"magic-gre-tunnels-list-gre-tunnels","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the response body will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_tunnels_collection_response"}}},"description":"List GRE tunnels response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_tunnels_collection_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"List GRE tunnels response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List GRE tunnels","tags":["Magic GRE tunnels"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-gre-tunnels-create-gre-tunnels","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_create_gre_tunnel_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_create_gre_tunnel_response"}}},"description":"Create GRE tunnels response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_tunnels_collection_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Create GRE tunnels response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a GRE tunnel","tags":["Magic GRE tunnels"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates multiple GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-gre-tunnels-update-multiple-gre-tunnels","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_modified_tunnels_collection_response"}}},"description":"Update multiple GRE tunnels response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_modified_tunnels_collection_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Update multiple GRE tunnels response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update multiple GRE tunnels","tags":["Magic GRE tunnels"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/gre_tunnels/{gre_tunnel_id}":{"delete":{"description":"Disables and removes a specific static GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-gre-tunnels-delete-gre-tunnel","parameters":[{"in":"path","name":"gre_tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the response body will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_tunnel_deleted_response"}}},"description":"Delete GRE Tunnel response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_tunnel_deleted_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Delete GRE Tunnel response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete GRE Tunnel","tags":["Magic GRE tunnels"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Lists informtion for a specific GRE tunnel.","operationId":"magic-gre-tunnels-list-gre-tunnel-details","parameters":[{"in":"path","name":"gre_tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the response body will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_tunnel_single_response"}}},"description":"List GRE Tunnel Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_tunnel_single_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"List GRE Tunnel Details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List GRE Tunnel Details","tags":["Magic GRE tunnels"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a specific GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-gre-tunnels-update-gre-tunnel","parameters":[{"in":"path","name":"gre_tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_gre_tunnel_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_tunnel_modified_response"}}},"description":"Update GRE Tunnel response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_tunnel_modified_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Update GRE Tunnel response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update GRE Tunnel","tags":["Magic GRE tunnels"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/ipsec_tunnels":{"get":{"description":"Lists IPsec tunnels associated with an account.","operationId":"magic-ipsec-tunnels-list-ipsec-tunnels","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the response body will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_schemas-tunnels_collection_response"}}},"description":"List IPsec tunnels response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_schemas-tunnels_collection_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"List IPsec tunnels response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List IPsec tunnels","tags":["Magic IPsec tunnels"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-ipsec-tunnels-create-ipsec-tunnels","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_ipsec_tunnel_add_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_schemas-create_ipsec_tunnel_response"}}},"description":"Create IPsec tunnels response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_schemas-create_ipsec_tunnel_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Create IPsec tunnels response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create an IPsec tunnel","tags":["Magic IPsec tunnels"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update multiple IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-ipsec-tunnels-update-multiple-ipsec-tunnels","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_schemas-modified_tunnels_collection_response"}}},"description":"Update multiple IPsec tunnels response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_schemas-modified_tunnels_collection_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Update multiple IPsec tunnels response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update multiple IPsec tunnels","tags":["Magic IPsec tunnels"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}":{"delete":{"description":"Disables and removes a specific static IPsec Tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-ipsec-tunnels-delete-ipsec-tunnel","parameters":[{"in":"path","name":"ipsec_tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the response body will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_schemas-tunnel_deleted_response"}}},"description":"Delete IPsec Tunnel response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_schemas-tunnel_deleted_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Delete IPsec Tunnel response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete IPsec Tunnel","tags":["Magic IPsec tunnels"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Lists details for a specific IPsec tunnel.","operationId":"magic-ipsec-tunnels-list-ipsec-tunnel-details","parameters":[{"in":"path","name":"ipsec_tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the response body will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_schemas-tunnel_single_response"}}},"description":"List IPsec tunnel details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_schemas-tunnel_single_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"List IPsec tunnel details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List IPsec tunnel details","tags":["Magic IPsec tunnels"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a specific IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-ipsec-tunnels-update-ipsec-tunnel","parameters":[{"in":"path","name":"ipsec_tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_ipsec_tunnel_add_single_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_schemas-tunnel_modified_response"}}},"description":"Update IPsec Tunnel response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_schemas-tunnel_modified_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Update IPsec Tunnel response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update IPsec Tunnel","tags":["Magic IPsec tunnels"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/ipsec_tunnels/{ipsec_tunnel_id}/psk_generate":{"post":{"description":"Generates a Pre Shared Key for a specific IPsec tunnel used in the IKE session. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. After a PSK is generated, the PSK is immediately persisted to Cloudflare's edge and cannot be retrieved later. Note the PSK in a safe place.","operationId":"magic-ipsec-tunnels-generate-pre-shared-key-(-psk)-for-ipsec-tunnels","parameters":[{"in":"path","name":"ipsec_tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_psk_generation_response"}}},"description":"Generate Pre Shared Key (PSK) for IPsec tunnels response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_psk_generation_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Generate Pre Shared Key (PSK) for IPsec tunnels response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Generate Pre Shared Key (PSK) for IPsec tunnels","tags":["Magic IPsec tunnels"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/routes":{"delete":{"description":"Delete multiple Magic static routes.","operationId":"magic-static-routes-delete-many-routes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_route_delete_many_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_multiple_route_delete_response"}}},"description":"Delete Many Routes response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_multiple_route_delete_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Delete Many Routes response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Many Routes","tags":["Magic Static Routes"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"List all Magic static routes.","operationId":"magic-static-routes-list-routes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_routes_collection_response"}}},"description":"List Routes response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_routes_collection_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"List Routes response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Routes","tags":["Magic Static Routes"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.","operationId":"magic-static-routes-create-routes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_create_route_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_create_route_response"}}},"description":"Create Routes response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_routes_collection_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Create Routes response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a Route","tags":["Magic Static Routes"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update multiple Magic static routes. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided.","operationId":"magic-static-routes-update-many-routes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_route_update_many_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_multiple_route_modified_response"}}},"description":"Update Many Routes response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_multiple_route_modified_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Update Many Routes response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Many Routes","tags":["Magic Static Routes"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/routes/{route_id}":{"delete":{"description":"Disable and remove a specific Magic static route.","operationId":"magic-static-routes-delete-route","parameters":[{"in":"path","name":"route_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_route_deleted_response"}}},"description":"Delete Route response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_route_deleted_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Delete Route response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Route","tags":["Magic Static Routes"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get a specific Magic static route.","operationId":"magic-static-routes-route-details","parameters":[{"in":"path","name":"route_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_route_single_response"}}},"description":"Route Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_route_single_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Route Details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Route Details","tags":["Magic Static Routes"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update a specific Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.","operationId":"magic-static-routes-update-route","parameters":[{"in":"path","name":"route_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_route_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_route_modified_response"}}},"description":"Update Route response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic_route_modified_response"},{"$ref":"#/components/schemas/magic_api-response-common-failure"}]}}},"description":"Update Route response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Route","tags":["Magic Static Routes"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/sites":{"get":{"description":"Lists Sites associated with an account. Use connectorid query param to return sites where connectorid matches either site.ConnectorID or site.SecondaryConnectorID.","operationId":"magic-sites-list-sites","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"query","name":"connectorid","schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_sites_collection_response"}}},"description":"List Sites response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"List Sites response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Sites","tags":["Magic Sites"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new Site","operationId":"magic-sites-create-site","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_sites_add_single_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_site_single_response"}}},"description":"Create Site response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Create Site response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a new Site","tags":["Magic Sites"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/sites/{site_id}":{"delete":{"description":"Remove a specific Site.","operationId":"magic-sites-delete-site","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_site_deleted_response"}}},"description":"Delete Site response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Delete Site response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Site","tags":["Magic Sites"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get a specific Site.","operationId":"magic-sites-site-details","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"description":"If true, the health check target in the response body will be presented using the new object format. Defaults to false.","in":"header","name":"x-magic-new-hc-target","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_site_single_response"}}},"description":"Site Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Site Details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Site Details","tags":["Magic Sites"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Patch a specific Site.","operationId":"magic-sites-patch-site","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_site_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_site_modified_response"}}},"description":"Patch Site response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Patch Site response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Site","tags":["Magic Sites"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update a specific Site.","operationId":"magic-sites-update-site","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_site_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_site_modified_response"}}},"description":"Update Site response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Update Site response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Site","tags":["Magic Sites"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/sites/{site_id}/acls":{"get":{"description":"Lists Site ACLs associated with an account.","operationId":"magic-site-acls-list-acls","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_acls_collection_response"}}},"description":"List Site ACLs response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"List Site ACLs response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Site ACLs","tags":["Magic Site ACLs"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new Site ACL.","operationId":"magic-site-acls-create-acl","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_acls_add_single_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_acl_single_response"}}},"description":"Create Site ACL response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Create Site ACL response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a new Site ACL","tags":["Magic Site ACLs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/sites/{site_id}/acls/{acl_id}":{"delete":{"description":"Remove a specific Site ACL.","operationId":"magic-site-acls-delete-acl","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"acl_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_acl_deleted_response"}}},"description":"Delete Site ACL response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Delete Site ACL response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Site ACL","tags":["Magic Site ACLs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get a specific Site ACL.","operationId":"magic-site-acls-acl-details","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"acl_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_acl_single_response"}}},"description":"Site ACL Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Site ACL Details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Site ACL Details","tags":["Magic Site ACLs"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Patch a specific Site ACL.","operationId":"magic-site-acls-patch-acl","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"acl_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_acl_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_acl_modified_response"}}},"description":"Patch Site ACL response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Patch Site ACL response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Site ACL","tags":["Magic Site ACLs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update a specific Site ACL.","operationId":"magic-site-acls-update-acl","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"acl_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_acl_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_acl_modified_response"}}},"description":"Update Site ACL response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Update Site ACL response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Site ACL","tags":["Magic Site ACLs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/sites/{site_id}/app_configs":{"get":{"description":"Lists App Configs associated with a site.","operationId":"magic-site-app-configs-list-app-configs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_configs_collection_response"}}},"description":"List App Configs response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"List App Configs response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List App Configs","tags":["Magic Site App Configs"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new App Config for a site","operationId":"magic-site-app-configs-add-app-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_config_add_single_request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_config_single_response"}}},"description":"Create Site App Config response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Create Site App Config response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a new App Config","tags":["Magic Site App Configs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/sites/{site_id}/app_configs/{app_config_id}":{"delete":{"description":"Deletes specific App Config associated with a site.","operationId":"magic-site-app-configs-delete-app-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"app_config_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_config_single_response"}}},"description":"Delete App Config response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Delete App Config response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete App Config","tags":["Magic Site App Configs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Updates an App Config for a site","operationId":"magic-site-app-configs-patch-app-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"app_config_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_config_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_config_single_response"}}},"description":"Update Site App Config response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Update Site App Config response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an App Config","tags":["Magic Site App Configs"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates an App Config for a site","operationId":"magic-site-app-configs-update-app-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"app_config_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_config_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_app_config_single_response"}}},"description":"Update Site App Config response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Update Site App Config response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an App Config","tags":["Magic Site App Configs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/sites/{site_id}/lans":{"get":{"description":"Lists Site LANs associated with an account.","operationId":"magic-site-lans-list-lans","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_lans_collection_response"}}},"description":"List Site LANs response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"List Site LANs response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Site LANs","tags":["Magic Site LANs"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new Site LAN. If the site is in high availability mode, static_addressing is required along with secondary and virtual address.","operationId":"magic-site-lans-create-lan","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_lans_add_single_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_lans_collection_response"}}},"description":"Create Site LAN response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Create Site LAN response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a new Site LAN","tags":["Magic Site LANs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/sites/{site_id}/lans/{lan_id}":{"delete":{"description":"Remove a specific Site LAN.","operationId":"magic-site-lans-delete-lan","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"lan_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_lan_deleted_response"}}},"description":"Delete Site LAN response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Delete Site LAN response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Site LAN","tags":["Magic Site LANs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get a specific Site LAN.","operationId":"magic-site-lans-lan-details","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"lan_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_lan_single_response"}}},"description":"Site LAN Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Site LAN Details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Site LAN Details","tags":["Magic Site LANs"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Patch a specific Site LAN.","operationId":"magic-site-lans-patch-lan","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"lan_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_lan_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_lan_modified_response"}}},"description":"Patch Site LAN response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Patch Site LAN response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Site LAN","tags":["Magic Site LANs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update a specific Site LAN.","operationId":"magic-site-lans-update-lan","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"lan_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_lan_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_lan_modified_response"}}},"description":"Update Site LAN response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Update Site LAN response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Site LAN","tags":["Magic Site LANs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/sites/{site_id}/netflow_config":{"delete":{"description":"Remove NetFlow configuration for a site.","operationId":"magic-site-netflow-config-delete-netflow-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_netflow_config_single_response"}}},"description":"Delete NetFlow Configuration response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Delete NetFlow Configuration response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete NetFlow Configuration","tags":["Magic Site NetFlow Config"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get NetFlow configuration for a site.","operationId":"magic-site-netflow-config-details","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_netflow_config_single_response"}}},"description":"Get NetFlow Configuration response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Get NetFlow Configuration response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"NetFlow Configuration Details","tags":["Magic Site NetFlow Config"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Updates NetFlow configuration for a site.","operationId":"magic-site-netflow-config-patch-netflow-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_netflow_config_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_netflow_config_single_response"}}},"description":"Update NetFlow Configuration response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Update NetFlow Configuration response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update NetFlow Configuration","tags":["Magic Site NetFlow Config"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a NetFlow configuration for a site.","operationId":"magic-site-netflow-config-create-netflow-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_netflow_config_request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_netflow_config_single_response"}}},"description":"Create NetFlow Configuration response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Create NetFlow Configuration response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create NetFlow Configuration","tags":["Magic Site NetFlow Config"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates NetFlow configuration for a site (partial update).","operationId":"magic-site-netflow-config-update-netflow-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_netflow_config_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_netflow_config_single_response"}}},"description":"Update NetFlow Configuration response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Update NetFlow Configuration response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update NetFlow Configuration","tags":["Magic Site NetFlow Config"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/sites/{site_id}/wans":{"get":{"description":"Lists Site WANs associated with an account.","operationId":"magic-site-wans-list-wans","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_wans_collection_response"}}},"description":"List Site WANs response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"List Site WANs response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Site WANs","tags":["Magic Site WANs"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new Site WAN.","operationId":"magic-site-wans-create-wan","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_wans_add_single_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_wans_collection_response"}}},"description":"Create Site WAN response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Create Site WAN response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a new Site WAN","tags":["Magic Site WANs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}":{"delete":{"description":"Remove a specific Site WAN.","operationId":"magic-site-wans-delete-wan","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"wan_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_wan_deleted_response"}}},"description":"Delete Site WAN response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Delete Site WAN response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Site WAN","tags":["Magic Site WANs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get a specific Site WAN.","operationId":"magic-site-wans-wan-details","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"wan_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_wan_single_response"}}},"description":"Site WAN Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Site WAN Details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Site WAN Details","tags":["Magic Site WANs"],"x-api-token-group":["Magic WAN Write","Magic WAN Read","Magic Transit Read","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Patch a specific Site WAN.","operationId":"magic-site-wans-patch-wan","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"wan_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_wan_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_wan_modified_response"}}},"description":"Patch Site WAN response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Patch Site WAN response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Site WAN","tags":["Magic Site WANs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update a specific Site WAN.","operationId":"magic-site-wans-update-wan","parameters":[{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}},{"in":"path","name":"wan_id","required":true,"schema":{"$ref":"#/components/schemas/magic_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_wan_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_wan_modified_response"}}},"description":"Update Site WAN response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic_api-response-common-failure"}}},"description":"Update Site WAN response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Site WAN","tags":["Magic Site WANs"],"x-api-token-group":["Magic WAN Write","Magic Transit Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/members":{"get":{"description":"List all members of an account.","operationId":"account-members-list-members","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"query","name":"order","schema":{"description":"Field to order results by.","enum":["user.first_name","user.last_name","user.email","status"],"example":"status"}},{"in":"query","name":"status","schema":{"description":"A member's status in the account.","enum":["accepted","pending","rejected"],"example":"accepted","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"direction","schema":{"description":"Direction to order results.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_collection_member_response_with_policies"}}},"description":"List Members response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"List Members response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Members","tags":["Account Members"],"x-api-token-group":["SCIM Provisioning","Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Add a user to the list of members for this account.","operationId":"account-members-add-member","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/iam_create-member-with-roles"},{"$ref":"#/components/schemas/iam_create-member-with-policies"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_member_response_with_policies"}}},"description":"Add Member response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Add Member response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Add Member","tags":["Account Members"],"x-api-token-group":["SCIM Provisioning","Account Settings Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/members/{member_id}":{"delete":{"description":"Remove a member from an account.","operationId":"account-members-remove-member","parameters":[{"in":"path","name":"member_id","required":true,"schema":{"$ref":"#/components/schemas/iam_membership_components-schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-single-id"}}},"description":"Remove Member response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Remove Member response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Remove Member","tags":["Account Members"],"x-api-token-group":["SCIM Provisioning","Account Settings Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get information about a specific member of an account.","operationId":"account-members-member-details","parameters":[{"in":"path","name":"member_id","required":true,"schema":{"$ref":"#/components/schemas/iam_membership_components-schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_member_response_with_policies"}}},"description":"Member Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Member Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Member Details","tags":["Account Members"],"x-api-token-group":["SCIM Provisioning","Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Modify an account member.","operationId":"account-members-update-member","parameters":[{"in":"path","name":"member_id","required":true,"schema":{"$ref":"#/components/schemas/iam_membership_components-schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/iam_update-member-with-roles"},{"$ref":"#/components/schemas/iam_update-member-with-policies"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_member_response_with_policies"}}},"description":"Update Member response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Update Member response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update Member","tags":["Account Members"],"x-api-token-group":["SCIM Provisioning","Account Settings Write"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/mnm/config":{"delete":{"description":"Delete an existing network monitoring configuration.","operationId":"magic-network-monitoring-configuration-delete-account-configuration","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_single_response"}}},"description":"Delete account configuration response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_single_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"Delete account configuration response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete account configuration","tags":["Magic Network Monitoring Configuration"],"x-api-token-group":["Magic Network Monitoring Admin"]},"get":{"description":"Lists default sampling, router IPs and warp devices for account.","operationId":"magic-network-monitoring-configuration-list-account-configuration","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_single_response"}}},"description":"List account configuration response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_single_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"List account configuration response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List account configuration","tags":["Magic Network Monitoring Configuration"],"x-api-token-group":["Magic Network Monitoring Admin","Magic Network Monitoring Config Write","Magic Network Monitoring Config Read"]},"patch":{"description":"Update fields in an existing network monitoring configuration.","operationId":"magic-network-monitoring-configuration-update-account-configuration-fields","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"default_sampling":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_default_sampling"},"name":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_name"},"router_ips":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_router_ips"},"warp_devices":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_warp_devices"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_single_response"}}},"description":"Update account configuration fields response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_single_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"Update account configuration fields response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update account configuration fields","tags":["Magic Network Monitoring Configuration"],"x-api-token-group":["Magic Network Monitoring Admin","Magic Network Monitoring Config Write"]},"post":{"description":"Create a new network monitoring configuration.","operationId":"magic-network-monitoring-configuration-create-account-configuration","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"default_sampling":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_default_sampling"},"name":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_name"},"router_ips":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_router_ips"},"warp_devices":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_warp_devices"}},"required":["name","default_sampling"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_single_response"}}},"description":"Create account configuration response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_single_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"Create account configuration response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create account configuration","tags":["Magic Network Monitoring Configuration"],"x-api-token-group":["Magic Network Monitoring Admin"]},"put":{"description":"Update an existing network monitoring configuration, requires the entire configuration to be updated at once.","operationId":"magic-network-monitoring-configuration-update-an-entire-account-configuration","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"default_sampling":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_default_sampling"},"name":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_name"},"router_ips":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_router_ips"},"warp_devices":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_warp_devices"}},"required":["name","default_sampling"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_single_response"}}},"description":"Update an entire account configuration response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_single_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"Update an entire account configuration response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update an entire account configuration","tags":["Magic Network Monitoring Configuration"],"x-api-token-group":["Magic Network Monitoring Admin","Magic Network Monitoring Config Write"]}},"/accounts/{account_id}/mnm/config/full":{"get":{"description":"Lists default sampling, router IPs, warp devices, and rules for account.","operationId":"magic-network-monitoring-configuration-list-rules-and-account-configuration","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_single_response"}}},"description":"List rules and account configuration response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_config_single_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"List rules and account configuration response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List rules and account configuration","tags":["Magic Network Monitoring Configuration"],"x-api-token-group":["Magic Network Monitoring Admin","Magic Network Monitoring Config Write","Magic Network Monitoring Config Read"]}},"/accounts/{account_id}/mnm/rules":{"get":{"description":"Lists network monitoring rules for account.","operationId":"magic-network-monitoring-rules-list-rules","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rules_collection_response"}}},"description":"List rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rules_collection_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"List rules response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List rules","tags":["Magic Network Monitoring Rules"],"x-api-token-group":["Magic Network Monitoring Admin","Magic Network Monitoring Config Write","Magic Network Monitoring Config Read"]},"post":{"description":"Create network monitoring rules for account. Currently only supports creating a single rule per API request.","operationId":"magic-network-monitoring-rules-create-rules","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"automatic_advertisement":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_automatic_advertisement"},"bandwidth":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_bandwidth_threshold"},"duration":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_duration"},"name":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_name"},"packet_threshold":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_packet_threshold"},"prefixes":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_ip_prefixes"}},"required":["duration","name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rules_single_response"}}},"description":"Create rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rules_single_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"Create rules response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create rules","tags":["Magic Network Monitoring Rules"],"x-api-token-group":["Magic Network Monitoring Admin"]},"put":{"description":"Update network monitoring rules for account.","operationId":"magic-network-monitoring-rules-update-rules","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"automatic_advertisement":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_automatic_advertisement"},"bandwidth":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_bandwidth_threshold"},"duration":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_duration"},"id":{"$ref":"#/components/schemas/magic-visibility-mnm_rule_identifier"},"name":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_name"},"packet_threshold":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_packet_threshold"},"prefixes":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_ip_prefixes"}},"required":["ID","duration","name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rules_single_response"}}},"description":"Update rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rules_single_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"Update rules response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update rules","tags":["Magic Network Monitoring Rules"],"x-api-token-group":["Magic Network Monitoring Admin","Magic Network Monitoring Config Write"]}},"/accounts/{account_id}/mnm/rules/{rule_id}":{"delete":{"description":"Delete a network monitoring rule for account.","operationId":"magic-network-monitoring-rules-delete-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_rule_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rules_single_response"}}},"description":"Delete rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rules_single_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"Delete rule response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete rule","tags":["Magic Network Monitoring Rules"],"x-api-token-group":["Magic Network Monitoring Admin"]},"get":{"description":"List a single network monitoring rule for account.","operationId":"magic-network-monitoring-rules-get-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_rule_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rules_single_response"}}},"description":"Get rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rules_single_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"Get rule response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get rule","tags":["Magic Network Monitoring Rules"],"x-api-token-group":["Magic Network Monitoring Admin","Magic Network Monitoring Config Write","Magic Network Monitoring Config Read"]},"patch":{"description":"Update a network monitoring rule for account.","operationId":"magic-network-monitoring-rules-update-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_rule_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"automatic_advertisement":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_automatic_advertisement"},"bandwidth":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_bandwidth_threshold"},"duration":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_duration"},"name":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_name"},"packet_threshold":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_packet_threshold"},"prefixes":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_ip_prefixes"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rules_single_response"}}},"description":"Update rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rules_single_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"Update rule response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update rule","tags":["Magic Network Monitoring Rules"],"x-api-token-group":["Magic Network Monitoring Admin","Magic Network Monitoring Config Write"]}},"/accounts/{account_id}/mnm/rules/{rule_id}/advertisement":{"patch":{"description":"Update advertisement for rule.","operationId":"magic-network-monitoring-rules-update-advertisement-for-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_rule_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_advertisement_single_response"}}},"description":"Update advertisement for rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_rule_advertisement_single_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"Update advertisement for rule response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update advertisement for rule","tags":["Magic Network Monitoring Rules"],"x-api-token-group":["Magic Network Monitoring Admin","Magic Network Monitoring Config Write"]}},"/accounts/{account_id}/mnm/vpc-flows/token":{"post":{"description":"Generate authentication token for VPC flow logs export.","operationId":"magic-network-monitoring-vpc-flows-generate-authentication-token","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_vpc_flows_single_response"}}},"description":"Generate authentication token for VPC flow logs export response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/magic-visibility-mnm_mnm_vpc_flows_single_response"},{"$ref":"#/components/schemas/magic-visibility-mnm_api-response-common-failure"}]}}},"description":"Generate authentication token for VPC flow logs export failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Generate authentication token for VPC flow logs export.","tags":["Magic Network Monitoring VPC Flow logs"],"x-api-token-group":["Magic Network Monitoring Admin"]}},"/accounts/{account_id}/move":{"post":{"description":"Move an account within an organization hierarchy or an account outside an organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)","operationId":"Accounts_moveAccounts","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_organization_id":{"type":"string"}},"required":["destination_organization_id"],"type":"object"}}},"description":"The destination organization ID is where the account is to be moved.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"$ref":"#/components/schemas/organizations-api_MoveAccountResponse"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Move account","tags":["Accounts"],"x-api-token-group":null}},"/accounts/{account_id}/mtls_certificates":{"get":{"description":"Lists all mTLS certificates.","operationId":"m-tls-certificate-management-list-m-tls-certificates","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection"}}},"description":"List mTLS certificates response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"List mTLS certificates response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List mTLS certificates","tags":["mTLS Certificate Management"],"x-api-token-group":["Account: SSL and Certificates Read","Account: SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Upload a certificate that you want to use with mTLS-enabled Cloudflare services.","operationId":"m-tls-certificate-management-upload-m-tls-certificate","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ca":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ca"},"certificates":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-certificates"},"name":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-name"},"private_key":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-private_key"}},"required":["certificates","ca"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_single_post"}}},"description":"Upload mTLS certificate response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_single_post"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Upload mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Upload mTLS certificate","tags":["mTLS Certificate Management"],"x-api-token-group":["Account: SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/mtls_certificates/{mtls_certificate_id}":{"delete":{"description":"Deletes the mTLS certificate unless the certificate is in use by one or more Cloudflare services.","operationId":"m-tls-certificate-management-delete-m-tls-certificate","parameters":[{"in":"path","name":"mtls_certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single"}}},"description":"Delete mTLS certificate response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Delete mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete mTLS certificate","tags":["mTLS Certificate Management"],"x-api-token-group":["Account: SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches a single mTLS certificate.","operationId":"m-tls-certificate-management-get-m-tls-certificate","parameters":[{"in":"path","name":"mtls_certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single"}}},"description":"Get mTLS certificate response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Get mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get mTLS certificate","tags":["mTLS Certificate Management"],"x-api-token-group":["Account: SSL and Certificates Read","Account: SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/mtls_certificates/{mtls_certificate_id}/associations":{"get":{"description":"Lists all active associations between the certificate and Cloudflare services.","operationId":"m-tls-certificate-management-list-m-tls-certificate-associations","parameters":[{"in":"path","name":"mtls_certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_association_response_collection"}}},"description":"List mTLS certificate associations response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_association_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"List mTLS certificate associations response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List mTLS certificate associations","tags":["mTLS Certificate Management"],"x-api-token-group":["Account: SSL and Certificates Read","Account: SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/organizations":{"get":{"description":"Retrieve a list of the organizations that \"contain\" this account or are\nmanaging it.\n\nThe returned list will be in order from \"root\" to \"leaf\", where the \"leaf\"\nwill be the organization that _immediately_ contains the specified\naccount.","operationId":"Accounts_listAccountOrganizations","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"items":{"$ref":"#/components/schemas/organizations-api_Organization"},"type":"array"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List account organizations","tags":["Accounts"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","DNS View Write","DNS View Read","SCIM Provisioning","Load Balancers Account Write","Load Balancers Account Read","Zero Trust: PII Read","DDoS Botnet Feed Write","DDoS Botnet Feed Read","Workers R2 Storage Write","Workers R2 Storage Read","DDoS Protection Write","DDoS Protection Read","Workers Tail Read","Workers KV Storage Write","Workers KV Storage Read","Workers Scripts Write","Workers Scripts Read","Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read","Account Firewall Access Rules Write","Account Firewall Access Rules Read","DNS Firewall Write","DNS Firewall Read","Billing Write","Billing Read","Account Settings Write","Account Settings Read"]}},"/accounts/{account_id}/pages/projects":{"get":{"description":"Fetch a list of all user projects.","operationId":"pages-project-get-projects","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}},{"in":"query","name":"page","schema":{"description":"Which page of projects to fetch.","example":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"description":"How many projects to return per page.","example":10,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/pages_project"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"Get projects response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Get projects response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get projects","tags":["Pages Project"],"x-api-token-group":["Pages Read","Pages Write"]},"post":{"description":"Create a new project.","operationId":"pages-project-create-project","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"build_config":{"description":"Configs for the project build process.","properties":{"build_caching":{"description":"Enable build caching for the project.","example":true,"type":"boolean","x-auditable":true},"build_command":{"description":"Command used to build project.","example":"npm run build","type":"string","x-auditable":true},"destination_dir":{"description":"Output directory of the build.","example":"build","type":"string","x-auditable":true},"root_dir":{"description":"Directory to run the command.","example":"/","type":"string","x-auditable":true},"web_analytics_tag":{"description":"The classifying tag for analytics.","example":"cee1c73f6e4743d0b5e6bb1a0bcaabcc","nullable":true,"type":"string","x-auditable":true},"web_analytics_token":{"description":"The auth token for analytics.","example":"021e1057c18547eca7b79f2516f06o7x","nullable":true,"type":"string","x-sensitive":true}},"type":"object"},"deployment_configs":{"description":"Configs for deployments in a project.","properties":{"preview":{"allOf":[{"$ref":"#/components/schemas/pages_deployment_config_values_request"}],"description":"Configs for preview deploys."},"production":{"allOf":[{"$ref":"#/components/schemas/pages_deployment_config_values_request"}],"description":"Configs for production deploys."}},"type":"object"},"name":{"description":"Name of the project.","example":"my-pages-app","type":"string","x-auditable":true},"production_branch":{"description":"Production branch of the project. Used to identify production deployments.","example":"main","type":"string","x-auditable":true},"source":{"description":"Configs for the project source control.","properties":{"config":{"properties":{"deployments_enabled":{"deprecated":true,"description":"Whether to enable automatic deployments when pushing to the source repository.\nWhen disabled, no deployments (production or preview) will be triggered automatically.\n","type":"boolean","x-auditable":true,"x-stainless-deprecation-message":"Use `production_deployments_enabled` and `preview_deployment_setting` for more granular control."},"owner":{"description":"The owner of the repository.","example":"my-org","type":"string","x-auditable":true},"owner_id":{"description":"The owner ID of the repository.","example":"12345678","type":"string","x-auditable":true},"path_excludes":{"description":"A list of paths that should be excluded from triggering a preview deployment. Wildcard syntax (`*`) is supported.","items":{"type":"string","x-auditable":true},"type":"array"},"path_includes":{"description":"A list of paths that should be watched to trigger a preview deployment. Wildcard syntax (`*`) is supported.","items":{"type":"string","x-auditable":true},"type":"array"},"pr_comments_enabled":{"description":"Whether to enable PR comments.","type":"boolean","x-auditable":true},"preview_branch_excludes":{"description":"A list of branches that should not trigger a preview deployment. Wildcard syntax (`*`) is supported. Must be used with `preview_deployment_setting` set to `custom`.","items":{"type":"string","x-auditable":true},"type":"array"},"preview_branch_includes":{"description":"A list of branches that should trigger a preview deployment. Wildcard syntax (`*`) is supported. Must be used with `preview_deployment_setting` set to `custom`.","items":{"type":"string","x-auditable":true},"type":"array"},"preview_deployment_setting":{"description":"Controls whether commits to preview branches trigger a preview deployment.","enum":["all","none","custom"],"type":"string","x-auditable":true},"production_branch":{"description":"The production branch of the repository.","example":"main","type":"string","x-auditable":true},"production_deployments_enabled":{"description":"Whether to trigger a production deployment on commits to the production branch.","type":"boolean","x-auditable":true},"repo_id":{"description":"The ID of the repository.","example":"12345678","type":"string","x-auditable":true},"repo_name":{"description":"The name of the repository.","example":"my-repo","type":"string","x-auditable":true}},"type":"object"},"type":{"description":"The source control management provider.","enum":["github","gitlab"],"example":"github","type":"string","x-auditable":true}},"required":["type","config"],"type":"object"}},"required":["name","production_branch"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/pages_project"}},"required":["result"],"type":"object"}]}}},"description":"Create project response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Create project response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create project","tags":["Pages Project"],"x-api-token-group":["Pages Write"]}},"/accounts/{account_id}/pages/projects/{project_name}":{"delete":{"description":"Delete a project by name.","operationId":"pages-project-delete-project","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"nullable":true,"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"Delete project response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Delete project response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete project","tags":["Pages Project"],"x-api-token-group":["Pages Write"]},"get":{"description":"Fetch a project by name.","operationId":"pages-project-get-project","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/pages_project"}},"required":["result"],"type":"object"}]}}},"description":"Get project response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Get project response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get project","tags":["Pages Project"],"x-api-token-group":["Pages Read","Pages Write"]},"patch":{"description":"Set new attributes for an existing project. Modify environment variables. To delete an environment variable, set the key to null.","operationId":"pages-project-update-project","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{"deployment_configs":{"production":{"compatibility_date":"2022-01-01","compatibility_flags":["url_standard"],"env_vars":{"NODE_VERSION":{"value":"22"},"delete_this_env_var":null,"secret_var":{"type":"secret_text","value":"A_CMS_API_TOKEN"}}}}},"properties":{"build_config":{"description":"Configs for the project build process.","properties":{"build_caching":{"description":"Enable build caching for the project.","example":true,"type":"boolean","x-auditable":true},"build_command":{"description":"Command used to build project.","example":"npm run build","type":"string","x-auditable":true},"destination_dir":{"description":"Output directory of the build.","example":"build","type":"string","x-auditable":true},"root_dir":{"description":"Directory to run the command.","example":"/","type":"string","x-auditable":true},"web_analytics_tag":{"description":"The classifying tag for analytics.","example":"cee1c73f6e4743d0b5e6bb1a0bcaabcc","nullable":true,"type":"string","x-auditable":true},"web_analytics_token":{"description":"The auth token for analytics.","example":"021e1057c18547eca7b79f2516f06o7x","nullable":true,"type":"string","x-sensitive":true}},"type":"object"},"deployment_configs":{"description":"Configs for deployments in a project.","properties":{"preview":{"allOf":[{"$ref":"#/components/schemas/pages_deployment_config_values_request"}],"description":"Configs for preview deploys."},"production":{"allOf":[{"$ref":"#/components/schemas/pages_deployment_config_values_request"}],"description":"Configs for production deploys."}},"type":"object"},"name":{"description":"Name of the project.","example":"my-pages-app","type":"string","x-auditable":true},"production_branch":{"description":"Production branch of the project. Used to identify production deployments.","example":"main","type":"string","x-auditable":true},"source":{"description":"Configs for the project source control.","properties":{"config":{"properties":{"deployments_enabled":{"deprecated":true,"description":"Whether to enable automatic deployments when pushing to the source repository.\nWhen disabled, no deployments (production or preview) will be triggered automatically.\n","type":"boolean","x-auditable":true,"x-stainless-deprecation-message":"Use `production_deployments_enabled` and `preview_deployment_setting` for more granular control."},"owner":{"description":"The owner of the repository.","example":"my-org","type":"string","x-auditable":true},"owner_id":{"description":"The owner ID of the repository.","example":"12345678","type":"string","x-auditable":true},"path_excludes":{"description":"A list of paths that should be excluded from triggering a preview deployment. Wildcard syntax (`*`) is supported.","items":{"type":"string","x-auditable":true},"type":"array"},"path_includes":{"description":"A list of paths that should be watched to trigger a preview deployment. Wildcard syntax (`*`) is supported.","items":{"type":"string","x-auditable":true},"type":"array"},"pr_comments_enabled":{"description":"Whether to enable PR comments.","type":"boolean","x-auditable":true},"preview_branch_excludes":{"description":"A list of branches that should not trigger a preview deployment. Wildcard syntax (`*`) is supported. Must be used with `preview_deployment_setting` set to `custom`.","items":{"type":"string","x-auditable":true},"type":"array"},"preview_branch_includes":{"description":"A list of branches that should trigger a preview deployment. Wildcard syntax (`*`) is supported. Must be used with `preview_deployment_setting` set to `custom`.","items":{"type":"string","x-auditable":true},"type":"array"},"preview_deployment_setting":{"description":"Controls whether commits to preview branches trigger a preview deployment.","enum":["all","none","custom"],"type":"string","x-auditable":true},"production_branch":{"description":"The production branch of the repository.","example":"main","type":"string","x-auditable":true},"production_deployments_enabled":{"description":"Whether to trigger a production deployment on commits to the production branch.","type":"boolean","x-auditable":true},"repo_id":{"description":"The ID of the repository.","example":"12345678","type":"string","x-auditable":true},"repo_name":{"description":"The name of the repository.","example":"my-repo","type":"string","x-auditable":true}},"type":"object"},"type":{"description":"The source control management provider.","enum":["github","gitlab"],"example":"github","type":"string","x-auditable":true}},"required":["type","config"],"type":"object"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/pages_project"}},"required":["result"],"type":"object"}]}}},"description":"Update project response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Update project response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update project","tags":["Pages Project"],"x-api-token-group":["Pages Write"]}},"/accounts/{account_id}/pages/projects/{project_name}/deployments":{"get":{"description":"Fetch a list of project deployments.","operationId":"pages-deployment-get-deployments","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}},{"in":"query","name":"env","schema":{"description":"What type of deployments to fetch.","enum":["production","preview"],"example":"preview","type":"string"}},{"in":"query","name":"page","schema":{"description":"Which page of deployments to fetch.","example":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"description":"How many deployments to return per page.","example":10,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/pages_deployment"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"Get deployments response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Get deployments response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get deployments","tags":["Pages Deployment"],"x-api-token-group":["Pages Read","Pages Write"]},"post":{"description":"Start a new deployment from production. The repository and account must have already been authorized on the Cloudflare Pages dashboard.","operationId":"pages-deployment-create-deployment","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"requestBody":{"content":{"multipart/form-data":{"encoding":{"_headers":{"contentType":"text/plain"},"_redirects":{"contentType":"text/plain"},"_routes.json":{"contentType":"application/json"},"_worker.bundle":{"contentType":"multipart/form-data"},"_worker.js":{"contentType":"application/javascript+module, text/javascript+module, application/javascript, text/javascript"},"functions-filepath-routing-config.json":{"contentType":"application/json"},"manifest":{"contentType":"application/json"}},"schema":{"properties":{"_headers":{"description":"Headers configuration file for the deployment.","format":"binary","type":"string"},"_redirects":{"description":"Redirects configuration file for the deployment.","format":"binary","type":"string"},"_routes.json":{"description":"Routes configuration file defining routing rules.","format":"binary","type":"string"},"_worker.bundle":{"description":"Worker bundle file in multipart/form-data format. Mutually exclusive with `_worker.js`.\nCannot specify both `_worker.js` and `_worker.bundle` in the same request.\nMaximum size: 25 MiB.\n","format":"binary","type":"string"},"_worker.js":{"description":"Worker JavaScript file. Mutually exclusive with `_worker.bundle`.\nCannot specify both `_worker.js` and `_worker.bundle` in the same request.\n","format":"binary","type":"string"},"branch":{"description":"The branch to build the new deployment from. The `HEAD` of the branch will be used. If omitted, the production branch will be used by default.","example":"staging","type":"string","x-auditable":true},"commit_dirty":{"description":"Boolean string indicating if the working directory has uncommitted changes.","enum":["true","false"],"example":"false","type":"string"},"commit_hash":{"description":"Git commit SHA associated with this deployment.","example":"a1b2c3d4e5f6","type":"string"},"commit_message":{"description":"Git commit message associated with this deployment.","example":"Update homepage","type":"string"},"functions-filepath-routing-config.json":{"description":"Functions routing configuration file.","format":"binary","type":"string"},"manifest":{"description":"JSON string containing a manifest of files to deploy. Maps file paths to their content hashes.\nRequired for direct upload deployments. Maximum 20,000 entries.\n","example":"{\"index.html\": \"abc123\", \"style.css\": \"def456\"}","type":"string"},"pages_build_output_dir":{"description":"The build output directory path.","example":"dist","type":"string"},"wrangler_config_hash":{"description":"Hash of the Wrangler configuration file used for this deployment.","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/pages_deployment"}},"required":["result"],"type":"object"}]}}},"description":"Create deployment response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Create deployment response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create deployment","tags":["Pages Deployment"],"x-api-token-group":["Pages Write"]}},"/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}":{"delete":{"description":"Delete a deployment.","operationId":"pages-deployment-delete-deployment","parameters":[{"in":"path","name":"deployment_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"nullable":true,"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"Delete deployment response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Delete deployment response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete deployment","tags":["Pages Deployment"],"x-api-token-group":["Pages Write"]},"get":{"description":"Fetch information about a deployment.","operationId":"pages-deployment-get-deployment-info","parameters":[{"in":"path","name":"deployment_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/pages_deployment"}},"required":["result"],"type":"object"}]}}},"description":"Get deployment info response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Get deployment info response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get deployment info","tags":["Pages Deployment"],"x-api-token-group":["Pages Read","Pages Write"]}},"/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/history/logs":{"get":{"description":"Fetch deployment logs for a project.","operationId":"pages-deployment-get-deployment-logs","parameters":[{"in":"path","name":"deployment_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/pages_deployment_log"}},"required":["result"],"type":"object"}]}}},"description":"Get deployment logs response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Get deployment logs response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get deployment logs","tags":["Pages Deployment"],"x-api-token-group":["Pages Read","Pages Write"]}},"/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/retry":{"post":{"description":"Retry a previous deployment.","operationId":"pages-deployment-retry-deployment","parameters":[{"in":"path","name":"deployment_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/pages_deployment"}},"required":["result"],"type":"object"}]}}},"description":"Retry deployment response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Retry deployment response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Retry deployment","tags":["Pages Deployment"],"x-api-token-group":["Pages Write"]}},"/accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/rollback":{"post":{"description":"Rollback the production deployment to a previous deployment. You can only rollback to succesful builds on production.","operationId":"pages-deployment-rollback-deployment","parameters":[{"in":"path","name":"deployment_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/pages_deployment"}},"required":["result"],"type":"object"}]}}},"description":"Rollback deployment response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Rollback deployment response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Rollback deployment","tags":["Pages Deployment"],"x-api-token-group":["Pages Write"]}},"/accounts/{account_id}/pages/projects/{project_name}/domains":{"get":{"description":"Fetch a list of all domains associated with a Pages project.","operationId":"pages-domains-get-domains","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/pages_domain"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"Get domains response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Get domains response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get domains","tags":["Pages Domains"],"x-api-token-group":["Pages Read","Pages Write"]},"post":{"description":"Add a new domain for the Pages project.","operationId":"pages-domains-add-domain","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/pages_domain_name"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/pages_domain"}},"required":["result"],"type":"object"}]}}},"description":"Add domain response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Add domain response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Add domain","tags":["Pages Domains"],"x-api-token-group":["Pages Write"]}},"/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}":{"delete":{"description":"Delete a Pages project's domain.","operationId":"pages-domains-delete-domain","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"$ref":"#/components/schemas/pages_domain_name"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"nullable":true,"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"Delete domain response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Delete domain response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete domain","tags":["Pages Domains"],"x-api-token-group":["Pages Write"]},"get":{"description":"Fetch a single domain.","operationId":"pages-domains-get-domain","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"$ref":"#/components/schemas/pages_domain_name"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/pages_domain"}},"required":["result"],"type":"object"}]}}},"description":"Get domain response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Get domain response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get domain","tags":["Pages Domains"],"x-api-token-group":["Pages Read","Pages Write"]},"patch":{"description":"Retry the validation status of a single domain.","operationId":"pages-domains-patch-domain","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"$ref":"#/components/schemas/pages_domain_name"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/pages_domain"}},"required":["result"],"type":"object"}]}}},"description":"Patch domain response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Patch domain response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch domain","tags":["Pages Domains"],"x-api-token-group":["Pages Write"]}},"/accounts/{account_id}/pages/projects/{project_name}/purge_build_cache":{"post":{"description":"Purge all cached build artifacts for a Pages project","operationId":"pages-purge-build-cache","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/pages_project_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pages_api-response-common"},{"properties":{"result":{"nullable":true,"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"Purge build cache response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pages_api-response-common-failure"}}},"description":"Purge build cache failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Purge build cache","tags":["Pages Build Cache"],"x-api-token-group":["Pages Write"]}},"/accounts/{account_id}/pay-per-crawl/crawler/stripe":{"delete":{"description":"Deletes the stripe config for a crawler.","operationId":"pay-per-crawl.crawlerDeleteStripeConfig","parameters":[{"description":"account id","in":"path","name":"account_id","required":true,"schema":{"type":"string"},"x-auditable":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiNoResultResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiErrorResponse"}}},"description":"Bad Request"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Deletes the stripe config for a crawler","tags":["ppc_stripe"],"x-api-token-group":["Account Settings Write"]},"get":{"description":"Gets the stripe config for a crawler.","operationId":"pay-per-crawl.crawlerGetStripeConfig","parameters":[{"description":"account id","in":"path","name":"account_id","required":true,"schema":{"type":"string"},"x-auditable":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_getStripeConfigResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiErrorResponse"}}},"description":"Bad Request"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Gets the stripe config for a crawler","tags":["ppc_stripe"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","DNS View Write","DNS View Read","SCIM Provisioning","Load Balancers Account Write","Load Balancers Account Read","Zero Trust: PII Read","DDoS Botnet Feed Write","DDoS Botnet Feed Read","Workers R2 Storage Write","Workers R2 Storage Read","DDoS Protection Write","DDoS Protection Read","Workers Tail Read","Workers KV Storage Write","Workers KV Storage Read","Workers Scripts Write","Workers Scripts Read","Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read","Account Firewall Access Rules Write","Account Firewall Access Rules Read","DNS Firewall Write","DNS Firewall Read","Billing Write","Billing Read","Account Settings Write","Account Settings Read"]},"post":{"description":"Creates the stripe config for a crawler.","operationId":"pay-per-crawl.crawlerCreateStripeConfig","parameters":[{"description":"account id","in":"path","name":"account_id","required":true,"schema":{"type":"string"},"x-auditable":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_createStripeConfigResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiErrorResponse"}}},"description":"Bad Request"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Creates the stripe config for a crawler","tags":["ppc_stripe"],"x-api-token-group":["Account Settings Write"]}},"/accounts/{account_id}/pay-per-crawl/publisher/stripe":{"delete":{"description":"Deletes the stripe config for a publisher.","operationId":"pay-per-crawl.publisherDeleteStripeConfig","parameters":[{"description":"account id","in":"path","name":"account_id","required":true,"schema":{"type":"string"},"x-auditable":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiNoResultResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiErrorResponse"}}},"description":"Bad Request"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Deletes the stripe config for a publisher","tags":["ppc_stripe"],"x-api-token-group":["Account Settings Write"]},"get":{"description":"Gets the stripe config for a publisher.","operationId":"pay-per-crawl.publisherGetStripeConfig","parameters":[{"description":"account id","in":"path","name":"account_id","required":true,"schema":{"type":"string"},"x-auditable":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_getStripeConfigResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiErrorResponse"}}},"description":"Bad Request"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Gets the stripe config for a publisher","tags":["ppc_stripe"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","DNS View Write","DNS View Read","SCIM Provisioning","Load Balancers Account Write","Load Balancers Account Read","Zero Trust: PII Read","DDoS Botnet Feed Write","DDoS Botnet Feed Read","Workers R2 Storage Write","Workers R2 Storage Read","DDoS Protection Write","DDoS Protection Read","Workers Tail Read","Workers KV Storage Write","Workers KV Storage Read","Workers Scripts Write","Workers Scripts Read","Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read","Account Firewall Access Rules Write","Account Firewall Access Rules Read","DNS Firewall Write","DNS Firewall Read","Billing Write","Billing Read","Account Settings Write","Account Settings Read"]},"post":{"description":"Creates the stripe config for a publisher.","operationId":"pay-per-crawl.publisherCreateStripeConfig","parameters":[{"description":"account id","in":"path","name":"account_id","required":true,"schema":{"type":"string"},"x-auditable":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_createStripeConfigResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiErrorResponse"}}},"description":"Bad Request"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Creates the stripe config for a publisher","tags":["ppc_stripe"],"x-api-token-group":["Account Settings Write"]}},"/accounts/{account_id}/pay-per-crawl/zones_can_be_enabled":{"patch":{"description":"Allows an account admin to set the can_be_enabled setting on a list of zones.","operationId":"pay-per-crawl.setZonesCanBeEnabled","parameters":[{"description":"account id","in":"path","name":"account_id","required":true,"schema":{"type":"string"},"x-auditable":true}],"requestBody":{"$ref":"#/components/requestBodies/pay-per-crawl_ZonesCanBeEnabledPayload"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiNoResultResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiErrorResponse"}}},"description":"Bad Request"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Set can_be_enabled setting on zones","tags":["ppc_config"],"x-api-token-group":["Account Settings Write"]}},"/accounts/{account_id}/pay-per-crawl/zones_can_be_enabled/query":{"post":{"description":"Provided a list of pay-per-crawl configured zones this method will return whether they can enable PPC or not.","operationId":"pay-per-crawl.queryZonesCanBeEnabled","parameters":[{"description":"account id","in":"path","name":"account_id","required":true,"schema":{"type":"string"},"x-auditable":true}],"requestBody":{"$ref":"#/components/requestBodies/pay-per-crawl_ZonesCanBeEnabledPayload"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_queryZonesCanBeEnabledResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiErrorResponse"}}},"description":"Bad Request"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Gets the can_be_enabled zone setting","tags":["ppc_config"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","DNS View Write","DNS View Read","SCIM Provisioning","Load Balancers Account Write","Load Balancers Account Read","Zero Trust: PII Read","DDoS Botnet Feed Write","DDoS Botnet Feed Read","Workers R2 Storage Write","Workers R2 Storage Read","DDoS Protection Write","DDoS Protection Read","Workers Tail Read","Workers KV Storage Write","Workers KV Storage Read","Workers Scripts Write","Workers Scripts Read","Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read","Account Firewall Access Rules Write","Account Firewall Access Rules Read","DNS Firewall Write","DNS Firewall Read","Billing Write","Billing Read","Account Settings Write","Account Settings Read"]}},"/accounts/{account_id}/pcaps":{"get":{"description":"Lists all packet capture requests for an account.","operationId":"magic-pcap-collection-list-packet-capture-requests","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_collection_response"}}},"description":"List packet capture requests response."},"default":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_collection_response"},{"$ref":"#/components/schemas/magic-visibility-pcaps_api-response-common-failure"}]}}},"description":"List packet capture requests response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List packet capture requests","tags":["Magic PCAP collection"],"x-api-token-group":["Magic Firewall Packet Captures - Write PCAPs API","Magic Firewall Packet Captures - Read PCAPs API"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create new PCAP request for account.","operationId":"magic-pcap-collection-create-pcap-request","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_request_pcap"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_single_response"}}},"description":"Create PCAP request response."},"default":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_single_response"},{"$ref":"#/components/schemas/magic-visibility-pcaps_api-response-common-failure"}]}}},"description":"Create PCAP request response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create PCAP request","tags":["Magic PCAP collection"],"x-api-token-group":["Magic Firewall Packet Captures - Write PCAPs API"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/pcaps/ownership":{"get":{"description":"List all buckets configured for use with PCAPs API.","operationId":"magic-pcap-collection-list-pca-ps-bucket-ownership","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_ownership_collection"}}},"description":"List PCAPs Bucket Ownership response."},"default":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_ownership_collection"},{"$ref":"#/components/schemas/magic-visibility-pcaps_api-response-common-failure"}]}}},"description":"List PCAPs Bucket Ownership response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List PCAPs Bucket Ownership","tags":["Magic PCAP collection"],"x-api-token-group":["Magic Firewall Packet Captures - Write PCAPs API","Magic Firewall Packet Captures - Read PCAPs API"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Adds an AWS or GCP bucket to use with full packet captures.","operationId":"magic-pcap-collection-add-buckets-for-full-packet-captures","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_ownership_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_ownership_single_response"}}},"description":"Add buckets for full packet captures response."},"default":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_ownership_single_response"},{"$ref":"#/components/schemas/magic-visibility-pcaps_api-response-common-failure"}]}}},"description":"Add buckets for full packet captures response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Add buckets for full packet captures","tags":["Magic PCAP collection"],"x-api-token-group":["Magic Firewall Packet Captures - Write PCAPs API"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/pcaps/ownership/validate":{"post":{"description":"Validates buckets added to the packet captures API.","operationId":"magic-pcap-collection-validate-buckets-for-full-packet-captures","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_ownership_validate_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_ownership_single_response"}}},"description":"Validate buckets for full packet captures response."},"default":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_ownership_single_response"},{"$ref":"#/components/schemas/magic-visibility-pcaps_api-response-common-failure"}]}}},"description":"Validate buckets for full packet captures response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Validate buckets for full packet captures","tags":["Magic PCAP collection"],"x-api-token-group":["Magic Firewall Packet Captures - Write PCAPs API"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/pcaps/ownership/{ownership_id}":{"delete":{"description":"Deletes buckets added to the packet captures API.","operationId":"magic-pcap-collection-delete-buckets-for-full-packet-captures","parameters":[{"in":"path","name":"ownership_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_identifier"}}],"responses":{"204":{"description":"Delete buckets for full packet captures response."},"default":{"content":{"application/json":{}},"description":"Delete buckets for full packet captures response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete buckets for full packet captures","tags":["Magic PCAP collection"],"x-api-token-group":["Magic Firewall Packet Captures - Write PCAPs API"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/pcaps/{pcap_id}":{"get":{"description":"Get information for a PCAP request by id.","operationId":"magic-pcap-collection-get-pcap-request","parameters":[{"in":"path","name":"pcap_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_single_response"}}},"description":"Get PCAP request response."},"default":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/magic-visibility-pcaps_pcaps_single_response"},{"$ref":"#/components/schemas/magic-visibility-pcaps_api-response-common-failure"}]}}},"description":"Get PCAP request response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get PCAP request","tags":["Magic PCAP collection"],"x-api-token-group":["Magic Firewall Packet Captures - Write PCAPs API","Magic Firewall Packet Captures - Read PCAPs API"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/pcaps/{pcap_id}/download":{"get":{"description":"Download PCAP information into a file. Response is a binary PCAP file.","operationId":"magic-pcap-collection-download-simple-pcap","parameters":[{"in":"path","name":"pcap_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_identifier"}}],"responses":{"200":{"content":{"application/vnd.tcpdump.pcap":{}},"description":"Download Simple PCAP response."},"default":{"content":{"application/json":{}},"description":"Download Simple PCAP response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Download Simple PCAP","tags":["Magic PCAP collection"],"x-api-token-group":["Magic Firewall Packet Captures - Write PCAPs API","Magic Firewall Packet Captures - Read PCAPs API"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/pcaps/{pcap_id}/stop":{"put":{"description":"Stop full PCAP.","operationId":"magic-pcap-collection-stop-full-pcap","parameters":[{"in":"path","name":"pcap_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_identifier"}}],"responses":{"204":{"description":"Stop full PCAP response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-visibility-pcaps_api-response-common-failure"}}},"description":"Stop full PCAP response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Stop full PCAP","tags":["Magic PCAP collection"],"x-api-token-group":["Magic Firewall Packet Captures - Write PCAPs API"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/pipelines":{"get":{"deprecated":true,"description":"[DEPRECATED] List, filter, and paginate pipelines in an account. Use the new /pipelines/v1/pipelines endpoint instead.","operationId":"getV4AccountsByAccount_idPipelines_deprecated","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"query","name":"search","schema":{"description":"Specifies the prefix of pipeline name to search.","type":"string"}},{"in":"query","name":"page","schema":{"default":"1","description":"Specifies which page to retrieve.","type":"string"}},{"in":"query","name":"per_page","schema":{"default":"25","description":"Specifies the number of pipelines per page.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result_info":{"properties":{"count":{"description":"Indicates the number of items on current page.","example":1,"type":"number"},"page":{"description":"Indicates the current page number.","example":0,"type":"number"},"per_page":{"description":"Indicates the number of items per page.","example":10,"type":"number"},"total_count":{"description":"Indicates the total number of items.","example":1,"type":"number"}},"required":["count","page","per_page","total_count"],"type":"object"},"results":{"items":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-pipeline"},"type":"array"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","results","result_info"],"type":"object"}}},"description":"[DEPRECATED] Lists the pipelines. Use /pipelines/v1/pipelines instead."},"4XX":{"content":{"application/json":{"schema":{"properties":{"errors":{"example":[],"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"results":{"nullable":true,"type":"object","x-stainless-empty-object":true},"success":{"allOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}],"example":false}},"required":["success","results","errors"],"type":"object"}}},"description":"Indicates the error trying to list pipelines."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"[DEPRECATED] List Pipelines","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write","Pipelines Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"post":{"deprecated":true,"description":"[DEPRECATED] Create a new pipeline. Use the new /pipelines/v1/pipelines endpoint instead.","operationId":"postV4AccountsByAccount_idPipelines_deprecated","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination":{"properties":{"batch":{"properties":{"max_bytes":{"default":100000000,"description":"Specifies rough maximum size of files.","maximum":100000000,"minimum":1000,"type":"integer"},"max_duration_s":{"default":300,"description":"Specifies duration to wait to aggregate batches files.","maximum":300,"minimum":0.25,"type":"number"},"max_rows":{"default":10000000,"description":"Specifies rough maximum number of rows per file.","maximum":10000000,"minimum":100,"type":"integer"}},"type":"object"},"compression":{"properties":{"type":{"default":"gzip","description":"Specifies the desired compression algorithm and format.","enum":["none","gzip","deflate"],"example":"gzip","type":"string"}},"type":"object"},"credentials":{"properties":{"access_key_id":{"description":"Specifies the R2 Bucket Access Key Id.","example":"\u003caccess key id\u003e","type":"string"},"endpoint":{"description":"Specifies the R2 Endpoint.","example":"https://123f8a8258064ed892a347f173372359.r2.cloudflarestorage.com","type":"string"},"secret_access_key":{"description":"Specifies the R2 Bucket Secret Access Key.","example":"\u003csecret key\u003e","type":"string"}},"required":["endpoint","access_key_id","secret_access_key"],"type":"object"},"format":{"description":"Specifies the format of data to deliver.","enum":["json"],"type":"string"},"path":{"example":{"bucket":"bucket","prefix":"base"},"properties":{"bucket":{"description":"Specifies the R2 Bucket to store files.","example":"bucket","type":"string"},"filename":{"allOf":[{"type":"string"},{"type":"string"}],"description":"Specifies the name pattern to for individual data files.","example":"${slug}${extension}"},"filepath":{"description":"Specifies the name pattern for directory.","example":"${date}/${hour}","type":"string"},"prefix":{"description":"Specifies the base directory within the bucket.","example":"base","type":"string"}},"required":["bucket"],"type":"object"},"type":{"description":"Specifies the type of destination.","enum":["r2"],"type":"string"}},"required":["type","format","batch","compression","path","credentials"],"type":"object"},"name":{"description":"Defines the name of the pipeline.","example":"sample_pipeline","maxLength":128,"minLength":1,"type":"string"},"source":{"items":{"discriminator":{"mapping":{"binding":"#/components/schemas/cloudflare-pipelines_workers_pipelines_binding_source","http":"#/components/schemas/cloudflare-pipelines_workers_pipelines_http_source"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_workers_pipelines_http_source"},{"$ref":"#/components/schemas/cloudflare-pipelines_workers_pipelines_binding_source"}]},"minItems":1,"type":"array"}},"required":["name","source","destination"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-pipeline"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result"],"type":"object"}}},"description":"[DEPRECATED] Indicates a successfully created pipeline. Use /pipelines/v1/pipelines instead."},"4XX":{"content":{"application/json":{"schema":{"properties":{"errors":{"example":[],"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"results":{"nullable":true,"type":"object","x-stainless-empty-object":true},"success":{"allOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}],"example":false}},"required":["success","results","errors"],"type":"object"}}},"description":"Indicates an error in creating a pipeline."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"[DEPRECATED] Create Pipeline","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/pipelines/v1/pipelines":{"get":{"description":"List/Filter Pipelines in Account.","operationId":"getV4AccountsByAccount_idPipelinesV1Pipelines","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"query","name":"page","schema":{"default":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"created_at":{"type":"string"},"id":{"description":"Indicates a unique identifier for this pipeline.","example":"01234567890123457689012345678901","type":"string"},"modified_at":{"type":"string"},"name":{"description":"Indicates the name of the Pipeline.","example":"my_pipeline","maxLength":128,"minLength":1,"type":"string"},"sql":{"description":"Specifies SQL for the Pipeline processing flow.","example":"insert into sink select * from source;","type":"string"},"status":{"description":"Indicates the current status of the Pipeline.","type":"string"}},"required":["id","name","created_at","modified_at","sql","status"],"type":"object"},"type":"array"},"result_info":{"properties":{"count":{"description":"Indicates the number of items on current page.","example":1,"type":"number"},"page":{"description":"Indicates the current page number.","example":0,"type":"number"},"per_page":{"description":"Indicates the number of items per page.","example":10,"type":"number"},"total_count":{"description":"Indicates the total number of items.","example":1,"type":"number"}},"required":["count","page","per_page","total_count"],"type":"object"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result","result_info"],"type":"object"}}},"description":"Indicates a successfully listed Pipelines."},"4XX":{"description":"Indicates an error in listing Pipelines."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Pipelines","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write","Pipelines Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"post":{"description":"Create a new Pipeline.","operationId":"postV4AccountsByAccount_idPipelinesV1Pipelines","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"Specifies the name of the Pipeline.","example":"my_pipeline","maxLength":128,"minLength":1,"type":"string"},"sql":{"description":"Specifies SQL for the Pipeline processing flow.","example":"insert into sink select * from source;","type":"string"}},"required":["name","sql"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"created_at":{"type":"string"},"id":{"description":"Indicates a unique identifier for this pipeline.","example":"01234567890123457689012345678901","type":"string"},"modified_at":{"type":"string"},"name":{"description":"Indicates the name of the Pipeline.","example":"my_pipeline","maxLength":128,"minLength":1,"type":"string"},"sql":{"description":"Specifies SQL for the Pipeline processing flow.","example":"insert into sink select * from source;","type":"string"},"status":{"description":"Indicates the current status of the Pipeline.","type":"string"}},"required":["id","name","created_at","modified_at","sql","status"],"type":"object"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result"],"type":"object"}}},"description":"Indicates a successfully created Pipeline."},"4XX":{"description":"Indicates an error in creating a Pipeline."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Pipeline","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/pipelines/v1/pipelines/{pipeline_id}":{"delete":{"description":"Delete Pipeline in Account.","operationId":"deleteV4AccountsByAccount_idPipelinesV1PipelinesByPipeline_id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"path","name":"pipeline_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-pipeline-id"}}],"responses":{"200":{"description":"Indicates a successfully deleted Pipeline."},"4XX":{"description":"Indicates an error in listing Pipelines."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Pipelines","tags":["workers_pipelines_other"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Get Pipelines Details.","operationId":"getV4AccountsByAccount_idPipelinesV1PipelinesByPipeline_id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"path","name":"pipeline_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-pipeline-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"created_at":{"type":"string"},"id":{"description":"Indicates a unique identifier for this pipeline.","example":"01234567890123457689012345678901","type":"string"},"modified_at":{"type":"string"},"name":{"description":"Indicates the name of the Pipeline.","example":"my_pipeline","maxLength":128,"minLength":1,"type":"string"},"sql":{"description":"Specifies SQL for the Pipeline processing flow.","example":"insert into sink select * from source;","type":"string"},"status":{"description":"Indicates the current status of the Pipeline.","type":"string"},"tables":{"description":"List of streams and sinks used by this pipeline.","items":{"properties":{"id":{"description":"Unique identifier for the connection (stream or sink).","example":"1c9200d5872c018bb34e93e2cd8a438e","type":"string"},"latest":{"description":"Latest available version of the connection.","example":5,"type":"integer"},"name":{"description":"Name of the connection.","example":"my_table","maxLength":128,"minLength":1,"type":"string"},"type":{"description":"Type of the connection.","enum":["stream","sink"],"example":"stream","type":"string"},"version":{"description":"Current version of the connection used by this pipeline.","example":4,"type":"integer"}},"required":["id","version","latest","type","name"],"type":"object"},"type":"array"}},"required":["id","name","created_at","modified_at","sql","status","tables"],"type":"object"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result"],"type":"object"}}},"description":"Indicates a successfully retrieved Pipeline."},"4XX":{"description":"Indicates an error in retrieving Pipelines."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Pipeline Details","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write","Pipelines Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/pipelines/v1/sinks":{"get":{"description":"List/Filter Sinks in Account.","operationId":"getV4AccountsByAccount_idPipelinesV1Sinks","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"query","name":"pipeline_id","schema":{"type":"string"}},{"in":"query","name":"page","schema":{"default":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"config":{"description":"Defines the configuration of the R2 Sink.","oneOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_r2Table"},{"$ref":"#/components/schemas/cloudflare-pipelines_r2_data_catalogTable"}]},"created_at":{"format":"date-time","type":"string"},"format":{"$ref":"#/components/schemas/cloudflare-pipelines_Format"},"id":{"description":"Indicates a unique identifier for this sink.","example":"01234567890123457689012345678901","type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"description":"Defines the name of the Sink.","example":"my_sink","maxLength":128,"minLength":1,"type":"string"},"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_ConnectionSchema"},"type":{"description":"Specifies the type of sink.","enum":["r2","r2_data_catalog"],"example":"r2","type":"string"}},"required":["id","name","created_at","modified_at","type"],"type":"object"},"type":"array"},"result_info":{"properties":{"count":{"description":"Indicates the number of items on current page.","example":1,"type":"number"},"page":{"description":"Indicates the current page number.","example":0,"type":"number"},"per_page":{"description":"Indicates the number of items per page.","example":10,"type":"number"},"total_count":{"description":"Indicates the total number of items.","example":1,"type":"number"}},"required":["count","page","per_page","total_count"],"type":"object"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result","result_info"],"type":"object"}}},"description":"Indicates successfully listed Sinks."},"4XX":{"description":"Indicates an error in listing Sinks."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Sinks","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write","Pipelines Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"post":{"description":"Create a new Sink.","operationId":"postV4AccountsByAccount_idPipelinesV1Sinks","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config":{"description":"Defines the configuration of the R2 Sink.","oneOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_r2Table"},{"$ref":"#/components/schemas/cloudflare-pipelines_r2_data_catalogTable"}]},"format":{"$ref":"#/components/schemas/cloudflare-pipelines_Format"},"name":{"description":"Defines the name of the Sink.","example":"my_sink","maxLength":128,"minLength":1,"type":"string"},"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_ConnectionSchema"},"type":{"description":"Specifies the type of sink.","enum":["r2","r2_data_catalog"],"example":"r2","type":"string"}},"required":["name","type"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"config":{"oneOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_r2Table"},{"$ref":"#/components/schemas/cloudflare-pipelines_r2_data_catalogTable"}]},"created_at":{"format":"date-time","type":"string"},"format":{"$ref":"#/components/schemas/cloudflare-pipelines_Format"},"id":{"description":"Indicates a unique identifier for this sink.","example":"01234567890123457689012345678901","type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"description":"Defines the name of the Sink.","example":"my_sink","maxLength":128,"minLength":1,"type":"string"},"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_ConnectionSchema"},"type":{"description":"Specifies the type of sink.","enum":["r2","r2_data_catalog"],"example":"r2","type":"string"}},"required":["id","name","created_at","modified_at","type"],"type":"object"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result"],"type":"object"}}},"description":"Indicates a successfully created Sink."},"4XX":{"description":"Indicates an error in creating a Sink."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Sink","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/pipelines/v1/sinks/{sink_id}":{"delete":{"description":"Delete Pipeline in Account.","operationId":"deleteV4AccountsByAccount_idPipelinesV1SinksBySink_id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"path","name":"sink_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-sink-id"}},{"in":"query","name":"force","schema":{"description":"Delete sink forcefully, including deleting any dependent pipelines.","type":"string"}}],"responses":{"200":{"description":"Indicates a successfully deleted Sink."},"4XX":{"description":"Indicates an error in listing Sinks."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Sink","tags":["workers_pipelines_other"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Get Sink Details.","operationId":"getV4AccountsByAccount_idPipelinesV1SinksBySink_id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"path","name":"sink_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-sink-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"config":{"description":"Defines the configuration of the R2 Sink.","oneOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_r2Table"},{"$ref":"#/components/schemas/cloudflare-pipelines_r2_data_catalogTable"}]},"created_at":{"format":"date-time","type":"string"},"format":{"$ref":"#/components/schemas/cloudflare-pipelines_Format"},"id":{"description":"Indicates a unique identifier for this sink.","example":"01234567890123457689012345678901","type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"description":"Defines the name of the Sink.","example":"my_sink","maxLength":128,"minLength":1,"type":"string"},"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_ConnectionSchema"},"type":{"description":"Specifies the type of sink.","enum":["r2","r2_data_catalog"],"example":"r2","type":"string"}},"required":["id","name","created_at","modified_at","type"],"type":"object"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result"],"type":"object"}}},"description":"Indicates that Sink was retrieved."},"4XX":{"description":"Indicates an error in listing Sinks."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Sink Details","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write","Pipelines Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/pipelines/v1/streams":{"get":{"description":"List/Filter Streams in Account.","operationId":"getV4AccountsByAccount_idPipelinesV1Streams","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"query","name":"pipeline_id","schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-pipeline-id"}},{"in":"query","name":"page","schema":{"default":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"created_at":{"format":"date-time","type":"string"},"endpoint":{"description":"Indicates the endpoint URL of this stream.","example":"https://01234567890123457689012345678901.ingest.cloudflare.com/v1","format":"uri","type":"string"},"format":{"$ref":"#/components/schemas/cloudflare-pipelines_Format"},"http":{"properties":{"authentication":{"description":"Indicates that authentication is required for the HTTP endpoint.","example":false,"type":"boolean"},"cors":{"description":"Specifies the CORS options for the HTTP endpoint.","example":{},"properties":{"origins":{"items":{"type":"string"},"maxItems":5,"type":"array"}},"type":"object"},"enabled":{"description":"Indicates that the HTTP endpoint is enabled.","example":true,"type":"boolean"}},"required":["enabled","authentication"],"type":"object"},"id":{"description":"Indicates a unique identifier for this stream.","example":"01234567890123457689012345678901","type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"description":"Indicates the name of the Stream.","example":"my_stream","maxLength":128,"minLength":1,"type":"string"},"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_ConnectionSchema"},"version":{"description":"Indicates the current version of this stream.","example":3,"type":"integer"},"worker_binding":{"properties":{"enabled":{"description":"Indicates that the worker binding is enabled.","example":true,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["id","name","version","created_at","modified_at","http","worker_binding"],"type":"object"},"type":"array"},"result_info":{"properties":{"count":{"description":"Indicates the number of items on current page.","example":1,"type":"number"},"page":{"description":"Indicates the current page number.","example":0,"type":"number"},"per_page":{"description":"Indicates the number of items per page.","example":10,"type":"number"},"total_count":{"description":"Indicates the total number of items.","example":1,"type":"number"}},"required":["count","page","per_page","total_count"],"type":"object"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result","result_info"],"type":"object"}}},"description":"Indicates a successfully created Stream."},"4XX":{"description":"Indicates an error in listing Streams."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Streams","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write","Pipelines Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"post":{"description":"Create a new Stream.","operationId":"postV4AccountsByAccount_idPipelinesV1Streams","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"format":{"$ref":"#/components/schemas/cloudflare-pipelines_Format"},"http":{"default":{"authentication":false,"enabled":true},"properties":{"authentication":{"description":"Indicates that authentication is required for the HTTP endpoint.","example":false,"type":"boolean"},"cors":{"description":"Specifies the CORS options for the HTTP endpoint.","example":{},"properties":{"origins":{"items":{"type":"string"},"maxItems":5,"type":"array"}},"type":"object"},"enabled":{"description":"Indicates that the HTTP endpoint is enabled.","example":true,"type":"boolean"}},"required":["enabled","authentication"],"type":"object"},"name":{"description":"Specifies the name of the Stream.","example":"my_stream","maxLength":128,"minLength":1,"type":"string"},"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_ConnectionSchema"},"worker_binding":{"default":{"enabled":true},"properties":{"enabled":{"description":"Indicates that the worker binding is enabled.","example":true,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["name"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"created_at":{"format":"date-time","type":"string"},"endpoint":{"description":"Indicates the endpoint URL of this stream.","example":"https://01234567890123457689012345678901.ingest.cloudflare.com/v1","format":"uri","type":"string"},"format":{"$ref":"#/components/schemas/cloudflare-pipelines_Format"},"http":{"properties":{"authentication":{"description":"Indicates that authentication is required for the HTTP endpoint.","example":false,"type":"boolean"},"cors":{"description":"Specifies the CORS options for the HTTP endpoint.","example":{},"properties":{"origins":{"items":{"type":"string"},"maxItems":5,"type":"array"}},"type":"object"},"enabled":{"description":"Indicates that the HTTP endpoint is enabled.","example":true,"type":"boolean"}},"required":["enabled","authentication"],"type":"object"},"id":{"description":"Indicates a unique identifier for this stream.","example":"01234567890123457689012345678901","type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"description":"Indicates the name of the Stream.","example":"my_stream","maxLength":128,"minLength":1,"type":"string"},"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_ConnectionSchema"},"version":{"description":"Indicates the current version of this stream.","example":3,"type":"integer"},"worker_binding":{"properties":{"enabled":{"description":"Indicates that the worker binding is enabled.","example":true,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["id","name","version","created_at","modified_at","http","worker_binding"],"type":"object"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result"],"type":"object"}}},"description":"Indicates a successfully created Stream."},"4XX":{"description":"Indicates an error in creating a Stream."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Stream","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/pipelines/v1/streams/{stream_id}":{"delete":{"description":"Delete Stream in Account.","operationId":"deleteV4AccountsByAccount_idPipelinesV1StreamsByStream_id","parameters":[{"in":"query","name":"force","schema":{"description":"Delete stream forcefully, including deleting any dependent pipelines.","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"path","name":"stream_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-stream-id"}}],"responses":{"200":{"description":"Indicates a successfully deleted Stream."},"4XX":{"description":"Indicates an error in listing Streams."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Stream","tags":["workers_pipelines_other"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Get Stream Details.","operationId":"getV4AccountsByAccount_idPipelinesV1StreamsByStream_id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"path","name":"stream_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-stream-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"created_at":{"format":"date-time","type":"string"},"endpoint":{"description":"Indicates the endpoint URL of this stream.","example":"https://01234567890123457689012345678901.ingest.cloudflare.com/v1","format":"uri","type":"string"},"format":{"$ref":"#/components/schemas/cloudflare-pipelines_Format"},"http":{"properties":{"authentication":{"description":"Indicates that authentication is required for the HTTP endpoint.","example":false,"type":"boolean"},"cors":{"description":"Specifies the CORS options for the HTTP endpoint.","example":{},"properties":{"origins":{"items":{"type":"string"},"maxItems":5,"type":"array"}},"type":"object"},"enabled":{"description":"Indicates that the HTTP endpoint is enabled.","example":true,"type":"boolean"}},"required":["enabled","authentication"],"type":"object"},"id":{"description":"Indicates a unique identifier for this stream.","example":"01234567890123457689012345678901","type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"description":"Indicates the name of the Stream.","example":"my_stream","maxLength":128,"minLength":1,"type":"string"},"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_ConnectionSchema"},"version":{"description":"Indicates the current version of this stream.","example":3,"type":"integer"},"worker_binding":{"properties":{"enabled":{"description":"Indicates that the worker binding is enabled.","example":true,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["id","name","version","created_at","modified_at","http","worker_binding"],"type":"object"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result"],"type":"object"}}},"description":"Indicates a successfully retrieved Stream."},"4XX":{"description":"Indicates an error in retrieving Stream."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Stream Details","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write","Pipelines Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"patch":{"description":"Update a Stream.","operationId":"patchV4AccountsByAccount_idPipelinesV1StreamsByStream_id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"path","name":"stream_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-stream-id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"http":{"properties":{"authentication":{"description":"Indicates that authentication is required for the HTTP endpoint.","example":false,"type":"boolean"},"cors":{"description":"Specifies the CORS options for the HTTP endpoint.","example":{},"properties":{"origins":{"items":{"type":"string"},"maxItems":5,"type":"array"}},"type":"object"},"enabled":{"description":"Indicates that the HTTP endpoint is enabled.","example":true,"type":"boolean"}},"required":["enabled","authentication"],"type":"object"},"worker_binding":{"properties":{"enabled":{"description":"Indicates that the worker binding is enabled.","example":true,"type":"boolean"}},"required":["enabled"],"type":"object"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"created_at":{"format":"date-time","type":"string"},"endpoint":{"description":"Indicates the endpoint URL of this stream.","example":"https://01234567890123457689012345678901.ingest.cloudflare.com/v1","format":"uri","type":"string"},"format":{"$ref":"#/components/schemas/cloudflare-pipelines_Format"},"http":{"properties":{"authentication":{"description":"Indicates that authentication is required for the HTTP endpoint.","example":false,"type":"boolean"},"cors":{"description":"Specifies the CORS options for the HTTP endpoint.","example":{},"properties":{"origins":{"items":{"type":"string"},"maxItems":5,"type":"array"}},"type":"object"},"enabled":{"description":"Indicates that the HTTP endpoint is enabled.","example":true,"type":"boolean"}},"required":["enabled","authentication"],"type":"object"},"id":{"description":"Indicates a unique identifier for this stream.","example":"01234567890123457689012345678901","type":"string"},"modified_at":{"format":"date-time","type":"string"},"name":{"description":"Indicates the name of the Stream.","example":"my_stream","maxLength":128,"minLength":1,"type":"string"},"version":{"description":"Indicates the current version of this stream.","example":3,"type":"integer"},"worker_binding":{"properties":{"enabled":{"description":"Indicates that the worker binding is enabled.","example":true,"type":"boolean"}},"required":["enabled"],"type":"object"}},"required":["id","name","version","created_at","modified_at","http","worker_binding"],"type":"object"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result"],"type":"object"}}},"description":"Indicates a successfully updated Stream."},"4XX":{"description":"Indicates an error in creating a Stream."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Stream","tags":["workers_pipelines_other"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/pipelines/v1/validate_sql":{"post":{"description":"Validate Arroyo SQL.","operationId":"postV4AccountsByAccount_idPipelinesV1Validate_sql","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"sql":{"description":"Specifies SQL to validate.","example":"insert into sink select * from source;","type":"string"}},"required":["sql"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"graph":{"$ref":"#/components/schemas/cloudflare-pipelines_PipelineGraph"},"tables":{"additionalProperties":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"version":{"type":"number"}},"required":["id","version","type","name"],"type":"object"},"description":"Indicates tables involved in the processing.","type":"object"}},"required":["tables"],"type":"object"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result"],"type":"object"}}},"description":"Indicates SQL validation success."},"4XX":{"description":"Indicates SQL validation failed."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Validate SQL","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/pipelines/{pipeline_name}":{"delete":{"deprecated":true,"description":"[DEPRECATED] Delete a pipeline. Use the new /pipelines/v1/pipelines endpoint instead.","operationId":"deleteV4AccountsByAccount_idPipelinesByPipeline_name_deprecated","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"path","name":"pipeline_name","required":true,"schema":{"description":"Defines the name of the pipeline.","example":"sample_pipeline","maxLength":128,"minLength":1,"type":"string"}}],"responses":{"200":{"description":"[DEPRECATED] Indicates a successfully deleted pipeline."},"4XX":{"description":"Indicates an error in deleting a pipeline."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"[DEPRECATED] Delete Pipeline","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"deprecated":true,"description":"[DEPRECATED] Get configuration of a pipeline. Use the new /pipelines/v1/pipelines endpoint instead.","operationId":"getV4AccountsByAccount_idPipelinesByPipeline_name_deprecated","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"path","name":"pipeline_name","required":true,"schema":{"description":"Defines the name of the pipeline.","example":"sample_pipeline","maxLength":128,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-pipeline"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result"],"type":"object"}}},"description":"[DEPRECATED] Describes the configuration of a pipeline."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"example":[],"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"results":{"nullable":true,"type":"object","x-stainless-empty-object":true},"success":{"allOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}],"example":false}},"required":["success","results","errors"],"type":"object"}}},"description":"Indicates that the pipeline was not found."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"[DEPRECATED] Get Pipeline","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write","Pipelines Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"deprecated":true,"description":"[DEPRECATED] Update an existing pipeline. Use the new /pipelines/v1/pipelines endpoint instead.","operationId":"putV4AccountsByAccount_idPipelinesByPipeline_name_deprecated","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-account-id"}},{"in":"path","name":"pipeline_name","required":true,"schema":{"description":"Defines the name of the pipeline.","example":"sample_pipeline","maxLength":128,"minLength":1,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination":{"properties":{"batch":{"properties":{"max_bytes":{"default":100000000,"description":"Specifies rough maximum size of files.","maximum":100000000,"minimum":1000,"type":"integer"},"max_duration_s":{"default":300,"description":"Specifies duration to wait to aggregate batches files.","maximum":300,"minimum":0.25,"type":"number"},"max_rows":{"default":10000000,"description":"Specifies rough maximum number of rows per file.","maximum":10000000,"minimum":100,"type":"integer"}},"type":"object"},"compression":{"properties":{"type":{"default":"gzip","description":"Specifies the desired compression algorithm and format.","enum":["none","gzip","deflate"],"example":"gzip","type":"string"}},"type":"object"},"credentials":{"properties":{"access_key_id":{"description":"Specifies the R2 Bucket Access Key Id.","example":"\u003caccess key id\u003e","type":"string"},"endpoint":{"description":"Specifies the R2 Endpoint.","example":"https://123f8a8258064ed892a347f173372359.r2.cloudflarestorage.com","type":"string"},"secret_access_key":{"description":"Specifies the R2 Bucket Secret Access Key.","example":"\u003csecret key\u003e","type":"string"}},"required":["endpoint","access_key_id","secret_access_key"],"type":"object"},"format":{"description":"Specifies the format of data to deliver.","enum":["json"],"type":"string"},"path":{"example":{"bucket":"bucket","prefix":"base"},"properties":{"bucket":{"description":"Specifies the R2 Bucket to store files.","example":"bucket","type":"string"},"filename":{"allOf":[{"type":"string"},{"type":"string"}],"description":"Specifies the name pattern to for individual data files.","example":"${slug}${extension}"},"filepath":{"description":"Specifies the name pattern for directory.","example":"${date}/${hour}","type":"string"},"prefix":{"description":"Specifies the base directory within the bucket.","example":"base","type":"string"}},"required":["bucket"],"type":"object"},"type":{"description":"Specifies the type of destination.","enum":["r2"],"type":"string"}},"required":["type","format","batch","compression","path"],"type":"object"},"name":{"description":"Defines the name of the pipeline.","example":"sample_pipeline","maxLength":128,"minLength":1,"type":"string"},"source":{"items":{"discriminator":{"mapping":{"binding":"#/components/schemas/cloudflare-pipelines_workers_pipelines_binding_source","http":"#/components/schemas/cloudflare-pipelines_workers_pipelines_http_source"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_workers_pipelines_http_source"},{"$ref":"#/components/schemas/cloudflare-pipelines_workers_pipelines_binding_source"}]},"minItems":1,"type":"array"}},"required":["name","source","destination"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/cloudflare-pipelines_workers-pipelines-pipeline"},"success":{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}},"required":["success","result"],"type":"object"}}},"description":"[DEPRECATED] Indicates a successfully updated pipeline."},"4XX":{"content":{"application/json":{"schema":{"properties":{"errors":{"example":[],"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"results":{"nullable":true,"type":"object","x-stainless-empty-object":true},"success":{"allOf":[{"$ref":"#/components/schemas/cloudflare-pipelines_worker-pipelines-common-success"}],"example":false}},"required":["success","results","errors"],"type":"object"}}},"description":"Indicates an error updating pipeline."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"[DEPRECATED] Update Pipeline","tags":["workers_pipelines_other"],"x-api-token-group":["Pipelines Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/profile":{"get":{"operationId":"Accounts_getAccountProfile","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"$ref":"#/components/schemas/organizations-api_Profile"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get account profile","tags":["Accounts"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","DNS View Write","DNS View Read","SCIM Provisioning","Load Balancers Account Write","Load Balancers Account Read","Zero Trust: PII Read","DDoS Botnet Feed Write","DDoS Botnet Feed Read","Workers R2 Storage Write","Workers R2 Storage Read","DDoS Protection Write","DDoS Protection Read","Workers Tail Read","Workers KV Storage Write","Workers KV Storage Read","Workers Scripts Write","Workers Scripts Read","Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read","Account Firewall Access Rules Write","Account Firewall Access Rules Read","DNS Firewall Write","DNS Firewall Read","Billing Write","Billing Read","Account Settings Write","Account Settings Read"]},"put":{"operationId":"Accounts_modifyAccountProfile","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_Profile"}}},"required":true},"responses":{"204":{"description":"There is no content to send for this request, but the headers may be useful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Modify account profile","tags":["Accounts"],"x-api-token-group":["Account Settings Write"]}},"/accounts/{account_id}/queues":{"get":{"description":"Returns the queues owned by an account.","operationId":"queues-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mq_queue"},"type":"array"},"result_info":{"properties":{"count":{"description":"Total number of queues","example":1,"type":"number"},"page":{"description":"Current page within paginated list of queues","example":1,"type":"number"},"per_page":{"description":"Number of queues per page","example":20,"type":"number"},"total_count":{"description":"Total queues available without any search parameters","example":2000,"type":"number"},"total_pages":{"description":"Total pages available without any search parameters","example":100,"type":"number"}},"type":"object"}},"type":"object"}],"type":"object"}}},"description":"List of all Queues that belong to this account"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Queues","tags":["Queue"],"x-api-token-group":["Queues Write","Queues Read","Workers Scripts Write","Workers Scripts Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.list"]}},"post":{"description":"Create a new queue","operationId":"queues-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"queue_name":{"$ref":"#/components/schemas/mq_queue-name"}},"required":["queue_name"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"$ref":"#/components/schemas/mq_queue"}},"type":"object"}],"type":"object"}}},"description":"Created Queue"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Queue","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.create"]}}},"/accounts/{account_id}/queues/{queue_id}":{"delete":{"description":"Deletes a queue","operationId":"queues-delete","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-success"}}},"description":"Successful delete"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Queue","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.delete"]}},"get":{"description":"Get details about a specific queue.","operationId":"queues-get","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"$ref":"#/components/schemas/mq_queue"}},"type":"object"}],"type":"object"}}},"description":"Details of the requested Queue"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Queue","tags":["Queue"],"x-api-token-group":["Queues Write","Queues Read","Workers Scripts Write","Workers Scripts Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.read"]}},"patch":{"description":"Updates a Queue.","operationId":"queues-update-partial","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_queue"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/mq_queue"}],"type":"object"}},"type":"object"}],"type":"object"}}},"description":"Updated Queue"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Queue","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.update"]}},"put":{"description":"Updates a Queue. Note that this endpoint does not support partial updates. If successful, the Queue's configuration is overwritten with the supplied configuration.","operationId":"queues-update","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_queue"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/mq_queue"}],"type":"object"}},"type":"object"}],"type":"object"}}},"description":"Updated Queue"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Queue","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.update"]}}},"/accounts/{account_id}/queues/{queue_id}/consumers":{"get":{"description":"Returns the consumers for a Queue","operationId":"queues-list-consumers","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mq_consumer"},"type":"array"}},"type":"object"}],"type":"object"}}},"description":"All consumers attached to this Queue"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Queue Consumers","tags":["Queue"],"x-api-token-group":["Queues Write","Queues Read","Workers Scripts Write","Workers Scripts Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.list"]}},"post":{"description":"Creates a new consumer for a Queue","operationId":"queues-create-consumer","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_consumer"},{"properties":{"dead_letter_queue":{"$ref":"#/components/schemas/mq_queue-name"}},"type":"object"}],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"$ref":"#/components/schemas/mq_consumer"}},"type":"object"}],"type":"object"}}},"description":"Create Queue Consumer response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a Queue Consumer","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.create"]}}},"/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}":{"delete":{"description":"Deletes the consumer for a queue.","operationId":"queues-delete-consumer","parameters":[{"in":"path","name":"consumer_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-success"}}},"description":"Successful consumer delete"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Queue Consumer","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.delete"]}},"get":{"description":"Fetches the consumer for a queue by consumer id","operationId":"queues-get-consumer","parameters":[{"in":"path","name":"consumer_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"$ref":"#/components/schemas/mq_consumer"}},"type":"object"}],"type":"object"}}},"description":"Get Queue Consumer response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Get Queue Consumer response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Queue Consumer","tags":["Queue"],"x-api-token-group":["Queues Write","Queues Read","Workers Scripts Write","Workers Scripts Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.read"]}},"put":{"description":"Updates the consumer for a queue, or creates one if it does not exist.","operationId":"queues-update-consumer","parameters":[{"in":"path","name":"consumer_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_consumer"},{"properties":{"dead_letter_queue":{"$ref":"#/components/schemas/mq_queue-name"}},"type":"object"}],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"$ref":"#/components/schemas/mq_consumer"}},"type":"object"}],"type":"object"}}},"description":"Update Queue Consumer response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Update Queue Consumer response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Queue Consumer","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.update"]}}},"/accounts/{account_id}/queues/{queue_id}/messages":{"post":{"description":"Push a message to a Queue","operationId":"queues-push-message","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_queue-message"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-success"}}},"description":"Successful message ingestion"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Push Message","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.update"]}}},"/accounts/{account_id}/queues/{queue_id}/messages/ack":{"post":{"description":"Acknowledge + Retry messages from a Queue","operationId":"queues-ack-messages","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"acks":{"items":{"properties":{"lease_id":{"$ref":"#/components/schemas/mq_lease-id"}},"type":"object"},"type":"array"},"retries":{"items":{"properties":{"delay_seconds":{"$ref":"#/components/schemas/mq_retry-delay"},"lease_id":{"$ref":"#/components/schemas/mq_lease-id"}},"type":"object"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"properties":{"ackCount":{"description":"The number of messages that were succesfully acknowledged.","example":5,"type":"number"},"retryCount":{"description":"The number of messages that were succesfully retried.","example":5,"type":"number"},"warnings":{"items":{"type":"string"},"type":"array"}},"type":"object"}},"type":"object"}],"type":"object"}}},"description":"Details of ACKs and retries"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Acknowledge + Retry Queue Messages","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.update"]}}},"/accounts/{account_id}/queues/{queue_id}/messages/batch":{"post":{"description":"Push a batch of message to a Queue","operationId":"queues-push-messages","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_queue-batch"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-success"}}},"description":"Successful batch ingestion"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Push Message Batch","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"]}},"/accounts/{account_id}/queues/{queue_id}/messages/pull":{"post":{"description":"Pull a batch of messages from a Queue","operationId":"queues-pull-messages","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"batch_size":{"$ref":"#/components/schemas/mq_batch-size"},"visibility_timeout_ms":{"$ref":"#/components/schemas/mq_visibility-timeout"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"properties":{"message_backlog_count":{"description":"The number of unacknowledged messages in the queue","example":5,"type":"number"},"messages":{"$ref":"#/components/schemas/mq_queue-pull-batch"}},"type":"object"}},"type":"object"}],"type":"object"}}},"description":"A batch of messages in the Queue"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Pull Queue Messages","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.update"]}}},"/accounts/{account_id}/queues/{queue_id}/purge":{"get":{"description":"Get details about a Queue's purge status.","operationId":"queues-purge-get","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"properties":{"completed":{"description":"Indicates if the last purge operation completed successfully.","readOnly":true,"type":"string","x-auditable":true},"started_at":{"description":"Timestamp when the last purge operation started.","readOnly":true,"type":"string","x-auditable":true}},"type":"object"}},"type":"object"}],"type":"object"}}},"description":"Details of the requested Queue"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Queue Purge Status","tags":["Queue"],"x-api-token-group":["Queues Write","Queues Read","Workers Scripts Write","Workers Scripts Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.read"]}},"post":{"description":"Deletes all messages from the Queue.","operationId":"queues-purge","parameters":[{"in":"path","name":"queue_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/mq_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"delete_messages_permanently":{"description":"Confimation that all messages will be deleted permanently.","example":true,"type":"boolean","x-auditable":true}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mq_api-v4-success"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/mq_queue"}],"type":"object"}},"type":"object"}],"type":"object"}}},"description":"Updated Queue"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mq_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Purge Queue","tags":["Queue"],"x-api-token-group":["Queues Write","Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.update"]}}},"/accounts/{account_id}/r2-catalog":{"get":{"description":"Returns a list of R2 buckets that have been enabled as Apache Iceberg catalogs\nfor the specified account. Each catalog represents an R2 bucket configured\nto store Iceberg metadata and data files.\n","operationId":"list-catalogs","parameters":[{"description":"Identifies the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_account-id"}}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"warehouses":[{"bucket":"analytics-bucket","id":"550e8400-e29b-41d4-a716-446655440000","maintenance_config":{"compaction":{"state":"enabled","target_size_mb":"128"}},"name":"account123_analytics-bucket","status":"active"},{"bucket":"logs-bucket","id":"6ba7b810-9dad-11d1-80b4-00c04fd430c8","maintenance_config":{"compaction":{"state":"disabled","target_size_mb":"128"}},"name":"account123_logs-bucket","status":"inactive"}]},"success":true},"schema":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/r2-data-catalog_catalog-list"}},"type":"object"}]}}},"description":"List of R2 catalogs."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Bad request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Authentication failed."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Forbidden."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Internal server error."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List R2 catalogs","tags":["R2 Catalog Management"],"x-api-token-group":["Workers R2 Data Catalog Write","Workers R2 Data Catalog Read"]}},"/accounts/{account_id}/r2-catalog/{bucket_name}":{"get":{"description":"Retrieve detailed information about a specific R2 catalog by bucket name.\nReturns catalog status, maintenance configuration, and credential status.\n","operationId":"get-catalog-details","parameters":[{"description":"Identifies the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_account-id"}},{"description":"Specifies the R2 bucket name.","in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_bucket-name"}}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"bucket":"analytics-bucket","credential_status":"present","id":"550e8400-e29b-41d4-a716-446655440000","maintenance_config":{"compaction":{"state":"enabled","target_size_mb":"128"}},"name":"account123_analytics-bucket","status":"active"},"success":true},"schema":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/r2-data-catalog_catalog"}},"type":"object"}]}}},"description":"R2 catalog details."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Bad request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Authentication failed."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Catalog not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Internal server error."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get R2 catalog details","tags":["R2 Catalog Management"],"x-api-token-group":["Workers R2 Data Catalog Write","Workers R2 Data Catalog Read"]}},"/accounts/{account_id}/r2-catalog/{bucket_name}/credential":{"post":{"description":"Store authentication credentials for a catalog. These credentials are used\nto authenticate with R2 storage when performing catalog operations.\n","operationId":"store-credentials","parameters":[{"description":"Identifies the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_account-id"}},{"description":"Specifies the R2 bucket name.","in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_bucket-name"}}],"requestBody":{"content":{"application/json":{"example":{"token":"your-cloudflare-api-token-here"},"schema":{"$ref":"#/components/schemas/r2-data-catalog_catalog-credential-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":null,"success":true},"schema":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]}}},"description":"Credentials stored successfully."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Bad request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Authentication failed."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Catalog not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Internal server error."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Store catalog credentials","tags":["Credential Management"],"x-api-token-group":["Workers R2 Data Catalog Write"]}},"/accounts/{account_id}/r2-catalog/{bucket_name}/disable":{"post":{"description":"Disable an R2 bucket as a catalog. This operation deactivates the catalog\nbut preserves existing metadata and data files. The catalog can be\nre-enabled later.\n","operationId":"disable-catalog","parameters":[{"description":"Identifies the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_account-id"}},{"description":"Specifies the R2 bucket name to disable as catalog.","in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_bucket-name"}}],"responses":{"204":{"description":"Catalog disabled successfully."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Bad request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Authentication failed."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Catalog not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Internal server error."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Disable R2 catalog","tags":["R2 Catalog Management"],"x-api-token-group":["Workers R2 Data Catalog Write"]}},"/accounts/{account_id}/r2-catalog/{bucket_name}/enable":{"post":{"description":"Enable an R2 bucket as an Apache Iceberg catalog. This operation creates\nthe necessary catalog infrastructure and activates the bucket for storing\nIceberg metadata and data files.\n","operationId":"enable-catalog","parameters":[{"description":"Identifies the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_account-id"}},{"description":"Specifies the R2 bucket name to enable as catalog.","in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_bucket-name"}}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"id":"550e8400-e29b-41d4-a716-446655440000","name":"account123_my-bucket"},"success":true},"schema":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/r2-data-catalog_catalog-activation-response"}},"type":"object"}]}}},"description":"Catalog enabled successfully."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Bad request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Authentication failed."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Forbidden."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Catalog already enabled."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Internal server error."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Enable R2 bucket as a catalog","tags":["R2 Catalog Management"],"x-api-token-group":["Workers R2 Data Catalog Write"]}},"/accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs":{"get":{"description":"Retrieve the maintenance configuration for a specific catalog,\nincluding compaction settings and credential status.\n","operationId":"get-maintenance-config","parameters":[{"description":"Identifies the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_account-id"}},{"description":"Specifies the R2 bucket name.","in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_bucket-name"}}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"credential_status":"present","maintenance_config":{"compaction":{"state":"enabled","target_size_mb":"128"}}},"success":true},"schema":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/r2-data-catalog_catalog-maintenance-config-response"}},"type":"object"}]}}},"description":"Maintenance configuration retrieved successfully."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Bad request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Authentication failed."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Catalog not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Internal server error."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get catalog maintenance configuration","tags":["Maintenance Configuration"],"x-api-token-group":["Workers R2 Data Catalog Write","Workers R2 Data Catalog Read"]},"post":{"description":"Update the maintenance configuration for a catalog. This allows you to\nenable or disable compaction and adjust target file sizes for optimization.\n","operationId":"update-maintenance-config","parameters":[{"description":"Identifies the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_account-id"}},{"description":"Specifies the R2 bucket name.","in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_bucket-name"}}],"requestBody":{"content":{"application/json":{"example":{"compaction":{"state":"enabled","target_size_mb":"256"}},"schema":{"$ref":"#/components/schemas/r2-data-catalog_catalog-maintenance-update-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"compaction":{"state":"enabled","target_size_mb":"256"}},"success":true},"schema":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/r2-data-catalog_catalog-maintenance-config"}},"type":"object"}]}}},"description":"Maintenance configuration updated successfully."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Bad request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Authentication failed."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Catalog not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Internal server error."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update catalog maintenance configuration","tags":["Maintenance Configuration"],"x-api-token-group":["Workers R2 Data Catalog Write"]}},"/accounts/{account_id}/r2-catalog/{bucket_name}/namespaces":{"get":{"description":"Returns a list of namespaces in the specified R2 catalog.\nSupports hierarchical filtering and pagination for efficient traversal\nof large namespace hierarchies.\n","operationId":"list-namespaces","parameters":[{"description":"Identifies the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_account-id"}},{"description":"Specifies the R2 bucket name.","in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_bucket-name"}},{"description":"Opaque pagination token from a previous response.\nUse this to fetch the next page of results.\n","example":"MSYxNzU5NzU1NTc4NTA0MTk0JjAxOTliOTliLTJjODgtNzNiMy04ZGJiLTQyMWUwZThmMjc1Nw","in":"query","name":"page_token","schema":{"type":"string"}},{"description":"Maximum number of namespaces to return per page.\nDefaults to 100, maximum 1000.\n","example":100,"in":"query","name":"page_size","schema":{"default":100,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Parent namespace to filter by. Only returns direct children of this namespace.\nFor nested namespaces, use %1F as separator (e.g., \"bronze%1Fanalytics\").\nOmit this parameter to list top-level namespaces.\n","example":"bronze","in":"query","name":"parent","schema":{"type":"string"}},{"description":"Whether to include namespace UUIDs in the response.\nSet to true to receive the namespace_uuids array.\n","example":true,"in":"query","name":"return_uuids","schema":{"default":false,"type":"boolean"}},{"description":"Whether to include additional metadata (timestamps).\nWhen true, response includes created_at and updated_at arrays.\n","example":true,"in":"query","name":"return_details","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"details":[{"created_at":"2025-10-07T10:00:00Z","namespace":["bronze"],"namespace_uuid":"0199b999-6869-7383-bb1f-d30e059d5326","updated_at":"2025-10-07T12:00:00Z"},{"created_at":"2025-10-07T10:15:00Z","namespace":["silver"],"namespace_uuid":"0199b99b-2c88-73b3-8dbb-421e0e8f2757","updated_at":null},{"created_at":"2025-10-07T10:30:00Z","namespace":["gold"],"namespace_uuid":"0199b99c-3d99-73c4-9dcc-532f1f9g3868","updated_at":"2025-10-07T11:00:00Z"}],"namespace_uuids":["0199b999-6869-7383-bb1f-d30e059d5326","0199b99b-2c88-73b3-8dbb-421e0e8f2757","0199b99c-3d99-73c4-9dcc-532f1f9g3868"],"namespaces":[["bronze"],["silver"],["gold"]],"next_page_token":null},"success":true},"schema":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/r2-data-catalog_namespace-list-response"}},"type":"object"}]}}},"description":"List of namespaces retrieved successfully."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Bad request (e.g., invalid page_size, malformed parent namespace)."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Authentication failed."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Catalog not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Internal server error."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List namespaces in catalog","tags":["Namespace Management"],"x-api-token-group":["Workers R2 Data Catalog Write","Workers R2 Data Catalog Read"]}},"/accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables":{"get":{"description":"Returns a list of tables in the specified namespace within an R2 catalog.\nSupports pagination for efficient traversal of large table collections.\n","operationId":"list-tables","parameters":[{"description":"Identifies the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_account-id"}},{"description":"Specifies the R2 bucket name.","in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_bucket-name"}},{"description":"The namespace identifier.\nFor nested namespaces, use %1F as separator (e.g., \"bronze%1Fanalytics\").\n","example":"bronze","in":"path","name":"namespace","required":true,"schema":{"type":"string"}},{"description":"Opaque pagination token from a previous response.\nUse this to fetch the next page of results.\n","example":"MSYxNzU5NzU2MTI4NTU2Njk2JjAxOTliOWEzLTkxMmUtN2ZhMS05YzllLTg5MTAxMGQzYTg0MQ","in":"query","name":"page_token","schema":{"type":"string"}},{"description":"Maximum number of tables to return per page.\nDefaults to 100, maximum 1000.\n","example":100,"in":"query","name":"page_size","schema":{"default":100,"maximum":1000,"minimum":1,"type":"integer"}},{"description":"Whether to include table UUIDs in the response.\nSet to true to receive the table_uuids array.\n","example":true,"in":"query","name":"return_uuids","schema":{"default":false,"type":"boolean"}},{"description":"Whether to include additional metadata (timestamps, locations).\nWhen true, response includes created_at, updated_at, metadata_locations, and locations arrays.\n","example":true,"in":"query","name":"return_details","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"details":[{"created_at":"2025-10-07T10:00:00Z","identifier":{"name":"events","namespace":["bronze"]},"location":"s3://my-bucket/__r2_data_catalog/wh-id/table-id/","metadata_location":"s3://my-bucket/__r2_data_catalog/wh-id/table-id/metadata/v1.metadata.json","table_uuid":"0199b9a1-28a0-71e0-a73e-b0fc32c8468e","updated_at":"2025-10-07T15:00:00Z"},{"created_at":"2025-10-07T10:30:00Z","identifier":{"name":"users","namespace":["bronze"]},"location":"s3://my-bucket/__r2_data_catalog/wh-id/table-id-2/","metadata_location":"s3://my-bucket/__r2_data_catalog/wh-id/table-id-2/metadata/v2.metadata.json","table_uuid":"0199b9a1-3c74-7731-bf53-d8c67ead079d","updated_at":"2025-10-07T16:00:00Z"}],"identifiers":[{"name":"events","namespace":["bronze"]},{"name":"users","namespace":["bronze"]}],"next_page_token":null,"table_uuids":["0199b9a1-28a0-71e0-a73e-b0fc32c8468e","0199b9a1-3c74-7731-bf53-d8c67ead079d"]},"success":true},"schema":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/r2-data-catalog_table-list-response"}},"type":"object"}]}}},"description":"List of tables retrieved successfully."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Bad request (e.g., invalid page_size, malformed namespace)."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Authentication failed."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Catalog or namespace not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Internal server error."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List tables in namespace","tags":["Table Management"],"x-api-token-group":["Workers R2 Data Catalog Write","Workers R2 Data Catalog Read"]}},"/accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs":{"get":{"description":"Retrieve the maintenance configuration for a specific table,\nincluding compaction settings.\n","operationId":"get-table-maintenance-config","parameters":[{"description":"Identifies the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_account-id"}},{"description":"Specifies the R2 bucket name.","in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_bucket-name"}},{"description":"The namespace identifier (use %1F as separator for nested namespaces).","example":"my_namespace%1Fsub_namespace","in":"path","name":"namespace","required":true,"schema":{"type":"string"}},{"description":"The table name.","example":"my_table","in":"path","name":"table_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"maintenance_config":{"compaction":{"state":"enabled","target_size_mb":"128"}}},"success":true},"schema":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/r2-data-catalog_table-maintenance-config-response"}},"type":"object"}]}}},"description":"Table maintenance configuration retrieved successfully."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Bad request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Authentication failed."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Table not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Internal server error."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get table maintenance configuration","tags":["Table Maintenance Configuration"],"x-api-token-group":["Workers R2 Data Catalog Write","Workers R2 Data Catalog Read"]},"post":{"description":"Update the maintenance configuration for a specific table. This allows you to\nenable or disable compaction and adjust target file sizes for optimization.\n","operationId":"update-table-maintenance-config","parameters":[{"description":"Identifies the account.","in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_account-id"}},{"description":"Specifies the R2 bucket name.","in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2-data-catalog_bucket-name"}},{"description":"The namespace identifier (use %1F as separator for nested namespaces).","example":"my_namespace%1Fsub_namespace","in":"path","name":"namespace","required":true,"schema":{"type":"string"}},{"description":"The table name.","example":"my_table","in":"path","name":"table_name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"compaction":{"state":"enabled","target_size_mb":"256"}},"schema":{"$ref":"#/components/schemas/r2-data-catalog_table-maintenance-update-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"compaction":{"state":"enabled","target_size_mb":"256"}},"success":true},"schema":{"allOf":[{"$ref":"#/components/schemas/r2-data-catalog_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/r2-data-catalog_table-maintenance-config"}},"type":"object"}]}}},"description":"Table maintenance configuration updated successfully."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Bad request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Authentication failed."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Forbidden."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Table not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-data-catalog_api-response-common-failure"}}},"description":"Internal server error."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update table maintenance configuration","tags":["Table Maintenance Configuration"],"x-api-token-group":["Workers R2 Data Catalog Write"]}},"/accounts/{account_id}/r2/buckets":{"get":{"description":"Lists all R2 buckets on your account.","operationId":"r2-list-buckets","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"query","name":"name_contains","schema":{"description":"Bucket names to filter by. Only buckets with this phrase in their name will be returned.","example":"my-bucket","type":"string"}},{"in":"query","name":"start_after","schema":{"description":"Bucket name to start searching after. Buckets are ordered lexicographically.","example":"my-bucket","type":"string"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of buckets to return in a single call.","maximum":1000,"minimum":1,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Field to order buckets by.","enum":["name"],"type":"string"}},{"in":"query","name":"direction","schema":{"description":"Direction to order buckets.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"Pagination cursor received during the last List Buckets call. R2 buckets are paginated using cursors instead of page numbers.","type":"string"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response_list"},{"properties":{"result":{"properties":{"buckets":{"items":{"$ref":"#/components/schemas/r2_bucket"},"type":"array"}},"type":"object"}},"type":"object"}]}}},"description":"List Buckets response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"List Buckets response failure."}},"security":[{"api_token":[]}],"summary":"List Buckets","tags":["R2 Bucket"],"x-api-token-group":["Workers R2 Storage Write","Workers R2 Storage Read"]},"post":{"description":"Creates a new R2 bucket.","operationId":"r2-create-bucket","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"requestBody":{"content":{"application/json":{"schema":{"example":"{\"name\": \"example-bucket\"}","properties":{"locationHint":{"$ref":"#/components/schemas/r2_bucket_location"},"name":{"$ref":"#/components/schemas/r2_bucket_name"},"storageClass":{"$ref":"#/components/schemas/r2_storage_class"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_bucket"}},"type":"object"}]}}},"description":"Create Bucket response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Create Bucket response failure."}},"security":[{"api_token":[]}],"summary":"Create Bucket","tags":["R2 Bucket"],"x-api-token-group":["Workers R2 Storage Write"]}},"/accounts/{account_id}/r2/buckets/{bucket_name}":{"delete":{"description":"Deletes an existing R2 bucket.","operationId":"r2-delete-bucket","parameters":[{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response"}}},"description":"Delete Bucket response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Delete Bucket response failure."}},"security":[{"api_token":[]}],"summary":"Delete Bucket","tags":["R2 Bucket"],"x-api-token-group":["Workers R2 Storage Write"]},"get":{"description":"Gets properties of an existing R2 bucket.","operationId":"r2-get-bucket","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_bucket"}},"type":"object"}]}}},"description":"Get Bucket response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Get Bucket response failure."}},"security":[{"api_token":[]}],"summary":"Get Bucket","tags":["R2 Bucket"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.r2.bucket.read"]}},"patch":{"description":"Updates properties of an existing R2 bucket.","operationId":"r2-patch-bucket","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}},{"in":"header","name":"cf-r2-storage-class","required":true,"schema":{"allOf":[{"$ref":"#/components/schemas/r2_storage_class"}],"x-stainless-param":"storage_class"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_bucket"}},"type":"object"}]}}},"description":"Patch Bucket response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Get Bucket response failure."}},"security":[{"api_token":[]}],"summary":"Patch Bucket","tags":["R2 Bucket"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.r2.bucket.write"]}}},"/accounts/{account_id}/r2/buckets/{bucket_name}/cors":{"delete":{"description":"Delete the CORS policy for a bucket.","operationId":"r2-delete-bucket-cors-policy","parameters":[{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"type":"object"}]}}},"description":"Success Response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Error Response."}},"security":[{"api_token":[]}],"summary":"Delete Bucket CORS Policy","tags":["R2 Bucket"]},"get":{"description":"Get the CORS policy for a bucket.","operationId":"r2-get-bucket-cors-policy","parameters":[{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"properties":{"rules":{"items":{"$ref":"#/components/schemas/r2_cors-rule"},"type":"array"}},"type":"object"}},"type":"object"}]}}},"description":"Success Response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Error Response."}},"security":[{"api_token":[]}],"summary":"Get Bucket CORS Policy","tags":["R2 Bucket"]},"put":{"description":"Set the CORS policy for a bucket.","operationId":"r2-put-bucket-cors-policy","parameters":[{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"rules":{"items":{"$ref":"#/components/schemas/r2_cors-rule"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"type":"object"}]}}},"description":"Success Response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Error Response."}},"security":[{"api_token":[]}],"summary":"Put Bucket CORS Policy","tags":["R2 Bucket"]}},"/accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom":{"get":{"description":"Gets a list of all custom domains registered with an existing R2 bucket.","operationId":"r2-list-custom-domains","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_list_custom_domains_response"}},"type":"object"}]}}},"description":"List Custom Domains response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"List Custom Domains response failure."}},"security":[{"api_token":[]}],"summary":"List Custom Domains of Bucket","tags":["R2 Bucket"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.r2.bucket.read"]}},"post":{"description":"Register a new custom domain for an existing R2 bucket.","operationId":"r2-add-custom-domain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_add_custom_domain_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_add_custom_domain_response"}},"type":"object"}]}}},"description":"Add Custom Domain response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Add Custom Domain response failure."}},"security":[{"api_token":[]}],"summary":"Attach Custom Domain To Bucket","tags":["R2 Bucket"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.r2.bucket.write"]}}},"/accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom/{domain}":{"delete":{"description":"Remove custom domain registration from an existing R2 bucket.","operationId":"r2-delete-custom-domain","parameters":[{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"path","name":"domain","required":true,"schema":{"$ref":"#/components/schemas/r2_domain_name"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_remove_custom_domain_response"}},"type":"object"}]}}},"description":"Delete Custom Domain response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Delete Custom Domain response failure."}},"security":[{"api_token":[]}],"summary":"Remove Custom Domain From Bucket","tags":["R2 Bucket"],"x-api-token-group":["Workers R2 Storage Write"]},"get":{"description":"Get the configuration for a custom domain on an existing R2 bucket.","operationId":"r2-get-custom-domain-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"domain","required":true,"schema":{"$ref":"#/components/schemas/r2_domain_name"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/r2_get_custom_domain_response"}]}},"type":"object"}]}}},"description":"Get Custom Domain Configuration response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Get Custom Domain Configuration response failure."}},"security":[{"api_token":[]}],"summary":"Get Custom Domain Settings","tags":["R2 Bucket"],"x-api-token-group":["Workers R2 Storage Write","Workers R2 Storage Read"]},"put":{"description":"Edit the configuration for a custom domain on an existing R2 bucket.","operationId":"r2-edit-custom-domain-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"domain","required":true,"schema":{"$ref":"#/components/schemas/r2_domain_name"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_edit_custom_domain_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/r2_edit_custom_domain_response"}]}},"type":"object"}]}}},"description":"Edit Custom Domain Configuration response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Edit Custom Domain Configuration response failure."}},"security":[{"api_token":[]}],"summary":"Configure Custom Domain Settings","tags":["R2 Bucket"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.r2.bucket.write"]}}},"/accounts/{account_id}/r2/buckets/{bucket_name}/domains/managed":{"get":{"description":"Gets state of public access over the bucket's R2-managed (r2.dev) domain.","operationId":"r2-get-bucket-public-policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_managed_domain_response"}},"type":"object"}]}}},"description":"Get Managed Subdomain response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Get Managed Subdomain response failure."}},"security":[{"api_token":[]}],"summary":"Get r2.dev Domain of Bucket","tags":["R2 Bucket"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.r2.bucket.read"]}},"put":{"description":"Updates state of public access over the bucket's R2-managed (r2.dev) domain.","operationId":"r2-put-bucket-public-policy","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_edit_managed_domain_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_managed_domain_response"}},"type":"object"}]}}},"description":"Update Managed Subdomain response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Update Managed Subdomain response failure."}},"security":[{"api_token":[]}],"summary":"Update r2.dev Domain of Bucket","tags":["R2 Bucket"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.r2.bucket.write"]}}},"/accounts/{account_id}/r2/buckets/{bucket_name}/lifecycle":{"get":{"description":"Get object lifecycle rules for a bucket.","operationId":"r2-get-bucket-lifecycle-configuration","parameters":[{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_lifecycle-config"}},"type":"object"}]}}},"description":"Success Response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Error Response."}},"security":[{"api_token":[]}],"summary":"Get Object Lifecycle Rules","tags":["R2 Bucket"]},"put":{"description":"Set the object lifecycle rules for a bucket.","operationId":"r2-put-bucket-lifecycle-configuration","parameters":[{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"rules":{"items":{"$ref":"#/components/schemas/r2_lifecycle-rule"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"type":"object"}]}}},"description":"Success Response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Error Response."}},"security":[{"api_token":[]}],"summary":"Put Object Lifecycle Rules","tags":["R2 Bucket"]}},"/accounts/{account_id}/r2/buckets/{bucket_name}/lock":{"get":{"description":"Get lock rules for a bucket.","operationId":"r2-get-bucket-lock-configuration","parameters":[{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_bucket-lock-rule-config"}},"type":"object"}]}}},"description":"Success Response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Error Response."}},"security":[{"api_token":[]}],"summary":"Get Bucket Lock Rules","tags":["R2 Bucket"]},"put":{"description":"Set lock rules for a bucket.","operationId":"r2-put-bucket-lock-configuration","parameters":[{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"rules":{"items":{"$ref":"#/components/schemas/r2_bucket-lock-rule"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"type":"object"}]}}},"description":"Success Response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Error Response."}},"security":[{"api_token":[]}],"summary":"Put Bucket Lock Rules","tags":["R2 Bucket"]}},"/accounts/{account_id}/r2/buckets/{bucket_name}/sippy":{"delete":{"description":"Disables Sippy on this bucket.","operationId":"r2-delete-bucket-sippy-config","parameters":[{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"properties":{"enabled":{"enum":[false],"type":"boolean"}},"type":"object"}},"type":"object"}]}}},"description":"Delete Sippy Configuration response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Delete Sippy Configuration response failure."}},"security":[{"api_token":[]}],"summary":"Disable Sippy","tags":["R2 Bucket"],"x-api-token-group":["Workers R2 Storage Write"]},"get":{"description":"Gets configuration for Sippy for an existing R2 bucket.","operationId":"r2-get-bucket-sippy-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_sippy"}},"type":"object"}]}}},"description":"Get Sippy Configuration response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Get Sippy Configuration response failure."}},"security":[{"api_token":[]}],"summary":"Get Sippy Configuration","tags":["R2 Bucket"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.r2.bucket.read"]}},"put":{"description":"Sets configuration for Sippy for an existing R2 bucket.","operationId":"r2-put-bucket-sippy-config","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}},{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/r2_bucket_name"}},{"in":"header","name":"cf-r2-jurisdiction","schema":{"$ref":"#/components/schemas/r2_jurisdiction"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/r2_enable_sippy_aws"},{"$ref":"#/components/schemas/r2_enable_sippy_gcs"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_sippy"}},"type":"object"}]}}},"description":"Set Sippy Configuration response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Get Sippy Configuration response failure."}},"security":[{"api_token":[]}],"summary":"Enable Sippy","tags":["R2 Bucket"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.r2.bucket.write"]}}},"/accounts/{account_id}/r2/metrics":{"get":{"description":"Get Storage/Object Count Metrics across all buckets in your account. Note that Account-Level Metrics may not immediately reflect the latest data.","operationId":"r2-get-account-level-metrics","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_account_level_metrics"}},"type":"object"}]}}},"description":"Get Account-Level Metrics response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Get Account-Level Metrics response failure."}},"security":[{"api_token":[]}],"summary":"Get Account-Level Metrics","tags":["R2 Account"],"x-cfPermissionsRequired":null}},"/accounts/{account_id}/r2/temp-access-credentials":{"post":{"description":"Creates temporary access credentials on a bucket that can be optionally scoped to prefixes or objects.","operationId":"r2-create-temp-access-credentials","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/r2_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_temp_access_creds_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2_v4_response"},{"properties":{"result":{"$ref":"#/components/schemas/r2_temp_access_creds_response"}},"type":"object"}]}}},"description":"Create temporary access credentials response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2_v4_response_failure"}}},"description":"Create temporary access credentials response failure."}},"security":[{"api_token":[]}],"summary":"Create Temporary Access Credentials","tags":["R2 Bucket"]}},"/accounts/{account_id}/realtime/kit/apps":{"get":{"description":"Fetch all apps for your account","operationId":"get_apps","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1":{"value":{"data":[{"created_at":"2025-01-01T08:16:40.644Z","id":"my-app-id","name":"my-first-app"}],"success":true}}},"schema":{"properties":{"data":{"items":{"properties":{"created_at":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"type":"object"},"type":"array"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Fetch all apps","tags":["Apps"],"x-api-token-group":["Realtime Admin","Realtime"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"post":{"description":"Create new app for your account","operationId":"create_app","requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"Example 1":{"value":{"data":{"app":{"created_at":"2025-01-01T08:16:40.644Z","id":"my-app-id","name":"my-new-app"}},"success":true}}},"schema":{"properties":{"data":{"properties":{"app":{"properties":{"created_at":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"type":"object"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Create App","tags":["Apps"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/analytics/daywise":{"get":{"description":"Returns day-wise session and recording analytics data of an App for the specified time range start_date to end_date. If start_date and end_date are not provided, the default time range is set from 30 days ago to the current date.","operationId":"get-org-analytics","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_startDate"},{"$ref":"#/components/parameters/realtimekit_endDate"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"recording_stats":{"description":"Recording statistics of an App during the range specified","properties":{"day_stats":{"description":"Day wise recording stats","items":{"properties":{"day":{"type":"string"},"total_recording_minutes":{"description":"Total recording minutes for a specific day","type":"integer"},"total_recordings":{"description":"Total number of recordings for a specific day","type":"integer"}},"type":"object"},"type":"array"},"recording_count":{"description":"Total number of recordings during the range specified","type":"integer"},"recording_minutes_consumed":{"description":"Total recording minutes during the range specified","type":"number"}},"type":"object"},"session_stats":{"description":"Session statistics of an App during the range specified","properties":{"day_stats":{"description":"Day wise session stats","items":{"properties":{"day":{"type":"string"},"total_session_minutes":{"description":"Total session minutes for a specific day","type":"number"},"total_sessions":{"description":"Total number of sessions for a specific day","type":"integer"}},"type":"object"},"type":"array"},"sessions_count":{"description":"Total number of sessions during the range specified","type":"integer"},"sessions_minutes_consumed":{"description":"Total session minutes during the range specified","type":"number"}},"type":"object"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Fetch day-wise session and recording analytics data for an App","tags":["Analytics","Organizations"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/daywise":{"get":{"description":"Returns day-wise livestream analytics data for the specified time range.","operationId":"get-livestream-analytics-daywise","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"Specify the start time range in ISO format to access the livestream analytics.","in":"query","name":"start_time","schema":{"format":"date-time","type":"string"}},{"description":"Specify the end time range in ISO format to access the livestream analytics.","in":"query","name":"end_time","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1":{"value":{"data":[{"count":4,"date":"2023-07-15T00:00:00.000Z","total_ingest_seconds":531,"total_viewer_seconds":116}],"success":true}}},"schema":{"properties":{"data":{"properties":{"count":{"description":"Count of total livestreams.","type":"string"},"date":{"description":"The livestream timestamp, provided in ISO format.","type":"string"},"total_ingest_seconds":{"description":"Total time duration for which the input was given or the meeting was streamed.","type":"string"},"total_viewer_seconds":{"description":"Total view time for which the viewers watched the stream.","type":"string"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Fetch day-wise analytics data for your livestreams","tags":["Live streams","LivestreamAnalytics"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/analytics/livestreams/overall":{"get":{"description":"Returns livestream analytics for the specified time range.","operationId":"get-livestream-analytics-complete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"Specify the start time range in ISO format to access the livestream analytics.","in":"query","name":"start_time","schema":{"format":"date-time","type":"string"}},{"description":"Specify the end time range in ISO format to access the livestream analytics.","in":"query","name":"end_time","schema":{"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1":{"value":{"data":[{"count":4,"date":"2023-07-15T00:00:00.000Z","total_ingest_seconds":531,"total_viewer_seconds":116}],"success":true}}},"schema":{"properties":{"data":{"properties":{"count":{"description":"Count of total livestreams.","type":"integer"},"total_ingest_seconds":{"description":"Total time duration for which the input was given or the meeting was streamed.","type":"integer"},"total_viewer_seconds":{"description":"Total view time for which the viewers watched the stream.","type":"integer"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Fetch complete analytics data for your livestreams","tags":["Live streams","LivestreamAnalytics"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/livestreams":{"get":{"description":"Returns details of livestreams associated with the given App ID. It includes livestreams created by your App and RealtimeKit meetings that are livestreamed by your App. If you only want details of livestreams created by your App and not RealtimeKit meetings, you can use the `exclude_meetings` query parameter.","operationId":"fetch_all_livestreams","parameters":[{"description":"Exclude the RealtimeKit meetings that are livestreamed.","in":"query","name":"exclude_meetings","schema":{"default":false,"type":"boolean"}},{"description":"Number of results per page.","in":"query","name":"per_page","schema":{"type":"integer"}},{"description":"The page number from which you want your page search results to be displayed.","in":"query","name":"page_no","schema":{"type":"integer"}},{"description":"Specifies the status of the operation.","in":"query","name":"status","schema":{"enum":["LIVE","IDLE","ERRORED","INVOKED"],"type":"string"}},{"description":"Specify the start time range in ISO format to access the live stream.","in":"query","name":"start_time","schema":{"format":"date-time","type":"string"}},{"description":"Specify the end time range in ISO format to access the live stream.","in":"query","name":"end_time","schema":{"format":"date-time","type":"string"}},{"description":"Specifies the sorting order for the results.","in":"query","name":"sort_order","schema":{"enum":["ASC","DSC"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example-0":{"summary":"Get All Live streams Of An Org Staging Success","value":{"data":[{"created_at":"2023-07-15T11:48:34.753Z","disabled":false,"id":"3fd739f4-3c41-456e-bfba-6ebd51e16d2c","ingest_server":"rtmps://live.cloudflare.com:443/live/","meeting_id":null,"name":null,"playback_url":"https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8","status":"IDLE","stream_key":"f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4","updated_at":"2023-07-15T11:48:34.753Z"}],"paging":{"end_offset":1,"start_offset":1,"total_count":1},"success":true}}},"schema":{"properties":{"data":{"properties":{"created_at":{"description":"Timestamp the object was created at. The time is returned in ISO format.","example":"2023-07-15T11:48:34.753Z","format":"date-time","type":"string"},"disabled":{"description":"Specifies if the livestream was disabled.","type":"string"},"id":{"description":"The ID of the livestream.","example":"3fd739f4-3c41-456e-bfba-6ebd51e16d2d","format":"uuid","type":"string"},"ingest_server":{"description":"The server URL to which the RTMP encoder sends the video and audio data.","example":"rtmps://live.cloudflare.com:443/live/","type":"string"},"meeting_id":{"description":"ID of the meeting.","type":"string"},"name":{"description":"Name of the livestream.","example":"test","type":"string"},"paging":{"properties":{"end_offset":{"example":1,"type":"integer"},"start_offset":{"example":1,"type":"integer"},"total_count":{"example":1,"type":"integer"}},"type":"object"},"playback_url":{"description":"The web address that viewers can use to watch the livestream.","example":"https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8","type":"string"},"status":{"enum":["LIVE","IDLE","ERRORED","INVOKED"],"type":"string"},"stream_key":{"description":"Unique key for accessing each livestream.","example":"f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4","type":"string"},"updated_at":{"description":"Timestamp the object was updated at. The time is returned in ISO format.","example":"2023-07-15T11:48:34.753Z","format":"date-time","type":"string"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Fetch all livestreams","tags":["Live streams"],"x-api-token-group":["Realtime Admin","Realtime"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}}],"post":{"description":"Creates a livestream for the given App ID and returns ingest server, stream key, and playback URL. You can pass custom input to the ingest server and stream key, and freely distribute the content using the playback URL on any player that supports HLS/LHLS.","requestBody":{"content":{"application/json":{"examples":{"example-1":{"value":{"name":"prdmmp-xhycsl"}}},"schema":{"properties":{"name":{"description":"Name of the livestream","nullable":true,"pattern":"^[a-zA-Z0-9-_]*$","type":"string"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"examples":{"example-1":{"value":{"data":{"disabled":false,"id":"78dd0b50-4147-4bb8-88d3-2ccc2e98bff0","ingest_server":"rtmps://live.cloudflare.com:443/live/","meeting_id":null,"name":"Livestreaming-Demo","playback_url":"https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8","status":"INVOKED","stream_key":"f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4"},"success":true}}},"schema":{"properties":{"data":{"properties":{"disabled":{"description":"Specifies if the livestream was disabled.","type":"boolean"},"id":{"description":"The livestream ID.","type":"string"},"ingest_server":{"description":"The server URL to which the RTMP encoder should send the video and audio data.","type":"string"},"meeting_id":{"nullable":true,"type":"string"},"name":{"type":"string"},"playback_url":{"description":"The web address that viewers can use to watch the livestream.","type":"string"},"status":{"enum":["LIVE","IDLE","ERRORED","INVOKED"],"type":"string"},"stream_key":{"description":"Unique key for accessing each livestream.","type":"string"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Successful response"}},"security":[{"api_token":[]}],"summary":"Create an independent livestream","tags":["Live streams"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/livestreams/sessions/{livestream-session-id}":{"get":{"description":"Returns livestream session details for the given livestream session ID. Retrieve the `livestream_session_id`using the `Fetch livestream session details using a session ID` API.","operationId":"get-v2-livestreams-livestream-session-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"in":"path","name":"livestream-session-id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":{"data":{"created_at":"2023-07-15T07:08:40.742Z","err_message":null,"id":"cf55a850-c3fd-46b5-b5d2-25b3b9aa1686","ingest_seconds":60,"invoked_time":null,"livestream_id":"b60ef3da-fbbb-441b-9168-8235b0035248","started_time":"2023-07-15T07:08:39.000Z","stopped_time":null,"updated_at":"2023-07-15T07:08:40.742Z","viewer_seconds":60},"success":true}}},"schema":{"properties":{"data":{"properties":{"created_at":{"description":"Timestamp the object was created at. The time is returned in ISO format.","format":"date-time","type":"string"},"err_message":{"description":"The server URL to which the RTMP encoder sends the video and audio data.","type":"string"},"id":{"description":"The livestream ID.","type":"string"},"ingest_seconds":{"description":"Name of the livestream.","type":"integer"},"livestream_id":{"type":"string"},"started_time":{"description":"Unique key for accessing each livestream.","type":"string"},"stopped_time":{"description":"The web address that viewers can use to watch the livestream.","type":"string"},"updated_at":{"description":"Timestamp the object was updated at. The time is returned in ISO format.","type":"string"},"viewer_seconds":{"description":"Specifies if the livestream was disabled.","type":"integer"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Fetch livestream session details using livestream session ID","tags":["Live streams"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}":{"get":{"description":"Returns details of a livestream with sessions for the given livestream ID. Retreive the livestream ID using the `Start livestreaming a meeting` API.","operationId":"get-v2-livestream-session-livestream-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"The page number from which you want your page search results to be displayed.","in":"query","name":"page_no","schema":{"type":"integer"}},{"description":"Number of results per page.","in":"query","name":"per_page","schema":{"type":"integer"}},{"in":"path","name":"livestream_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":{"data":{"livestream":{"created_at":"2023-07-15T07:08:26.634Z","disabled":false,"id":"b60ef3da-fbbb-441b-9168-8235b0035248","ingest_server":"rtmps://live.cloudflare.com:443/live/","meeting_id":"bbb87945-df1c-49d9-8159-262a7ae6cfde","name":null,"playback_url":"https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8","status":"LIVE","stream_key":"f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4","updated_at":"2023-07-15T07:08:40.726Z"},"sessions":[{"created_at":"2023-07-15T07:08:40.742Z","err_message":null,"id":"cf55a850-c3fd-46b5-b5d2-25b3b9aa1686","ingest_seconds":60,"invoked_time":null,"livestream_id":"b60ef3da-fbbb-441b-9168-8235b0035248","started_time":"2023-07-15T07:08:39.000Z","stopped_time":null,"updated_at":"2023-07-15T07:08:40.742Z","viewer_seconds":60}]},"paging":{"end_offset":1,"start_offset":1,"total_count":1},"success":true}}},"schema":{"properties":{"data":{"properties":{"livestream":{"properties":{"created_at":{"description":"Timestamp the object was created at. The time is returned in ISO format.","type":"string"},"disabled":{"description":"Specifies if the livestream was disabled.","type":"string"},"id":{"description":"ID of the livestream.","type":"string"},"ingest_server":{"description":"The server URL to which the RTMP encoder sends the video and audio data.","type":"string"},"meeting_id":{"description":"The ID of the meeting.","type":"string"},"name":{"description":"Name of the livestream.","type":"string"},"playback_url":{"description":"The web address that viewers can use to watch the livestream.","type":"string"},"status":{"enum":["LIVE","IDLE","ERRORED","INVOKED"],"type":"string"},"stream_key":{"description":"Unique key for accessing each livestream.","type":"string"},"updated_at":{"description":"Timestamp the object was updated at. The time is returned in ISO format.","type":"string"}},"type":"object"},"paging":{"properties":{"end_offset":{"example":1,"type":"integer"},"start_offset":{"example":1,"type":"integer"},"total_count":{"example":1,"type":"integer"}},"type":"object"},"session":{"properties":{"created_at":{"description":"Timestamp the object was created at. The time is returned in ISO format.","format":"date-time","type":"string"},"err_message":{"type":"string"},"id":{"description":"ID of the session.","type":"string"},"ingest_seconds":{"description":"The time duration for which the input was given or the meeting was streamed.","type":"number"},"invoked_time":{"description":"Timestamp the object was invoked. The time is returned in ISO format.","format":"date-time","type":"string"},"livestream_id":{"type":"string"},"started_time":{"description":"Timestamp the object was started. The time is returned in ISO format.","format":"date-time","type":"string"},"stopped_time":{"description":"Timestamp the object was stopped. The time is returned in ISO format.","format":"date-time","type":"string"},"updated_at":{"description":"Timestamp the object was updated at. The time is returned in ISO format.","format":"date-time","type":"string"},"viewer_seconds":{"description":"The total view time for which the viewers watched the stream.","type":"number"}},"type":"object"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Fetch livestream details using livestream ID","tags":["Live streams"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}/active-livestream-session":{"get":{"description":"Returns details of all active livestreams for the given livestream ID. Retreive the livestream ID using the `Start livestreaming a meeting` API.","operationId":"get-v2-active-livestream-session-details","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"in":"path","name":"livestream_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":{"data":{"livestream":{"created_at":"2023-07-15T07:08:26.634Z","disabled":false,"id":"b60ef3da-fbbb-441b-9168-8235b0035248","ingest_server":"rtmps://live.cloudflare.com:443/live/","meeting_id":"bbb87945-df1c-49d9-8159-262a7ae6cfde","name":null,"playback_url":"https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8","status":"LIVE","stream_key":"f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4","updated_at":"2023-07-15T07:08:40.726Z"},"session":{"created_at":"2023-07-15T07:08:40.742Z","err_message":null,"id":"cf55a850-c3fd-46b5-b5d2-25b3b9aa1686","ingest_seconds":60,"invoked_time":null,"livestream_id":"b60ef3da-fbbb-441b-9168-8235b0035248","started_time":"2023-07-15T07:08:39.000Z","stopped_time":null,"updated_at":"2023-07-15T07:08:40.742Z","viewer_seconds":60}},"success":true}}},"schema":{"properties":{"data":{"properties":{"livestream":{"properties":{"created_at":{"description":"Timestamp the object was created at. The time is returned in ISO format.","format":"date-time","type":"string"},"disabled":{"description":"Specifies if the livestream was disabled.","type":"string"},"id":{"type":"string"},"ingest_server":{"description":"The server URL to which the RTMP encoder sends the video and audio data.","type":"string"},"meeting_id":{"description":"ID of the meeting.","type":"string"},"name":{"description":"Name of the livestream.","type":"string"},"playback_url":{"description":"The web address that viewers can use to watch the livestream.","type":"string"},"status":{"enum":["LIVE","IDLE","ERRORED","INVOKED"],"type":"string"},"stream_key":{"description":"Unique key for accessing each livestream.","type":"string"},"updated_at":{"description":"Timestamp the object was updated at. The time is returned in ISO format.","format":"date-time","type":"string"}},"type":"object"},"session":{"properties":{"created_at":{"description":"Timestamp the object was created at. The time is returned in ISO format.","format":"date-time","type":"string"},"err_message":{"type":"string"},"id":{"type":"string"},"ingest_seconds":{"description":"The time duration for which the input was given or the meeting was streamed.","type":"string"},"invoked_time":{"description":"Timestamp the object was invoked. The time is returned in ISO format.","format":"date-time","type":"string"},"livestream_id":{"type":"string"},"started_time":{"description":"Timestamp the object was started. The time is returned in ISO format.","format":"date-time","type":"string"},"stopped_time":{"description":"Timestamp the object was stopped. The time is returned in ISO format.","format":"date-time","type":"string"},"updated_at":{"description":"Timestamp the object was updated at. The time is returned in ISO format.","format":"date-time","type":"string"},"viewer_seconds":{"description":"The total view time for which the viewers watched the stream.","type":"string"}},"type":"object"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Fetch active livestream session details","tags":["Live streams"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}/disable":{"put":{"description":"Disables a livestream for the given livestream ID. Retreive the livestream ID using the `Start livestreaming a meeting` API.","operationId":"disable-livestream","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"in":"path","name":"livestream_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1":{"value":{"data":{"created_at":"2019-08-24T14:15:22Z","disabled":false,"id":"string","ingest_server":"string","meeting_id":"string","name":"string","org_id":"string","playback_url":"string","status":"LIVE","stream_key":"string","updated_at":"2019-08-24T14:15:22Z"},"success":true}}},"schema":{"properties":{"LivestreamBase":{"$ref":"#/components/schemas/realtimekit_LivestreamBase"},"success":{"$ref":"#/components/schemas/realtimekit_success"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Disable a livestream","tags":["Live streams"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}/enable":{"put":{"description":"Enables a livestream for the given livestream ID. Retreive the livestream ID using the `Start livestreaming a meeting` API.","operationId":"enable-livestream","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"in":"path","name":"livestream_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/realtimekit_LivestreamBase"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Enable a livestream","tags":["Live streams"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/livestreams/{livestream_id}/reset-stream-key":{"post":{"description":"Resets the stream key for the given livestream ID. Retreive the livestream ID using the `Start livestreaming a meeting` API.","operationId":"reset-stream-key","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"in":"path","name":"livestream_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{}},"responses":{"200":{"content":{"application/json":{"examples":{"Example 1":{"value":{"data":{"created_at":"2023-07-15T11:58:08.404Z","disabled":true,"id":"61e03cb4-d4da-42ad-9169-f53360f4f4b4","ingest_server":"rtmps://live.cloudflare.com:443/live/","meeting_id":"bbb03399-24e3-4b0c-90ec-172e97e636be","name":null,"playback_url":"https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8","status":"LIVE","stream_key":"","updated_at":"2023-07-15T12:02:48.242Z"},"success":true}}},"schema":{"properties":{"data":{"properties":{"created_at":{"description":"Timestamp the object was created at. The time is returned in ISO format.","format":"date-time","type":"string"},"disabled":{"description":"Specifies if the livestream was disabled.","type":"string"},"id":{"description":"The ID of the livestream.","type":"string"},"ingest_server":{"description":"The server URL to which the RTMP encoder sends the video and audio data.","type":"string"},"meeting_id":{"description":"The ID of the meeting.","type":"string"},"name":{"description":"Name of the livestream.","type":"string"},"playback_url":{"description":"The web address that viewers can use to watch the livestream.","type":"string"},"status":{"enum":["LIVE","IDLE","ERRORED","INVOKED"],"type":"string"},"stream_key":{"description":"Unique key for accessing each livestream.","type":"string"},"updated_at":{"description":"Timestamp the object was updated at. The time is returned in ISO format.","format":"date-time","type":"string"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}},"application/xml":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/realtimekit_LivestreamBase"},"success":{"type":"string"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Reset a livestream's stream key","tags":["Live streams"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/meetings":{"get":{"description":"Returns all meetings for the given App ID.","operationId":"get_all_meetings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_pageNo"},{"$ref":"#/components/parameters/realtimekit_perPage"},{"$ref":"#/components/parameters/realtimekit_startTime"},{"$ref":"#/components/parameters/realtimekit_endTime"},{"$ref":"#/components/parameters/realtimekit_search"}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetAllMeetings"}},"security":[{"api_token":[]}],"summary":"Fetch all meetings for an App","tags":["Meetings"],"x-api-token-group":["Realtime Admin","Realtime"]},"post":{"description":"Create a meeting for the given App ID.","operationId":"create_meeting","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}}],"requestBody":{"$ref":"#/components/requestBodies/realtimekit_CreateMeetingBody"},"responses":{"201":{"$ref":"#/components/responses/realtimekit_GetMeeting"}},"security":[{"api_token":[]}],"summary":"Create a meeting","tags":["Meetings"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}":{"get":{"description":"Returns a meeting details in an App for the given meeting ID.","operationId":"get_meeting","parameters":[{"in":"query","name":"name","schema":{"type":"string"}},{"description":"ID of the meeting. Fetch the meeting ID using the create a meeting API.","in":"path","name":"meeting_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetMeeting"},"500":{"$ref":"#/components/responses/realtimekit_GenericError"}},"security":[{"api_token":[]}],"summary":"Fetch a meeting for an App","tags":["Meetings"],"x-api-token-group":["Realtime Admin","Realtime"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_meeting_id"}],"patch":{"description":"Updates a meeting in an App for the given meeting ID.","operationId":"update_meeting","parameters":[{"description":"ID of the meeting. Fetch the meeting ID using the create a meeting API.","in":"path","name":"meeting_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/realtimekit_UpdateMeetingBody"},"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetMeeting"},"500":{"$ref":"#/components/responses/realtimekit_GenericError"}},"security":[{"api_token":[]}],"summary":"Update a meeting","tags":["Meetings"],"x-api-token-group":["Realtime Admin","Realtime"]},"put":{"description":"Replaces all the details for the given meeting ID.","operationId":"replace_meeting","parameters":[{"description":"ID of the meeting. Fetch the meeting ID using the create a meeting API.","in":"path","name":"meeting_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/realtimekit_CreateMeetingBody"},"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetMeeting"}},"security":[{"api_token":[]}],"summary":"Replace a meeting","tags":["Meetings"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream":{"get":{"description":"Returns details of all active livestreams for the given meeting ID.","operationId":"get-v2-meetings-meetingId-active-livestream","parameters":[{"description":"ID of the meeting","in":"path","name":"meeting_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":{"data":{"created_at":"2023-07-15T11:58:08.404Z","disabled":false,"id":"61e03cb4-d4da-42ad-9169-f53360f4f4b4","meeting_id":"bbb03399-24e3-4b0c-90ec-172e97e636be","name":null,"playback_url":"https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8","status":"LIVE","updated_at":"2023-07-15T11:58:24.278Z"},"success":true}}},"schema":{"properties":{"data":{"properties":{"created_at":{"description":"Timestamp the object was created at. The time is returned in ISO format.","format":"date-time","type":"string"},"disabled":{"description":"Specifies if the livestream was disabled.","type":"string"},"id":{"description":"The livestream ID.","type":"string"},"ingest_server":{"description":"The server URL to which the RTMP encoder sends the video and audio data.","type":"string"},"meeting_id":{"type":"string"},"name":{"description":"Name of the livestream.","nullable":true,"type":"string"},"playback_url":{"description":"The web address that viewers can use to watch the livestream.","type":"string"},"status":{"enum":["LIVE","IDLE","ERRORED","INVOKED"],"type":"string"},"stream_key":{"description":"Unique key for accessing each livestream.","type":"string"},"updated_at":{"description":"Timestamp the object was updated at. The time is returned in ISO format.","format":"date-time","type":"string"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Fetch active livestreams for a meeting","tags":["Live streams"],"x-api-token-group":["Realtime Admin","Realtime"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_meeting_id"}]},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-livestream/stop":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_meeting_id"}],"post":{"description":"Stops the active livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the `Create a meeting` API.","operationId":"stop_livestreaming","parameters":[{"description":"ID of the meeting","in":"path","name":"meeting_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{}},"responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":{"data":{"message":"Stopped live stream successfully"},"success":true}}},"schema":{"properties":{"data":{"properties":{"message":{"type":"string"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Stop livestreaming a meeting","tags":["Live streams"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session":{"get":{"description":"Returns details of an ongoing active session for the given meeting ID.","operationId":"GetActiveSession","parameters":[{"$ref":"#/components/parameters/realtimekit_meetingId"}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetActiveSession"},"404":{"$ref":"#/components/responses/realtimekit_GetActiveSessionNotFound"}},"security":[{"api_token":[]}],"summary":"Fetch details of an active session","tags":["Active session"],"x-api-token-group":["Realtime Admin","Realtime"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_meeting_id"}]},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick":{"post":{"description":"Kicks one or more participants from an active session using user ID or custom participant ID.","operationId":"KickPartcipants","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_meetingId"}],"requestBody":{"$ref":"#/components/requestBodies/realtimekit_KickParticipantsBody"},"responses":{"200":{"$ref":"#/components/responses/realtimekit_KickParticipants"},"404":{"$ref":"#/components/responses/realtimekit_ParticipantNotFound"}},"security":[{"api_token":[]}],"summary":"Kick participants from an active session","tags":["Active session"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/kick-all":{"post":{"description":"Kicks all participants from an active session for the given meeting ID.","operationId":"KickAllParticipants","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_meetingId"}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_KickAllParticipants"}},"security":[{"api_token":[]}],"summary":"Kick all participants","tags":["Active session"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/mute":{"post":{"description":"Mutes one or more participants from an active session using user ID or custom participant ID.","operationId":"MuteParticipants","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_meetingId"}],"requestBody":{"$ref":"#/components/requestBodies/realtimekit_KickParticipantsBody"},"responses":{"200":{"$ref":"#/components/responses/realtimekit_MuteParticipants"}},"security":[{"api_token":[]}],"summary":"Mute participants of an active session","tags":["Active session"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/mute-all":{"post":{"description":"Mutes all participants of an active session for the given meeting ID.","operationId":"MuteAllParticipants","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_meetingId"}],"requestBody":{"$ref":"#/components/requestBodies/realtimekit_MuteAllParticipantsBody"},"responses":{"200":{"$ref":"#/components/responses/realtimekit_MuteAllParticipants"}},"security":[{"api_token":[]}],"summary":"Mute all participants","tags":["Active session"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/poll":{"post":{"description":"Creates a new poll in an active session for the given meeting ID.","operationId":"CreatePoll","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_meetingId"}],"requestBody":{"$ref":"#/components/requestBodies/realtimekit_CreatePollBody"},"responses":{"201":{"$ref":"#/components/responses/realtimekit_CreatePoll"},"400":{"description":"Bad Request"}},"security":[{"api_token":[]}],"summary":"Create a poll","tags":["Active session"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestream":{"get":{"description":"Returns livestream session details for the given meeting ID. Retreive the meeting ID using the `Create a meeting` API.","operationId":"livestream-session-details","parameters":[{"description":"The page number from which you want your page search results to be displayed.","in":"query","name":"page_no","schema":{"type":"integer"}},{"description":"Number of results per page.","in":"query","name":"per_page","schema":{"type":"integer"}},{"description":"ID of the meeting","in":"path","name":"meeting_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example-0":{"summary":"Get LiveStream From StreamId Success","value":{"data":{"livestream":{"created_at":"2023-07-15T07:08:26.634Z","disabled":false,"id":"b60ef3da-fbbb-441b-9168-8235b0035248","ingest_server":"rtmps://live.cloudflare.com:443/live/","meeting_id":"aaa87945-df1c-49d9-8159-262a7ae6cfde","name":null,"playback_url":"https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8","status":"LIVE","stream_key":"f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4","updated_at":"2023-07-15T07:08:40.726Z"},"sessions":[{"created_at":"2023-07-15T07:08:40.742Z","err_message":null,"id":"cf55a850-c3fd-46b5-b5d2-25b3b9aa1686","ingest_seconds":60,"invoked_time":null,"livestream_id":"b60ef3da-fbbb-441b-9168-8235b0035248","started_time":"2023-07-15T07:08:39.000Z","stopped_time":null,"updated_at":"2023-07-15T07:08:40.742Z","viewer_seconds":60}]},"paging":{"end_offset":1,"start_offset":1,"total_count":1},"success":true}}},"schema":{"properties":{"data":{"properties":{"livestreams":{"items":{"properties":{"created_at":{"description":"The timestamp at which the livestream was created. The time is returned in ISO format.","format":"date-time","type":"string"},"disabled":{"description":"Specifies if the livestream was disabled.","type":"boolean"},"id":{"description":"The livestream ID.","type":"string"},"ingest_server":{"description":"The server URL to which the RTMP encoder sends the video and audio data.","type":"string"},"meeting_id":{"description":"The ID of the meeting that was livestreamed.","type":"string"},"name":{"description":"Name of the livestream.","nullable":true,"type":"string"},"playback_url":{"description":"The web address that viewers can use to watch the livestream.","type":"string"},"status":{"enum":["LIVE","INVOKED","ERRORED","IDLE"],"type":"string"},"stream_key":{"description":"Unique key for accessing each livestream.","type":"string"},"updated_at":{"description":"The timestamp at which the livestream was updated. The time is returned in ISO format.","format":"date-time","type":"string"}},"type":"object"},"type":"array"},"paging":{"properties":{"end_offset":{"example":1,"type":"integer"},"start_offset":{"example":1,"type":"integer"},"total_count":{"example":1,"type":"integer"}},"type":"object"},"sessions":{"properties":{"created_at":{"description":"The timestamp at which the livestream was created. The time is returned in ISO format.","format":"date-time","type":"string"},"err_message":{"type":"string"},"id":{"description":"The ID of the livestream session.","type":"string"},"ingest_seconds":{"description":"The time duration for which the input was given or the meeting was streamed.","type":"string"},"invoked_time":{"description":"The time at which the livestream was invoked.","format":"date-time","type":"string"},"livestream_id":{"description":"The ID of the livestream.","type":"string"},"started_time":{"description":"The time at which the livestream was started.","format":"date-time","type":"string"},"stopped_time":{"description":"The time at which the livestream was stopped.","format":"date-time","type":"string"},"updated_at":{"description":"The timestamp at which the livestream was updated. The time is returned in ISO format.","format":"date-time","type":"string"}},"type":"object"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Fetch livestream session details for a meeting","tags":["Live streams"],"x-api-token-group":["Realtime Admin","Realtime"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_meeting_id"}]},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/livestreams":{"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_meeting_id"}],"post":{"description":"Starts livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the `Create a meeting` API.","operationId":"start-livestreaming","parameters":[{"description":"ID of the meeting","in":"path","name":"meeting_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"example-1":{"value":{"name":"prdmmp-xhycsl"}}},"schema":{"properties":{"name":{"nullable":true,"pattern":"^[a-zA-Z0-9-_]*$","type":"string"},"video_config":{"properties":{"height":{"description":"Height of the livestreaming video in pixels","type":"integer"},"width":{"description":"Width of the livestreaming video in pixels","type":"integer"}},"type":"object"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"examples":{"example-1":{"value":{"data":{"id":"7088bba8-f522-49a8-b59b-3cd0e946bbb0","ingest_server":"rtmps://live.cloudflare.com:443/live/","playback_url":"https://customer-s8oj0c1n5ek8ah1e.cloudflarestream.com/7de6a3fec0f9c05bf1df140950d3a237/manifest/video.m3u8","status":"INVOKED","stream_key":"f26566285faca6fbe2e79a73a66rsrrsrrsr3cde23a2bb7dbc6c2c1761b98f4e4"},"success":true}}},"schema":{"properties":{"data":{"properties":{"id":{"description":"The livestream ID.","type":"string"},"ingest_server":{"description":"The server URL to which the RTMP encoder sends the video and audio data.","type":"string"},"playback_url":{"description":"The web address that viewers can use to watch the livestream.","type":"string"},"status":{"enum":["LIVE","IDLE","ERRORED","INVOKED"],"type":"string"},"stream_key":{"description":"Unique key for accessing each livestream.","type":"string"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Created"}},"security":[{"api_token":[]}],"summary":"Start livestreaming a meeting","tags":["Live streams"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants":{"get":{"description":"Returns all participants detail for the given meeting ID.","operationId":"get_meeting_participants","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_pageNo"},{"$ref":"#/components/parameters/realtimekit_perPage"},{"description":"ID of the meeting. Fetch the meeting ID using the create a meeting API.","in":"path","name":"meeting_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetAllParticipants"},"500":{"$ref":"#/components/responses/realtimekit_GenericError"}},"security":[{"api_token":[]}],"summary":"Fetch all participants of a meeting","tags":["Meetings"],"x-api-token-group":["Realtime Admin","Realtime"]},"post":{"description":"Adds a participant to the given meeting ID.","operationId":"add_participant","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of the meeting. Fetch the meeting ID using the create a meeting API.","in":"path","name":"meeting_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/realtimekit_AddParticipantBody"},"responses":{"201":{"$ref":"#/components/responses/realtimekit_AddParticipant"},"500":{"$ref":"#/components/responses/realtimekit_GenericError"}},"security":[{"api_token":[]}],"summary":"Add a participant","tags":["Meetings"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}":{"delete":{"description":"Deletes a participant for the given meeting and participant ID.","operationId":"delete_meeting_participant","parameters":[{"description":"ID of the meeting. You can fetch the meeting ID using the create a meeting API.","in":"path","name":"meeting_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of the participant. You can fetch the participant ID using the add a participant API.","in":"path","name":"participant_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_DeleteParticipant"},"500":{"$ref":"#/components/responses/realtimekit_GenericError"}},"security":[{"api_token":[]}],"summary":"Delete a participant","tags":["Meetings"],"x-api-token-group":["Realtime Admin","Realtime"]},"get":{"description":"Returns a participant details for the given meeting and participant ID.","operationId":"get_meeting_participant","parameters":[{"description":"ID of the meeting. You can fetch the meeting ID using the create a meeting API.","in":"path","name":"meeting_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of the participant. You can fetch the participant ID using the add a participant API.","in":"path","name":"participant_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetParticipant"},"500":{"$ref":"#/components/responses/realtimekit_GenericError"}},"security":[{"api_token":[]}],"summary":"Fetch a participant's detail","tags":["Meetings"],"x-api-token-group":["Realtime Admin","Realtime"]},"parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_meeting_id"}],"patch":{"description":"Updates a participant's details for the given meeting and participant ID.","operationId":"edit_participant","parameters":[{"description":"ID of the meeting. You can fetch the meeting ID using the create a meeting API.","in":"path","name":"meeting_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of the participant. You can fetch the participant ID using the add a participant API.","in":"path","name":"participant_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/realtimekit_EditParticipantBody"},"responses":{"200":{"$ref":"#/components/responses/realtimekit_AddParticipant"},"500":{"$ref":"#/components/responses/realtimekit_GenericError"}},"security":[{"api_token":[]}],"summary":"Edit a participant's detail","tags":["Meetings"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/participants/{participant_id}/token":{"post":{"description":"Regenerates participant's authentication token for the given meeting and participant ID.","operationId":"regenerate_token","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of the meeting. You can fetch the meeting ID using the create a meeting API.","in":"path","name":"meeting_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of the participant. You can fetch the participant ID using the add a  participant API.","in":"path","name":"participant_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_RegenToken"},"500":{"$ref":"#/components/responses/realtimekit_GenericError"}},"security":[{"api_token":[]}],"summary":"Refresh participant's authentication token","tags":["Meetings"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/presets":{"get":{"description":"Fetches all the presets belonging to an App.","operationId":"get-presets","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_perPage"},{"$ref":"#/components/parameters/realtimekit_pageNo"}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetAllPresets"}},"security":[{"api_token":[]}],"summary":"Fetch all presets","tags":["Presets"],"x-api-token-group":["Realtime Admin","Realtime"]},"post":{"description":"Creates a preset belonging to the current App","operationId":"post-presets","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}}],"requestBody":{"$ref":"#/components/requestBodies/realtimekit_CreatePresetBody"},"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetPresetBody"}},"security":[{"api_token":[]}],"summary":"Create a preset","tags":["Presets"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/presets/{preset_id}":{"delete":{"description":"Deletes a preset using the provided preset ID","operationId":"delete-presets-preset_id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of the preset to fetch","in":"path","name":"preset_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetPresetBody"}},"security":[{"api_token":[]}],"summary":"Delete a preset","tags":["Presets"],"x-api-token-group":["Realtime Admin","Realtime"]},"get":{"description":"Fetches details of a preset using the provided preset ID","operationId":"get-presets-preset_id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of the preset to fetch","in":"path","name":"preset_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetPresetBody"}},"security":[{"api_token":[]}],"summary":"Fetch details of a preset","tags":["Presets"],"x-api-token-group":["Realtime Admin","Realtime"]},"patch":{"description":"Update a preset by the provided preset ID","operationId":"patch-presets-preset_id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of the preset to fetch","in":"path","name":"preset_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/realtimekit_UpdatePresetBody"},"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetPresetBody"}},"security":[{"api_token":[]}],"summary":"Update a preset","tags":["Presets"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/recordings":{"get":{"description":"Returns all recordings for an App. If the `meeting_id` parameter is passed, returns all recordings for the given meeting ID.","operationId":"get_all_recordings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of a meeting. Optional. Will limit results to only this meeting if passed.","in":"query","name":"meeting_id","schema":{"format":"uuid","type":"string"}},{"$ref":"#/components/parameters/realtimekit_pageNo"},{"$ref":"#/components/parameters/realtimekit_perPage"},{"description":"If passed, only shows expired/non-expired recordings on RealtimeKit's bucket","in":"query","name":"expired","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/realtimekit_search"},{"$ref":"#/components/parameters/realtimekit_recordingSortBy"},{"$ref":"#/components/parameters/realtimekit_sortOrder"},{"$ref":"#/components/parameters/realtimekit_startTime"},{"$ref":"#/components/parameters/realtimekit_endTime"},{"$ref":"#/components/parameters/realtimekit_recordingStatus"}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetRecordings"},"201":{"description":"Created"}},"security":[{"api_token":[]}],"summary":"Fetch all recordings for an App","tags":["Recordings"],"x-api-token-group":["Realtime Admin","Realtime"]},"post":{"description":"Starts recording a meeting. The meeting can be started by an App admin directly, or a participant with permissions to start a recording, based on the type of authorization used.","operationId":"start_recording","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}}],"requestBody":{"$ref":"#/components/requestBodies/realtimekit_StartRecording"},"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetRecording"}},"security":[{"api_token":[]}],"summary":"Start recording a meeting","tags":["Recordings"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/recordings/active-recording/{meeting_id}":{"get":{"description":"Returns the active recording details for the given meeting ID.","operationId":"get_active_recording","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of the meeting","in":"path","name":"meeting_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetActiveRecording"},"404":{"$ref":"#/components/responses/realtimekit_GenericError"}},"security":[{"api_token":[]}],"summary":"Fetch active recording","tags":["Recordings"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/recordings/track":{"post":{"description":"Starts a track recording in a meeting. Track recordings consist of \"layers\". Layers are used to map audio/video tracks in a meeting to output destinations. More information about track recordings is available in the [Track Recordings Guide Page](https://docs.realtime.cloudflare.com/guides/capabilities/recording/recording-overview).","operationId":"startTrackRecordingForAMeeting","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}}],"requestBody":{"$ref":"#/components/requestBodies/realtimekit_StartTrackRecordingBody"},"responses":{"200":{"description":"OK"}},"security":[{"api_token":[]}],"summary":"Start recording audio and video tracks","tags":["Recordings"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/recordings/{recording_id}":{"get":{"description":"Returns details of a recording for the given recording ID.","operationId":"get_one_recording","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of the recording","in":"path","name":"recording_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetRecording"}},"security":[{"api_token":[]}],"summary":"Fetch details of a recording","tags":["Recordings"],"x-api-token-group":["Realtime Admin","Realtime"]},"put":{"description":"Pause/Resume/Stop a given recording ID.","operationId":"pause_resume_stop_recording","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"description":"A Cloudflare-generated unique identifier for an item.","example":"2a95132c15732412d22c1476fa83f27a","in":"path","name":"app_id","required":true,"schema":{"maxLength":32,"minLength":32,"pattern":"^[a-f0-9]{32}$","type":"string"}},{"description":"ID of the recording","in":"path","name":"recording_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"enum":["stop","pause","resume"],"type":"string"}},"required":["action"],"type":"object"}}}},"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetRecording"}},"security":[{"api_token":[]}],"summary":"Pause/Resume/Stop recording","tags":["Recordings"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/sessions":{"get":{"description":"Returns details of all sessions of an App.","operationId":"GetSessions","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_pageNo"},{"$ref":"#/components/parameters/realtimekit_perPage"},{"$ref":"#/components/parameters/realtimekit_sortBy"},{"$ref":"#/components/parameters/realtimekit_sortOrder"},{"$ref":"#/components/parameters/realtimekit_startTime"},{"$ref":"#/components/parameters/realtimekit_endTime"},{"$ref":"#/components/parameters/realtimekit_participants"},{"$ref":"#/components/parameters/realtimekit_status"},{"description":"Search string that matches sessions based on meeting title, meeting ID, and session ID","in":"query","name":"search","schema":{"type":"string"}},{"description":"ID of the meeting that sessions should be associated with","in":"query","name":"associated_id","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetSessions"}},"security":[{"api_token":[]}],"summary":"Fetch all sessions of an App","tags":["Sessions"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/sessions/peer-report/{peer_id}":{"get":{"description":"Returns details of the given peer ID along with call statistics for the given session ID.","operationId":"GetParticipantDataFromPeerId","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"Comma separated list of filters to apply. Note that there must be no spaces between the filters.","in":"query","name":"filters","schema":{"enum":["device_info","ip_information","precall_network_information","events","quality_stats"],"type":"string"}},{"description":"ID of the peer","in":"path","name":"peer_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetParticipantDataFromPeerId"}},"security":[{"api_token":[]}],"summary":"Fetch details of peer","tags":["Sessions"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}":{"get":{"description":"Returns data of the given session ID including recording details.","operationId":"GetSessionDetails","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"List all breakout rooms","in":"query","name":"include_breakout_rooms","schema":{"default":false,"type":"boolean"}},{"description":"ID of the session","in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetSessionDetails"}},"security":[{"api_token":[]}],"summary":"Fetch details of a session","tags":["Sessions"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/chat":{"get":{"description":"Returns a URL to download all chat messages of the session ID in CSV format.\n","operationId":"GetSessionChat","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of the session","in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetSessionChat"}},"security":[{"api_token":[]}],"summary":"Fetch all chat messages of a session","tags":["Sessions"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/livestream-sessions":{"get":{"description":"Returns livestream session details for the given session ID. Retreive the session ID using the `Fetch all sessions of an App` API.","operationId":"get-v2-livestreamsession-session-meetingId-active-livestream","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"Number of results per page.","in":"query","name":"per_page","schema":{"type":"number"}},{"description":"The page number from which you want your page search results to be displayed.","in":"query","name":"page_no","schema":{"type":"number"}},{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":{"data":{"data":[{"created_at":"2023-07-15T07:08:40.742Z","err_message":null,"id":"cf55a850-c3fd-46b5-b5d2-25b3b9aa1686","ingest_seconds":118,"invoked_time":null,"livestream_id":"b60ef3da-fbbb-441b-9168-8235b0035123","started_time":"2023-07-15T07:08:39.000Z","stopped_time":"2023-07-15T07:10:45.000Z","updated_at":"2023-07-15T07:11:47.274Z","viewer_seconds":116.11599994199997}],"paging":{"end_offset":1,"start_offset":1,"total_count":1}},"success":true}}},"schema":{"properties":{"data":{"properties":{"created_at":{"description":"Timestamp the object was created at. The time is returned in ISO format.","format":"date-time","type":"string"},"err_message":{"enum":["LIVE","IDLE","ERRORED","INVOKED"],"type":"string"},"id":{"description":"The livestream session ID.","type":"string"},"ingest_seconds":{"description":"The time duration for which the input was given or the meeting was streamed.","type":"number"},"invoked_time":{"description":"Name of the livestream.","nullable":true,"type":"string"},"livestream_id":{"description":"The ID of the livestream.","type":"string"},"paging":{"properties":{"end_offset":{"type":"number"},"start_offset":{"type":"number"},"total_count":{"type":"number"}},"type":"object"},"stopped_time":{"description":"Specifies if the livestream was disabled.","format":"date-time","type":"string"},"updated_at":{"description":"Timestamp the object was updated at. The time is returned in ISO format.","format":"date-time","type":"string"},"viewer_seconds":{"description":"The total view time for which the viewers watched the stream.","type":"number"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"api_token":[]}],"summary":"Fetch livestream session details using a session ID","tags":["Live streams"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants":{"get":{"description":"Returns a list of participants for the given session ID.","operationId":"GetSessionParticipants","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"$ref":"#/components/parameters/realtimekit_search"},{"$ref":"#/components/parameters/realtimekit_pageNo"},{"$ref":"#/components/parameters/realtimekit_perPage"},{"$ref":"#/components/parameters/realtimekit_sortOrder"},{"$ref":"#/components/parameters/realtimekit_participantsSortBy"},{"description":"if true, response includes all the peer events of participants.","in":"query","name":"include_peer_events","schema":{"default":false,"type":"boolean"}},{"description":"In breakout room sessions, the view parameter can be set to `raw` for session specific duration for participants or `consolidated` to accumulate breakout room durations.","in":"query","name":"view","schema":{"default":"raw","enum":["raw","consolidated"],"type":"string"}},{"description":"ID of the session","in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetSessionParticipants"}},"security":[{"api_token":[]}],"summary":"Fetch participants list of a session","tags":["Sessions"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/participants/{participant_id}":{"get":{"description":"Returns details of the given participant ID along with call statistics for the given session ID.","operationId":"GetParticipantDetails","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"allowEmptyValue":true,"description":"Comma separated list of filters to apply. Note that there must be no spaces between the filters.","in":"query","name":"filters","schema":{"enum":["device_info","ip_information","precall_network_information","events","quality_stats"],"example":"device_info,ip_information,events","type":"string"}},{"description":"if true, response includes all the peer events of participant.","in":"query","name":"include_peer_events","schema":{"default":false,"type":"boolean"}},{"description":"ID of the participant","in":"path","name":"participant_id","required":true,"schema":{"type":"string"}},{"description":"ID of the session","in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetParticipantDetails"}},"security":[{"api_token":[]}],"summary":"Fetch details of a participant","tags":["Sessions"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary":{"get":{"description":"Returns a Summary URL to download the Summary of Transcripts for the session ID as plain text.","operationId":"GetSessionSummary","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetSessionTranscriptSummary"}},"security":[{"api_token":[]}],"summary":"Fetch summary of transcripts for a session","tags":["Sessions"],"x-api-token-group":["Realtime Admin","Realtime"]},"post":{"description":"Trigger Summary generation of Transcripts for the session ID.","operationId":"post-sessions-session_id-summary","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"2XX":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"message":{"type":"string"},"success":{"type":"boolean"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Success"}},"security":[{"api_token":[]}],"summary":"Generate summary of Transcripts for the session","tags":["Sessions"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/transcript":{"get":{"description":"Returns a URL to download the transcript for the session ID in CSV format.","operationId":"GetSessionTranscript","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of the session","in":"path","name":"session_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/realtimekit_GetSessionTranscript"}},"security":[{"api_token":[]}],"summary":"Fetch the complete transcript for a session","tags":["Sessions"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/webhooks":{"get":{"description":"Returns details of all webhooks for an App.","operationId":"getAllWebhooks","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/realtimekit_WebhooksListSuccessResponse"}}},"description":"Operation successful"},"401":{"content":{"application/json":{"examples":{"default":{"value":"{\n  message: \"Unauthorized\"\n}\n"}}}},"description":"Invalid credentials"}},"security":[{"api_token":[]}],"summary":"Fetch all webhooks details","tags":["Webhooks"],"x-api-token-group":["Realtime Admin","Realtime"]},"post":{"description":"Adds a new webhook to an App.","operationId":"addWebhook","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/realtimekit_WebhookRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/realtimekit_WebhookSuccessResponse"}}},"description":"Webhook registered successfully"},"400":{"content":{"application/json":{"examples":{"default":{"value":"{\n  success: false,\n  error: { code: 400, message: 'BAD_REQUEST: \"name\" is required' }\n}\n"}},"schema":{"$ref":"#/components/schemas/realtimekit_ErrorResponse"}}},"description":"Error - malformed request"},"401":{"content":{"application/json":{"examples":{"default":{"value":"{\n  message: \"Unauthorized\"\n}\n"}}}},"description":"Invalid credentials"}},"security":[{"api_token":[]}],"summary":"Add a webhook","tags":["Webhooks"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}":{"delete":{"description":"Removes a webhook for the given webhook ID.","operationId":"deleteWebhook","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of the webhook","in":"path","name":"webhook_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/realtimekit_WebhookSuccessResponse"}}},"description":"Operation successful"},"400":{"content":{"application/json":{"examples":{"default":{"value":"{\n  \"success\": false,\n  \"error\": { \"code\": 400, \"message\": \"BAD_REQUEST \\\"id\\\" must be a valid GUID\" }\n}\n"}},"schema":{"$ref":"#/components/schemas/realtimekit_ErrorResponse"}}},"description":"Error - malformed request"},"401":{"content":{"application/json":{"examples":{"default":{"value":"{\n  \"message\": \"Unauthorized\"\n}\n"}}}},"description":"Invalid credentials"}},"security":[{"api_token":[]}],"summary":"Delete a webhook","tags":["Webhooks"],"x-api-token-group":["Realtime Admin","Realtime"]},"get":{"description":"Returns webhook details for the given webhook ID.","operationId":"getWebhook","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of the webhook","in":"path","name":"webhook_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/realtimekit_WebhookSuccessResponse"}}},"description":"Operation successful"},"400":{"content":{"application/json":{"examples":{"default":{"value":"{\n  success: false,\n  error: { code: 400, message: 'BAD_REQUEST: \"id\" must be a valid GUID' }\n}\n"}},"schema":{"$ref":"#/components/schemas/realtimekit_ErrorResponse"}}},"description":"Error - malformed request"},"401":{"content":{"application/json":{"examples":{"default":{"value":"{\n  message: \"Unauthorized\"\n}\n"}}}},"description":"Invalid credentials"}},"security":[{"api_token":[]}],"summary":"Fetch details of a webhook","tags":["Webhooks"],"x-api-token-group":["Realtime Admin","Realtime"]},"patch":{"description":"Edits the webhook details for the given webhook ID.","operationId":"editWebhook","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of the webhook","in":"path","name":"webhook_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":"{\n  \"name\": \"test\",\n  \"events\": [ \"meeting.started\" ],\n  \"url\": \"https://new-test-url.com\"\n}\n"}},"schema":{"$ref":"#/components/schemas/realtimekit_PatchWebhookRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"value":"{\n  \"success\": true,\n  \"data\": {\n    id: \"901e9adf-ebd9-41f0-9098-28171bc04ddd\",\n    \"name\": \"test\",\n    \"events\": [ \"meeting.started\" ],\n    \"url\": \"https://new-test-url.com\",\n    \"created_at\": \"2021-09-09T10:25:12.330Z\",\n    \"updated_at\": \"2021-09-09T10:25:12.376Z\"\n  }\n}\n"}},"schema":{"$ref":"#/components/schemas/realtimekit_WebhookSuccessResponse"}}},"description":"Operation successful"},"400":{"content":{"application/json":{"examples":{"default":{"value":"{\n  \"success\": false,\n  \"error\": { \"code\": 400, \"message\": \"BAD_REQUEST \\\"id\\\" must be a valid GUID\" }\n}\n"}},"schema":{"$ref":"#/components/schemas/realtimekit_ErrorResponse"}}},"description":"Error - malformed request"},"401":{"content":{"application/json":{"examples":{"default":{"value":"{\n  \"message\": \"Unauthorized\"\n}\n"}}}},"description":"Invalid credentials"}},"security":[{"api_token":[]}],"summary":"Edit a webhook","tags":["Webhooks"],"x-api-token-group":["Realtime Admin","Realtime"]},"put":{"description":"Replace all details for the given webhook ID.","operationId":"replaceWebhook","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_account_identifier"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/realtimekit_app_id"}},{"description":"ID of the webhook","in":"path","name":"webhook_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"default":{"value":"{\n  \"name\": \"test\",\n  \"events\": [ \"meeting.started\" ],\n  \"url\": \"https://new-test-url.com\"\n}\n"}},"schema":{"$ref":"#/components/schemas/realtimekit_WebhookRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"default":{"value":"{\n  \"success\": true,\n  \"data\": {\n    id: \"901e9adf-ebd9-41f0-9098-28171bc04ddd\",\n    \"name\": \"test\",\n    \"events\": [ \"meeting.started\" ],\n    \"url\": \"https://new-test-url.com\",\n    \"created_at\": \"2021-09-09T10:25:12.330Z\",\n    \"updated_at\": \"2021-09-09T10:25:12.376Z\"\n  }\n}\n"}},"schema":{"$ref":"#/components/schemas/realtimekit_WebhookSuccessResponse"}}},"description":"Operation successful"},"400":{"content":{"application/json":{"examples":{"default":{"value":"{\n  \"success\": false,\n  \"error\": { \"code\": 400, \"message\": \"BAD_REQUEST \\\"id\\\" must be a valid GUID\" }\n}\n"}},"schema":{"$ref":"#/components/schemas/realtimekit_ErrorResponse"}}},"description":"Error - malformed request"},"401":{"content":{"application/json":{"examples":{"default":{"value":"{\n  message: \"Unauthorized\"\n}\n"}}}},"description":"Invalid credentials"}},"security":[{"api_token":[]}],"summary":"Replace a webhook","tags":["Webhooks"],"x-api-token-group":["Realtime Admin","Realtime"]}},"/accounts/{account_id}/registrar/domains":{"get":{"description":"List domains handled by Registrar.","operationId":"registrar-domains-list-domains","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/registrar-api_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrar-api_domain_response_collection"}}},"description":"List domains response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/registrar-api_domain_response_collection"},{"$ref":"#/components/schemas/registrar-api_api-response-common-failure"}]}}},"description":"List domains response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List domains","tags":["Registrar Domains"],"x-api-token-group":null}},"/accounts/{account_id}/registrar/domains/{domain_name}":{"get":{"description":"Show individual domain.","operationId":"registrar-domains-get-domain","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"$ref":"#/components/schemas/registrar-api_domain_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/registrar-api_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrar-api_domain_response_single"}}},"description":"Get domain response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/registrar-api_domain_response_single"},{"$ref":"#/components/schemas/registrar-api_api-response-common-failure"}]}}},"description":"Get domain response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get domain","tags":["Registrar Domains"],"x-api-token-group":null},"put":{"description":"Update individual domain.","operationId":"registrar-domains-update-domain","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"$ref":"#/components/schemas/registrar-api_domain_name"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/registrar-api_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/registrar-api_domain_update_properties"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/registrar-api_domain_response_single"}}},"description":"Update domain response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/registrar-api_domain_response_single"},{"$ref":"#/components/schemas/registrar-api_api-response-common-failure"}]}}},"description":"Update domain response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update domain","tags":["Registrar Domains"],"x-api-token-group":null}},"/accounts/{account_id}/request-tracer/trace":{"post":{"operationId":"account-request-tracer-request-trace","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/request-tracer_identifier"}}],"requestBody":{"content":{"application/json":{"example":{"body":{"base64":"c29tZV9yZXF1ZXN0X2JvZHk="},"context":{"geoloc":{"city":"London"},"skip_challenge":true},"cookies":{"cookie_name_1":"cookie_value_1","cookie_name_2":"cookie_value_2"},"headers":{"header_name_1":"header_value_1","header_name_2":"header_value_2"},"method":"PUT","protocol":"HTTP/1.1","url":"https://some.zone/some_path"},"schema":{"properties":{"body":{"properties":{"base64":{"description":"Base64 encoded request body","example":"c29tZV9yZXF1ZXN0X2JvZHk=","type":"string","x-auditable":true},"json":{"description":"Arbitrary json as request body","type":"object"},"plain_text":{"description":"Request body as plain text","type":"string","x-auditable":true}},"type":"object"},"context":{"description":"Additional request parameters","properties":{"bot_score":{"description":"Bot score used for evaluating tracing request processing","type":"integer","x-auditable":true},"geoloc":{"description":"Geodata for tracing request","properties":{"city":{"example":"London","type":"string","x-auditable":true},"continent":{"type":"string","x-auditable":true},"is_eu_country":{"type":"boolean","x-auditable":true},"iso_code":{"type":"string","x-auditable":true},"latitude":{"type":"number","x-auditable":true},"longitude":{"type":"number","x-auditable":true},"postal_code":{"type":"string","x-auditable":true},"region_code":{"type":"string","x-auditable":true},"subdivision_2_iso_code":{"type":"string","x-auditable":true},"timezone":{"type":"string","x-auditable":true}},"type":"object"},"skip_challenge":{"description":"Whether to skip any challenges for tracing request (e.g.: captcha)","example":true,"type":"boolean","x-auditable":true},"threat_score":{"description":"Threat score used for evaluating tracing request processing","type":"integer","x-auditable":true}},"type":"object"},"cookies":{"additionalProperties":{"type":"string"},"description":"Cookies added to tracing request","example":{"cookie_name_1":"cookie_value_1","cookie_name_2":"cookie_value_2"},"type":"object"},"headers":{"additionalProperties":{"type":"string"},"description":"Headers added to tracing request","example":{"header_name_1":"header_value_1","header_name_2":"header_value_2"},"type":"object"},"method":{"description":"HTTP Method of tracing request","example":"PUT","type":"string","x-auditable":true},"protocol":{"description":"HTTP Protocol of tracing request","example":"HTTP/1.1","type":"string","x-auditable":true},"skip_response":{"description":"Skip sending the request to the Origin server after all rules evaluation","type":"boolean","x-auditable":true},"url":{"description":"URL to which perform tracing request","example":"https://some.zone/some_path","type":"string","x-auditable":true}},"required":["url","method"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/request-tracer_api-response-common"},{"properties":{"result":{"description":"Trace result with an origin status code","properties":{"status_code":{"description":"HTTP Status code of zone response","type":"integer","x-auditable":true},"trace":{"$ref":"#/components/schemas/request-tracer_trace"}},"type":"object"}},"type":"object"}],"type":"object"}}},"description":"Request Trace response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/request-tracer_api-response-common-failure"}]}}},"description":"Request Trace response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Request Trace","tags":["Account Request Tracer"],"x-api-token-group":["Allow Request Tracer Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/roles":{"get":{"description":"Get all available roles for an account.","operationId":"account-roles-list-roles","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of roles per page.","maximum":50,"minimum":5,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_collection_role_response"}}},"description":"List Roles response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"List Roles response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Roles","tags":["Account Roles"],"x-api-token-group":["SCIM Provisioning","Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["#organization:read"]}}},"/accounts/{account_id}/roles/{role_id}":{"get":{"description":"Get information about a specific role for an account.","operationId":"account-roles-role-details","parameters":[{"in":"path","name":"role_id","required":true,"schema":{"$ref":"#/components/schemas/iam_role_components-schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_role_response"}}},"description":"Role Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Role Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Role Details","tags":["Account Roles"],"x-api-token-group":["SCIM Provisioning","Account Settings Write","Account Settings Read"],"x-cfPermissionsRequired":{"enum":["#organization:read"]}}},"/accounts/{account_id}/rules/lists":{"get":{"description":"Fetches all lists in the account.","operationId":"lists-get-lists","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/lists_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_lists-response-collection"}}},"description":"Get lists response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_lists-response-collection"},{"$ref":"#/components/schemas/lists_api-response-common-failure"}]}}},"description":"Get lists response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get lists","tags":["Lists"],"x-api-token-group":["Account Filter Lists Read","Account Filter Lists Edit"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a new list of the specified kind.","operationId":"lists-create-a-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/lists_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/lists_description"},"kind":{"$ref":"#/components/schemas/lists_kind"},"name":{"$ref":"#/components/schemas/lists_name"}},"required":["name","kind"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-response-collection"}}},"description":"Create a list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_list-response-collection"},{"$ref":"#/components/schemas/lists_api-response-common-failure"}]}}},"description":"Create a list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a list","tags":["Lists"],"x-api-token-group":["Account Filter Lists Edit"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rules/lists/bulk_operations/{operation_id}":{"get":{"description":"Gets the current status of an asynchronous operation on a list.\n\nThe `status` property can have one of the following values: `pending`, `running`, `completed`, or `failed`. If the status is `failed`, the `error` property will contain a message describing the error.","operationId":"lists-get-bulk-operation-status","parameters":[{"in":"path","name":"operation_id","required":true,"schema":{"$ref":"#/components/schemas/lists_operation_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/lists_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_bulk-operation-response-single"}}},"description":"Get bulk operation status response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_bulk-operation-response-single"},{"$ref":"#/components/schemas/lists_api-response-common-failure"}]}}},"description":"Get bulk operation status response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get bulk operation status","tags":["Lists"],"x-api-token-group":["Account Filter Lists Edit","Account Filter Lists Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rules/lists/{list_id}":{"delete":{"description":"Deletes a specific list and all its items.","operationId":"lists-delete-a-list","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/lists_list_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/lists_account_id"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-delete-response-collection"}}},"description":"Delete a list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_list-delete-response-collection"},{"$ref":"#/components/schemas/lists_api-response-common-failure"}]}}},"description":"Delete a list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a list","tags":["Lists"],"x-api-token-group":["Account Filter Lists Edit"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the details of a list.","operationId":"lists-get-a-list","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/lists_list_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/lists_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-response-collection"}}},"description":"Get a list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_list-response-collection"},{"$ref":"#/components/schemas/lists_api-response-common-failure"}]}}},"description":"Get a list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a list","tags":["Lists"],"x-api-token-group":["Account Filter Lists Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates the description of a list.","operationId":"lists-update-a-list","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/lists_list_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/lists_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/lists_description"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-response-collection"}}},"description":"Update a list response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_list-response-collection"},{"$ref":"#/components/schemas/lists_api-response-common-failure"}]}}},"description":"Update a list response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a list","tags":["Lists"],"x-api-token-group":["Account Filter Lists Edit"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rules/lists/{list_id}/items":{"delete":{"description":"Removes one or more items from a list.\n\nThis operation is asynchronous. To get current the operation status, invoke the `Get bulk operation status` endpoint with the returned `operation_id`.\n\nThere is a limit of 1 pending bulk operation per account. If an outstanding bulk operation is in progress, the request will be rejected.","operationId":"lists-delete-list-items","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/lists_list_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/lists_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"example":{"id":"34b12448945f11eaa1b71c4d701ab86e"},"properties":{"id":{"description":"Defines the unique ID of the item in the List.","example":"34b12448945f11eaa1b71c4d701ab86e","maxLength":32,"minLength":32,"type":"string","x-auditable":true}},"required":["id"],"type":"object"},"minItems":1,"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_lists-async-response"}}},"description":"Delete list items response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_lists-async-response"},{"$ref":"#/components/schemas/lists_api-response-common-failure"}]}}},"description":"Delete list items response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete list items","tags":["Lists"],"x-api-token-group":["Account Filter Lists Edit"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches all the items in the list.","operationId":"lists-get-list-items","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/lists_list_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/lists_account_id"}},{"in":"query","name":"cursor","schema":{"description":"The pagination cursor. An opaque string token indicating the position from which to continue when requesting the next/previous set of records. Cursor values are provided under `result_info.cursors` in the response. You should make no assumptions about a cursor's content or length.","example":"zzz","type":"string"}},{"in":"query","name":"per_page","schema":{"description":"Amount of results to include in each paginated response. A non-negative 32 bit integer.","maximum":500,"minimum":1,"type":"integer"}},{"in":"query","name":"search","schema":{"description":"A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.","example":"1.1.1.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_items-list-response-collection"}}},"description":"Get list items response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_items-list-response-collection"},{"$ref":"#/components/schemas/lists_api-response-common-failure"}]}}},"description":"Get list items response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get list items","tags":["Lists"],"x-api-token-group":["Account Filter Lists Edit","Account Filter Lists Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Appends new items to the list.\n\nThis operation is asynchronous. To get current the operation status, invoke the `Get bulk operation status` endpoint with the returned `operation_id`.\n\nThere is a limit of 1 pending bulk operation per account. If an outstanding bulk operation is in progress, the request will be rejected.","operationId":"lists-create-list-items","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/lists_list_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/lists_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_items-update-request-collection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_lists-async-response"}}},"description":"Create list items response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_lists-async-response"},{"$ref":"#/components/schemas/lists_api-response-common-failure"}]}}},"description":"Create list items response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create list items","tags":["Lists"],"x-api-token-group":["Account Filter Lists Edit"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Removes all existing items from the list and adds the provided items to the list.\n\nThis operation is asynchronous. To get current the operation status, invoke the `Get bulk operation status` endpoint with the returned `operation_id`.\n\nThere is a limit of 1 pending bulk operation per account. If an outstanding bulk operation is in progress, the request will be rejected.","operationId":"lists-update-all-list-items","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/lists_list_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/lists_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_items-update-request-collection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_lists-async-response"}}},"description":"Update all list items response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_lists-async-response"},{"$ref":"#/components/schemas/lists_api-response-common-failure"}]}}},"description":"Update all list items response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update all list items","tags":["Lists"],"x-api-token-group":["Account Filter Lists Edit"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rules/lists/{list_id}/items/{item_id}":{"get":{"description":"Fetches a list item in the list.","operationId":"lists-get-a-list-item","parameters":[{"in":"path","name":"item_id","required":true,"schema":{"$ref":"#/components/schemas/lists_item_id"}},{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/lists_list_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/lists_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_item-response-single"}}},"description":"Get a list item response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists_item-response-single"},{"$ref":"#/components/schemas/lists_api-response-common-failure"}]}}},"description":"Get a list item response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a list item","tags":["Lists"],"x-api-token-group":["Account Filter Lists Edit","Account Filter Lists Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets":{"get":{"description":"Fetches all rulesets at the account level.","operationId":"listAccountRulesets","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}},{"in":"query","name":"cursor","schema":{"$ref":"#/components/schemas/rulesets_Cursor"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/rulesets_PerPage"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Rulesets"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List account rulesets","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a ruleset at the account level.","operationId":"createAccountRuleset","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"requestBody":{"$ref":"#/components/requestBodies/rulesets_CreateRuleset"},"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Create an account ruleset","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","Transform Rules Write","Select Configuration Write","Account WAF Write","Account Rulesets Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint":{"get":{"description":"Fetches the latest version of the account entry point ruleset for a given phase.","operationId":"getAccountEntrypointRuleset","parameters":[{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetPhase"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get an account entry point ruleset","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates an account entry point ruleset, creating a new version.","operationId":"updateAccountEntrypointRuleset","parameters":[{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetPhase"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"requestBody":{"$ref":"#/components/requestBodies/rulesets_UpdateEntrypointRuleset"},"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update an account entry point ruleset","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","Transform Rules Write","Select Configuration Write","Account WAF Write","Account Rulesets Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions":{"get":{"description":"Fetches the versions of an account entry point ruleset.","operationId":"listAccountEntrypointRulesetVersions","parameters":[{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetPhase"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Rulesets"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List an account entry point ruleset's versions","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}":{"get":{"description":"Fetches a specific version of an account entry point ruleset.","operationId":"getAccountEntrypointRulesetVersion","parameters":[{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetVersion"}},{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetPhase"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get an account entry point ruleset version","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/{ruleset_id}":{"delete":{"description":"Deletes all versions of an existing account ruleset.","operationId":"deleteAccountRuleset","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"responses":{"204":{"$ref":"#/components/responses/rulesets_Empty"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete an account ruleset","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","Transform Rules Write","Select Configuration Write","Account WAF Write","Account Rulesets Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the latest version of an account ruleset.","operationId":"getAccountRuleset","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get an account ruleset","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates an account ruleset, creating a new version.","operationId":"updateAccountRuleset","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"requestBody":{"$ref":"#/components/requestBodies/rulesets_UpdateRuleset"},"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update an account ruleset","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","Transform Rules Write","Select Configuration Write","Account WAF Write","Account Rulesets Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/{ruleset_id}/rules":{"post":{"description":"Adds a new rule to an account ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default.","operationId":"createAccountRulesetRule","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"requestBody":{"$ref":"#/components/requestBodies/rulesets_Rule"},"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Create an account ruleset rule","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","Transform Rules Write","Select Configuration Write","Account WAF Write","Account Rulesets Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}":{"delete":{"description":"Deletes an existing rule from an account ruleset.","operationId":"deleteAccountRulesetRule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RuleId"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete an account ruleset rule","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","Transform Rules Write","Select Configuration Write","Account WAF Write","Account Rulesets Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates an existing rule in an account ruleset.","operationId":"updateAccountRulesetRule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RuleId"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"requestBody":{"$ref":"#/components/requestBodies/rulesets_Rule"},"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update an account ruleset rule","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","Transform Rules Write","Select Configuration Write","Account WAF Write","Account Rulesets Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/{ruleset_id}/versions":{"get":{"description":"Fetches the versions of an account ruleset.","operationId":"listAccountRulesetVersions","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Rulesets"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List an account ruleset's versions","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}":{"delete":{"description":"Deletes an existing version of an account ruleset.","operationId":"deleteAccountRulesetVersion","parameters":[{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetVersion"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"responses":{"204":{"$ref":"#/components/responses/rulesets_Empty"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete an account ruleset version","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","Transform Rules Write","Select Configuration Write","Account WAF Write","Account Rulesets Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches a specific version of an account ruleset.","operationId":"getAccountRulesetVersion","parameters":[{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetVersion"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get an account ruleset version","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}":{"get":{"description":"Fetches the rules of a managed account ruleset version for a given tag.","operationId":"listAccountRulesetVersionRulesByTag","parameters":[{"in":"path","name":"rule_tag","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RuleCategory"}},{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetVersion"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_AccountId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List an account ruleset version's rules by tag","tags":["Account Rulesets"],"x-api-token-group":["Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rum/site_info":{"post":{"description":"Creates a new Web Analytics site.","operationId":"web-analytics-create-site","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_create-site-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_site-response-single"}}},"description":"Created Web Analytics site."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a Web Analytics site","tags":["Web Analytics"],"x-api-token-group":["Account Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rum/site_info/list":{"get":{"description":"Lists all Web Analytics sites of an account.","operationId":"web-analytics-list-sites","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/rum_per_page"}},{"in":"query","name":"page","schema":{"$ref":"#/components/schemas/rum_page"}},{"in":"query","name":"order_by","schema":{"$ref":"#/components/schemas/rum_order_by"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_sites-response-collection"}}},"description":"List of Web Analytics sites."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Web Analytics sites","tags":["Web Analytics"],"x-api-token-group":["Account Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rum/site_info/{site_id}":{"delete":{"description":"Deletes an existing Web Analytics site.","operationId":"web-analytics-delete-site","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_site-tag-response-single"}}},"description":"Deleted Web Analytics site identifier."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a Web Analytics site","tags":["Web Analytics"],"x-api-token-group":["Account Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Retrieves a Web Analytics site.","operationId":"web-analytics-get-site","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_site-response-single"}}},"description":"Web Analytics site."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a Web Analytics site","tags":["Web Analytics"],"x-api-token-group":["Account Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates an existing Web Analytics site.","operationId":"web-analytics-update-site","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}},{"in":"path","name":"site_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_update-site-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_site-response-single"}}},"description":"Updated Web Analytics site."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a Web Analytics site","tags":["Web Analytics"],"x-api-token-group":["Account Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rum/v2/{ruleset_id}/rule":{"post":{"description":"Creates a new rule in a Web Analytics ruleset.","operationId":"web-analytics-create-rule","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rum_ruleset_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_create-rule-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_rule-response-single"}}},"description":"Created Web Analytics rule."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a Web Analytics rule","tags":["Web Analytics"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}":{"delete":{"description":"Deletes an existing rule from a Web Analytics ruleset.","operationId":"web-analytics-delete-rule","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rum_ruleset_identifier"}},{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/rum_rule_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_rule-id-response-single"}}},"description":"Deleted Web Analytics rule identifier."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a Web Analytics rule","tags":["Web Analytics"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Updates a rule in a Web Analytics ruleset.","operationId":"web-analytics-update-rule","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rum_ruleset_identifier"}},{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/rum_rule_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_create-rule-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_rule-response-single"}}},"description":"Updated Web Analytics rule."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a Web Analytics rule","tags":["Web Analytics"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/rum/v2/{ruleset_id}/rules":{"get":{"description":"Lists all the rules in a Web Analytics ruleset.","operationId":"web-analytics-list-rules","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rum_ruleset_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_rules-response-collection"}}},"description":"List of Web Analytics rules in the ruleset."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List rules in Web Analytics ruleset","tags":["Web Analytics"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Modifies one or more rules in a Web Analytics ruleset with a single request.","operationId":"web-analytics-modify-rules","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rum_ruleset_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_modify-rules-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_rules-response-collection"}}},"description":"List of modified Web Analytics rules."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Web Analytics rules","tags":["Web Analytics"],"x-api-token-group":["Account Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_id}/secondary_dns/acls":{"get":{"description":"List ACLs.","operationId":"secondary-dns-(-acl)-list-ac-ls","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_components-schemas-response_collection"}}},"description":"List ACLs response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_components-schemas-response_collection"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"List ACLs response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List ACLs","tags":["Secondary DNS (ACL)"],"x-api-token-group":["Account Settings Write","Account Settings Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create ACL.","operationId":"secondary-dns-(-acl)-create-acl","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ip_range":{"$ref":"#/components/schemas/secondary-dns_ip_range"},"name":{"$ref":"#/components/schemas/secondary-dns_acl_components-schemas-name"}},"required":["name","ip_range"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_components-schemas-single_response"}}},"description":"Create ACL response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_components-schemas-single_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Create ACL response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create ACL","tags":["Secondary DNS (ACL)"],"x-api-token-group":["Account Settings Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/secondary_dns/acls/{acl_id}":{"delete":{"description":"Delete ACL.","operationId":"secondary-dns-(-acl)-delete-acl","parameters":[{"in":"path","name":"acl_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_components-schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_components-schemas-id_response"}}},"description":"Delete ACL response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_components-schemas-id_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Delete ACL response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete ACL","tags":["Secondary DNS (ACL)"],"x-api-token-group":["Account Settings Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get ACL.","operationId":"secondary-dns-(-acl)-acl-details","parameters":[{"in":"path","name":"acl_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_components-schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_components-schemas-single_response"}}},"description":"ACL Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_components-schemas-single_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"ACL Details response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"ACL Details","tags":["Secondary DNS (ACL)"],"x-api-token-group":["Account Settings Write","Account Settings Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Modify ACL.","operationId":"secondary-dns-(-acl)-update-acl","parameters":[{"in":"path","name":"acl_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_components-schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_acl"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_components-schemas-single_response"}}},"description":"Update ACL response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_components-schemas-single_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Update ACL response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update ACL","tags":["Secondary DNS (ACL)"],"x-api-token-group":["Account Settings Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/secondary_dns/peers":{"get":{"description":"List Peers.","operationId":"secondary-dns-(-peer)-list-peers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_schemas-response_collection"}}},"description":"List Peers response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_schemas-response_collection"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"List Peers response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Peers","tags":["Secondary DNS (Peer)"],"x-api-token-group":["Account Settings Write","Account Settings Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create Peer.","operationId":"secondary-dns-(-peer)-create-peer","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/secondary-dns_components-schemas-name"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_schemas-single_response"}}},"description":"Create Peer response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_schemas-single_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Create Peer response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Peer","tags":["Secondary DNS (Peer)"],"x-api-token-group":["Account Settings Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/secondary_dns/peers/{peer_id}":{"delete":{"description":"Delete Peer.","operationId":"secondary-dns-(-peer)-delete-peer","parameters":[{"in":"path","name":"peer_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_components-schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_components-schemas-id_response"}}},"description":"Delete Peer response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_components-schemas-id_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Delete Peer response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Peer","tags":["Secondary DNS (Peer)"],"x-api-token-group":["Account Settings Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get Peer.","operationId":"secondary-dns-(-peer)-peer-details","parameters":[{"in":"path","name":"peer_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_components-schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_schemas-single_response"}}},"description":"Peer Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_schemas-single_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Peer Details response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Peer Details","tags":["Secondary DNS (Peer)"],"x-api-token-group":["Account Settings Write","Account Settings Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Modify Peer.","operationId":"secondary-dns-(-peer)-update-peer","parameters":[{"in":"path","name":"peer_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_components-schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_peer"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_schemas-single_response"}}},"description":"Update Peer response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_schemas-single_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Update Peer response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Peer","tags":["Secondary DNS (Peer)"],"x-api-token-group":["Account Settings Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/secondary_dns/tsigs":{"get":{"description":"List TSIGs.","operationId":"secondary-dns-(-tsig)-list-tsi-gs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_response_collection"}}},"description":"List TSIGs response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_response_collection"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"List TSIGs response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List TSIGs","tags":["Secondary DNS (TSIG)"],"x-api-token-group":["Account Settings Write","Account Settings Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create TSIG.","operationId":"secondary-dns-(-tsig)-create-tsig","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_tsig"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_single_response"}}},"description":"Create TSIG response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_single_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Create TSIG response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create TSIG","tags":["Secondary DNS (TSIG)"],"x-api-token-group":["Account Settings Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/secondary_dns/tsigs/{tsig_id}":{"delete":{"description":"Delete TSIG.","operationId":"secondary-dns-(-tsig)-delete-tsig","parameters":[{"in":"path","name":"tsig_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_schemas-id_response"}}},"description":"Delete TSIG response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_schemas-id_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Delete TSIG response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete TSIG","tags":["Secondary DNS (TSIG)"],"x-api-token-group":["Account Settings Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get TSIG.","operationId":"secondary-dns-(-tsig)-tsig-details","parameters":[{"in":"path","name":"tsig_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_single_response"}}},"description":"TSIG Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_single_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"TSIG Details response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"TSIG Details","tags":["Secondary DNS (TSIG)"],"x-api-token-group":["Account Settings Write","Account Settings Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Modify TSIG.","operationId":"secondary-dns-(-tsig)-update-tsig","parameters":[{"in":"path","name":"tsig_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_tsig"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_single_response"}}},"description":"Update TSIG response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_single_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Update TSIG response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update TSIG","tags":["Secondary DNS (TSIG)"],"x-api-token-group":["Account Settings Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/secrets_store/quota":{"get":{"description":"Lists the number of secrets used in the account.","operationId":"secrets-store-quota","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets-store_quota_response"}}},"description":"Usage and quota"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-common-failure"}]}}},"description":"List store secrets response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"View secret usage","tags":["Secrets Store"],"x-api-token-group":["Secrets Store Write","Secrets Store Read"],"x-cfPermissionsRequired":{"enum":["#com.cloudflare.api.account.secrets-store.secret.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/secrets_store/stores":{"get":{"description":"Lists all the stores in an account","operationId":"secrets-store-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_account_identifier"}},{"$ref":"#/components/parameters/secrets-store_direction"},{"$ref":"#/components/parameters/secrets-store_page"},{"$ref":"#/components/parameters/secrets-store_per_page"},{"$ref":"#/components/parameters/secrets-store_order"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets-store_stores_response_collection"}}},"description":"List account stores response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-common-failure"}]}}},"description":"List account stores response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List account stores","tags":["Secrets Store"],"x-api-token-group":["Secrets Store Write","Secrets Store Read"],"x-cfPermissionsRequired":{"enum":["#com.cloudflare.api.account.secrets-store.secret.list","#com.cloudflare.api.account.secrets-store.secret.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a store in the account","operationId":"secrets-store-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/secrets-store_createStoreObject"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets-store_stores_response_collection"}}},"description":"store details"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-common-failure"}]}}},"description":"List store secrets response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a store","tags":["Secrets Store"],"x-api-token-group":["Secrets Store Write"],"x-cfPermissionsRequired":{"enum":["#com.cloudflare.api.account.secrets-store.secret.read","#com.cloudflare.api.account.secrets-store.secret.create"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/secrets_store/stores/{store_id}":{"delete":{"description":"Deletes a single store","operationId":"secrets-store-delete-by-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_account_identifier"}},{"in":"path","name":"store_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_store_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets-store_store_response"}}},"description":"store details"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-common-failure"}]}}},"description":"failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a store","tags":["Secrets Store"],"x-api-token-group":["Secrets Store Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/secrets_store/stores/{store_id}/secrets":{"delete":{"description":"Deletes one or more secrets","operationId":"secrets-store-delete-bulk","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_account_identifier"}},{"in":"path","name":"store_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_store_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/secrets-store_deleteSecretObject"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets-store_secrets_response_collection"}}},"description":"secret detail"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-common-failure"}]}}},"description":"List store secrets response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete secrets","tags":["Secrets Store"],"x-api-token-group":["Secrets Store Write"],"x-cfPermissionsRequired":{"enum":["#com.cloudflare.api.account.secrets-store.secret.read","#com.cloudflare.api.account.secrets-store.secret.delete"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Lists all store secrets","operationId":"secrets-store-secrets-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_account_identifier"}},{"in":"path","name":"store_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_store_identifier"}},{"$ref":"#/components/parameters/secrets-store_direction"},{"$ref":"#/components/parameters/secrets-store_page"},{"$ref":"#/components/parameters/secrets-store_per_page"},{"$ref":"#/components/parameters/secrets-store_search"},{"$ref":"#/components/parameters/secrets-store_order"},{"$ref":"#/components/parameters/secrets-store_scopes_query"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets-store_secrets_response_collection"}}},"description":"List store secrets response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-common-failure"}]}}},"description":"List store secrets response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List store secrets","tags":["Secrets Store"],"x-api-token-group":["Secrets Store Write","Secrets Store Read"],"x-cfPermissionsRequired":{"enum":["#com.cloudflare.api.account.secrets-store.secret.list","#com.cloudflare.api.account.secrets-store.secret.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a secret in the account","operationId":"secrets-store-secret-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_account_identifier"}},{"in":"path","name":"store_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_store_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/secrets-store_createSecretObject"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets-store_secrets_response_collection"}}},"description":"secret detail"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-common-failure"}]}}},"description":"List store secrets response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a secret","tags":["Secrets Store"],"x-api-token-group":["Secrets Store Write"],"x-cfPermissionsRequired":{"enum":["#com.cloudflare.api.account.secrets-store.secret.read","#com.cloudflare.api.account.secrets-store.secret.create"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}":{"delete":{"description":"Deletes a single secret","operationId":"secrets-store-secret-delete-by-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_account_identifier"}},{"in":"path","name":"store_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_store_identifier"}},{"in":"path","name":"secret_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets-store_secret_response"}}},"description":"secret detail"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-common-failure"}]}}},"description":"failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a secret","tags":["Secrets Store"],"x-api-token-group":["Secrets Store Write"],"x-cfPermissionsRequired":{"enum":["#com.cloudflare.api.account.secrets-store.secret.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Returns details of a single secret","operationId":"secrets-store-get-by-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_account_identifier"}},{"in":"path","name":"store_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_store_identifier"}},{"in":"path","name":"secret_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets-store_secret_response"}}},"description":"secret detail"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-common-failure"}]}}},"description":"failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a secret by ID","tags":["Secrets Store"],"x-api-token-group":["Secrets Store Write","Secrets Store Read"],"x-cfPermissionsRequired":{"enum":["#com.cloudflare.api.account.secrets-store.secret.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates a single secret","operationId":"secrets-store-patch-by-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_account_identifier"}},{"in":"path","name":"store_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_store_identifier"}},{"in":"path","name":"secret_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets-store_patchSecretObject"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets-store_secret_response"}}},"description":"secret detail"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-common-failure"}]}}},"description":"failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Patch a secret","tags":["Secrets Store"],"x-api-token-group":["Secrets Store Write"],"x-cfPermissionsRequired":{"enum":["#com.cloudflare.api.account.secrets-store.secret.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/secrets_store/stores/{store_id}/secrets/{secret_id}/duplicate":{"post":{"description":"Duplicates the secret, keeping the value","operationId":"secrets-store-duplicate-by-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_account_identifier"}},{"in":"path","name":"store_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_store_identifier"}},{"in":"path","name":"secret_id","required":true,"schema":{"$ref":"#/components/schemas/secrets-store_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets-store_duplicateSecretObject"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secrets-store_secret_response"}}},"description":"secret detail"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secrets-store_api-response-common-failure"}]}}},"description":"failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Duplicate Secret","tags":["Secrets Store"],"x-api-token-group":["Secrets Store Write"],"x-cfPermissionsRequired":{"enum":["#com.cloudflare.api.account.secrets-store.secret.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/security-center/insights":{"get":{"operationId":"get-security-center-insights","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"query","name":"dismissed","schema":{"$ref":"#/components/schemas/security-center_dismissed"}},{"in":"query","name":"issue_class","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"issue_class~neq","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type~neq","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product~neq","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity~neq","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject~neq","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"page","schema":{"allOf":[{"$ref":"#/components/schemas/security-center_page"}],"default":1}},{"in":"query","name":"per_page","schema":{"allOf":[{"$ref":"#/components/schemas/security-center_perPage"}],"default":25}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/security-center_api-response-common"},{"properties":{"result":{"anyOf":[{"properties":{"count":{"$ref":"#/components/schemas/security-center_count"},"issues":{"items":{"$ref":"#/components/schemas/security-center_issue"},"type":"array"},"page":{"$ref":"#/components/schemas/security-center_page"},"per_page":{"$ref":"#/components/schemas/security-center_perPage"}},"type":"object"}]}}}]}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Security Center Insights","tags":["Security Center Insights"]}},"/accounts/{account_id}/security-center/insights/class":{"get":{"operationId":"get-security-center-insight-counts-by-class","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"query","name":"dismissed","schema":{"$ref":"#/components/schemas/security-center_dismissed"}},{"in":"query","name":"issue_class","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"issue_class~neq","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type~neq","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product~neq","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity~neq","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject~neq","schema":{"$ref":"#/components/schemas/security-center_subjects"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_valueCountsResponse"}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Security Center Insight Counts by Class","tags":["Security Center Insights"]}},"/accounts/{account_id}/security-center/insights/severity":{"get":{"operationId":"get-security-center-insight-counts-by-severity","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"query","name":"dismissed","schema":{"$ref":"#/components/schemas/security-center_dismissed"}},{"in":"query","name":"issue_class","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"issue_class~neq","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type~neq","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product~neq","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity~neq","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject~neq","schema":{"$ref":"#/components/schemas/security-center_subjects"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_valueCountsResponse"}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Security Center Insight Counts by Severity","tags":["Security Center Insights"]}},"/accounts/{account_id}/security-center/insights/type":{"get":{"operationId":"get-security-center-insight-counts-by-type","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"query","name":"dismissed","schema":{"$ref":"#/components/schemas/security-center_dismissed"}},{"in":"query","name":"issue_class","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"issue_class~neq","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type~neq","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product~neq","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity~neq","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject~neq","schema":{"$ref":"#/components/schemas/security-center_subjects"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_valueCountsResponse"}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Security Center Insight Counts by Type","tags":["Security Center Insights"]}},"/accounts/{account_id}/security-center/insights/{issue_id}/dismiss":{"put":{"operationId":"archive-security-center-insight","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"path","name":"issue_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"dismiss":{"default":true,"type":"boolean","x-auditable":true}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/security-center_api-response-single"}]}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Archive Security Center Insight","tags":["Security Center Insights"]}},"/accounts/{account_id}/shares":{"get":{"description":"Lists all account shares.","operationId":"shares-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"$ref":"#/components/parameters/resource-sharing_status"},{"$ref":"#/components/parameters/resource-sharing_kind"},{"$ref":"#/components/parameters/resource-sharing_target_type"},{"$ref":"#/components/parameters/resource-sharing_resource_types"},{"$ref":"#/components/parameters/resource-sharing_order"},{"$ref":"#/components/parameters/resource-sharing_direction"},{"$ref":"#/components/parameters/resource-sharing_page"},{"$ref":"#/components/parameters/resource-sharing_per_page"},{"$ref":"#/components/parameters/resource-sharing_include_resources"},{"$ref":"#/components/parameters/resource-sharing_include_recipient_counts"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_response_collection"}}},"description":"List account shares response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"List account shares response failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"List account shares response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List account shares","tags":["Resource Sharing"],"x-api-token-group":null,"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"operationId":"share-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_create_share_request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_response_single"}}},"description":"Share created."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Create share failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Create share failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a new share","tags":["Resource Sharing"],"x-api-token-group":null,"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/shares/{share_id}":{"delete":{"description":"Deletion is not immediate, an updated share object with a new status will be returned.","operationId":"share-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"in":"path","name":"share_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_share_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_response_single"}}},"description":"Share deleted."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Delete share failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Delete share failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a share","tags":["Resource Sharing"],"x-api-token-group":null,"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Fetches share by ID.","operationId":"shares-get-by-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"in":"path","name":"share_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_share_id"}},{"$ref":"#/components/parameters/resource-sharing_include_resources"},{"$ref":"#/components/parameters/resource-sharing_include_recipient_counts"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_response_single"}}},"description":"Get account share response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Get account share response failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Get account share response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get account share by ID","tags":["Resource Sharing"],"x-api-token-group":null,"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updating is not immediate, an updated share object with a new status will be returned.","operationId":"share-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"in":"path","name":"share_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_share_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_update_share_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_response_single"}}},"description":"Share updated."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Update share failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Update share failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update a share","tags":["Resource Sharing"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/shares/{share_id}/recipients":{"get":{"description":"List share recipients by share ID.","operationId":"share-recipients-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"in":"path","name":"share_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_share_id"}},{"$ref":"#/components/parameters/resource-sharing_include_resources"},{"$ref":"#/components/parameters/resource-sharing_page"},{"$ref":"#/components/parameters/resource-sharing_per_page"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_recipient_response_collection"}}},"description":"List account share recipients response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"List account share recipients response failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"List account share recipients response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List share recipients by share ID","tags":["Resource Sharing"],"x-api-token-group":null,"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"operationId":"share-recipient-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"in":"path","name":"share_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_share_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_create_share_recipient_request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_recipient_response_single"}}},"description":"Share recipient created."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Create share recipient failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Create share recipient failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a new share recipient","tags":["Resource Sharing"],"x-api-token-group":null,"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Changes a share's recipients to match the given list. Returns an error if the share targets an organization.","operationId":"share-recipients-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"in":"path","name":"share_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_share_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_update_share_recipients_request"}}},"required":true},"responses":{"204":{"description":"Empty body"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Update share recipients failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Update share recipients failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update a share's recipients","tags":["Resource Sharing"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/shares/{share_id}/recipients/{recipient_id}":{"delete":{"description":"Deletion is not immediate, an updated share recipient object with a new status will be returned.","operationId":"share-recipient-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"in":"path","name":"share_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_share_id"}},{"in":"path","name":"recipient_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_recipient_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_recipient_response_single"}}},"description":"Share recipient deleted."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Delete share recipient failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Delete share recipient failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a share recipient","tags":["Resource Sharing"],"x-api-token-group":null,"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get share recipient by ID.","operationId":"share-recipients-get-by-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"in":"path","name":"share_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_share_id"}},{"in":"path","name":"recipient_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_recipient_id"}},{"$ref":"#/components/parameters/resource-sharing_include_resources"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_recipient_response_single"}}},"description":"Get account share recipient response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Get account share recipient response failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Get account share recipient response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get share recipient by ID","tags":["Resource Sharing"],"x-api-token-group":null,"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/shares/{share_id}/resources":{"get":{"description":"List share resources by share ID.","operationId":"share-resources-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"in":"path","name":"share_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_share_id"}},{"$ref":"#/components/parameters/resource-sharing_resource_status"},{"$ref":"#/components/parameters/resource-sharing_resource_type"},{"$ref":"#/components/parameters/resource-sharing_page"},{"$ref":"#/components/parameters/resource-sharing_per_page"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_resource_response_collection"}}},"description":"List account share resources response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"List account share resources response failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"List account share resources response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List share resources by share ID","tags":["Resource Sharing"],"x-api-token-group":null,"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"operationId":"share-resource-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"in":"path","name":"share_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_share_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_create_share_resource_request"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_resource_response_single"}}},"description":"Share resource created."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Create share resource failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Create share resource failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a new share resource","tags":["Resource Sharing"],"x-api-token-group":null,"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/shares/{share_id}/resources/{resource_id}":{"delete":{"description":"Deletion is not immediate, an updated share resource object with a new status will be returned.","operationId":"share-resource-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"in":"path","name":"share_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_share_id"}},{"in":"path","name":"resource_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_resource_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_resource_response_single"}}},"description":"Share resource deleted."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Delete share resource failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Delete share resource failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a share resource","tags":["Resource Sharing"],"x-api-token-group":null,"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get share resource by ID.","operationId":"share-resources-get-by-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"in":"path","name":"share_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_share_id"}},{"in":"path","name":"resource_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_resource_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_resource_response_single"}}},"description":"Get account share resource response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Get account share resource response failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Get account share resource response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get share resource by ID","tags":["Resource Sharing"],"x-api-token-group":null,"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update is not immediate, an updated share resource object with a new status will be returned.","operationId":"share-resource-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_account_id"}},{"in":"path","name":"share_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_share_id"}},{"in":"path","name":"resource_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_resource_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_update_share_resource_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_resource_response_single"}}},"description":"Share resource updated."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Update share resource failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"Update share resource failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update a share resource","tags":["Resource Sharing"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/slurper/jobs":{"get":{"operationId":"slurper-list-jobs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"maximum":50,"type":"integer"}},{"in":"query","name":"offset","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-slurper_api-v4-success"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/r2-slurper_JobResponse"},"type":"array"}},"type":"object"}],"type":"object"}}},"description":"A list of jobs"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List jobs","tags":["R2 Super Slurper"]},"post":{"operationId":"slurper-create-job","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_CreateJobRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-slurper_api-v4-success"},{"properties":{"result":{"properties":{"id":{"type":"string"}},"type":"object"}},"type":"object"}],"type":"object"}}},"description":"Job created"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_api-v4-failure"}}},"description":"Maximum number of concurrent jobs has been reached"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a job","tags":["R2 Super Slurper"]}},"/accounts/{account_id}/slurper/jobs/abortAll":{"put":{"operationId":"slurper-abort-all-jobs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-slurper_api-v4-success"},{"properties":{"result":{"type":"string"}},"type":"object"}],"type":"object"}}},"description":"All jobs aborted"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Abort all jobs","tags":["R2 Super Slurper"]}},"/accounts/{account_id}/slurper/jobs/{job_id}":{"get":{"operationId":"slurper-get-job","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"job_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-slurper_api-v4-success"},{"properties":{"result":{"$ref":"#/components/schemas/r2-slurper_JobResponse"}},"type":"object"}],"type":"object"}}},"description":"Job details"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get job details","tags":["R2 Super Slurper"]}},"/accounts/{account_id}/slurper/jobs/{job_id}/abort":{"put":{"operationId":"slurper-abort-job","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"job_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-slurper_api-v4-success"},{"properties":{"result":{"type":"string"}},"type":"object"}],"type":"object"}}},"description":"Job aborted"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Abort a job","tags":["R2 Super Slurper"]}},"/accounts/{account_id}/slurper/jobs/{job_id}/logs":{"get":{"operationId":"slurper-get-job-logs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"job_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"maximum":50,"type":"integer"}},{"in":"query","name":"offset","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-slurper_api-v4-success"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/r2-slurper_JobLogResponse"},"type":"array"}},"type":"object"}],"type":"object"}}},"description":"Job logs"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get job logs","tags":["R2 Super Slurper"]}},"/accounts/{account_id}/slurper/jobs/{job_id}/pause":{"put":{"operationId":"slurper-pause-job","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"job_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-slurper_api-v4-success"},{"properties":{"result":{"type":"string"}},"type":"object"}],"type":"object"}}},"description":"Job paused"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_api-v4-failure"}}},"description":"Job is not paused"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Pause a job","tags":["R2 Super Slurper"]}},"/accounts/{account_id}/slurper/jobs/{job_id}/progress":{"get":{"operationId":"slurper-get-job-progress","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"job_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-slurper_api-v4-success"},{"properties":{"result":{"$ref":"#/components/schemas/r2-slurper_JobProgressResponse"}},"type":"object"}],"type":"object"}}},"description":"Job progress"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get job progress","tags":["R2 Super Slurper"]}},"/accounts/{account_id}/slurper/jobs/{job_id}/resume":{"put":{"operationId":"slurper-resume-job","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"job_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-slurper_api-v4-success"},{"properties":{"result":{"type":"string"}},"type":"object"}],"type":"object"}}},"description":"Job resumed"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Resume a job","tags":["R2 Super Slurper"]}},"/accounts/{account_id}/slurper/source/connectivity-precheck":{"put":{"description":"Check whether tokens are valid against the source bucket","operationId":"slurper-check-source-connectivity","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_SourceJobSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-slurper_api-v4-success"},{"properties":{"result":{"$ref":"#/components/schemas/r2-slurper_ConnectivityResponse"}},"type":"object"}],"type":"object"}}},"description":"Source connectivity checked"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Check source connectivity","tags":["R2 Super Slurper"]}},"/accounts/{account_id}/slurper/target/connectivity-precheck":{"put":{"description":"Check whether tokens are valid against the target bucket","operationId":"slurper-check-target-connectivity","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_R2TargetSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-slurper_api-v4-success"},{"properties":{"result":{"$ref":"#/components/schemas/r2-slurper_ConnectivityResponse"}},"type":"object"}],"type":"object"}}},"description":"Target connectivity checked"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-slurper_api-v4-failure"}}},"description":"Failure response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Check target connectivity","tags":["R2 Super Slurper"]}},"/accounts/{account_id}/sso_connectors":{"get":{"operationId":"get-all-sso-connectors","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_sso_connector_collection_response"}}},"description":"Get all SSO connectors response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Get all SSO connectors response failure"}},"security":[{"api_token":[]}],"summary":"Get all SSO connectors","tags":["SSO"],"x-api-token-group":["SSO Connector Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"init-new-sso-connector","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"begin_verification":{"default":true,"description":"Begin the verification process after creation","example":true,"type":"boolean"},"email_domain":{"description":"Email domain of the new SSO connector","example":"example.com","type":"string"},"use_fedramp_language":{"$ref":"#/components/schemas/iam_use_fedramp_language"}},"required":["email_domain"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_sso_connector_response"}}},"description":"Initialize new SSO connector response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Initialize new SSO connector response failure"}},"security":[{"api_token":[]}],"summary":"Initialize new SSO connector","tags":["SSO"],"x-api-token-group":["SSO Connector Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/sso_connectors/{sso_connector_id}":{"delete":{"operationId":"delete-sso-connector","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"sso_connector_id","required":true,"schema":{"$ref":"#/components/schemas/iam_sso_connector_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-single-id"}}},"description":"Delete SSO connector response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Delete SSO connector response failure"}},"security":[{"api_token":[]}],"summary":"Delete SSO connector","tags":["SSO"],"x-api-token-group":["SSO Connector Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"get-sso-connector","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"sso_connector_id","required":true,"schema":{"$ref":"#/components/schemas/iam_sso_connector_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_sso_connector_response"}}},"description":"Get SSO connector response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Get SSO connector response failure"}},"security":[{"api_token":[]}],"summary":"Get single SSO connector","tags":["SSO"],"x-api-token-group":["SSO Connector Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"operationId":"update-sso-connector-state","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"sso_connector_id","required":true,"schema":{"$ref":"#/components/schemas/iam_sso_connector_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"enabled":{"description":"SSO Connector enabled state","example":true,"type":"boolean"},"use_fedramp_language":{"$ref":"#/components/schemas/iam_use_fedramp_language"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_sso_connector_response"}}},"description":"Update SSO connector state response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Update SSO connector state response failure"}},"security":[{"api_token":[]}],"summary":"Update SSO connector state","tags":["SSO"],"x-api-token-group":["SSO Connector Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/sso_connectors/{sso_connector_id}/begin_verification":{"post":{"operationId":"begin-sso-connector-verification","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"sso_connector_id","required":true,"schema":{"$ref":"#/components/schemas/iam_sso_connector_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-single"}}},"description":"Begin SSO connector verification process response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Begin SSO connector verification process response failure"}},"security":[{"api_token":[]}],"summary":"Begin SSO connector verification","tags":["SSO"],"x-api-token-group":["SSO Connector Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/storage/kv/namespaces":{"get":{"description":"Returns the namespaces owned by an account.","operationId":"workers-kv-namespace-list-namespaces","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":1000,"minimum":1,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Field to order results by.","enum":["id","title"],"example":"id","type":"string"}},{"in":"query","name":"direction","schema":{"description":"Direction to order namespaces.","enum":["asc","desc"],"example":"asc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers-kv_namespace"},"type":"array"}},"type":"object"}]}}},"description":"List Namespaces response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-failure"}}},"description":"List Namespaces response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Namespaces","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write","Workers KV Storage Read"]},"post":{"description":"Creates a namespace under the given title. A `400` is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced.","operationId":"workers-kv-namespace-create-a-namespace","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_create_rename_namespace_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers-kv_namespace"}},"type":"object"}]}}},"description":"Create a Namespace response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-failure"}}},"description":"Create a Namespace response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a Namespace","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write"]}},"/accounts/{account_id}/storage/kv/namespaces/{namespace_id}":{"delete":{"description":"Deletes the namespace corresponding to the given ID.","operationId":"workers-kv-namespace-remove-a-namespace","parameters":[{"in":"path","name":"namespace_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_namespace_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-no-result"}}},"description":"Remove a Namespace response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-failure"}}},"description":"Remove a Namespace response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Remove a Namespace","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write"]},"get":{"description":"Get the namespace corresponding to the given ID.","operationId":"workers-kv-namespace-get-a-namespace","parameters":[{"in":"path","name":"namespace_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_namespace_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers-kv_namespace"}},"type":"object"}]}}},"description":"Get a Namespace response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-failure"}}},"description":"Get a Namespace response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get a Namespace","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write","Workers KV Storage Read"]},"put":{"description":"Modifies a namespace's title.","operationId":"workers-kv-namespace-rename-a-namespace","parameters":[{"in":"path","name":"namespace_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_namespace_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_create_rename_namespace_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers-kv_namespace"}},"required":["result"],"type":"object"}]}}},"description":"Rename a Namespace response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-failure"}}},"description":"Rename a Namespace response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Rename a Namespace","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write"]}},"/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk":{"delete":{"deprecated":true,"description":"Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed.","operationId":"workers-kv-namespace-delete-multiple-key-value-pairs-deprecated","parameters":[{"in":"path","name":"namespace_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_namespace_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_bulk_delete"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common-no-result"},{"properties":{"result":{"$ref":"#/components/schemas/workers-kv_bulk-result"}},"type":"object"}]}}},"description":"Delete multiple key-value pairs response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common-no-result"},{"properties":{"result":{"$ref":"#/components/schemas/workers-kv_bulk-result"}},"type":"object"}]}}},"description":"Delete multiple key-value pairs response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete multiple key-value pairs","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write"]},"put":{"description":"Write multiple keys and values at once. Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information. Existing values and expirations will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. The entire request size must be 100 megabytes or less.","operationId":"workers-kv-namespace-write-multiple-key-value-pairs","parameters":[{"in":"path","name":"namespace_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_namespace_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_bulk_write"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common-no-result"},{"properties":{"result":{"$ref":"#/components/schemas/workers-kv_bulk-result"}},"type":"object"}]}}},"description":"Write multiple key-value pairs response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common-no-result"},{"properties":{"result":{"$ref":"#/components/schemas/workers-kv_bulk-result"}},"type":"object"}]}}},"description":"Write multiple key-value pairs response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Write multiple key-value pairs","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write"]}},"/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk/delete":{"post":{"description":"Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed.","operationId":"workers-kv-namespace-delete-multiple-key-value-pairs","parameters":[{"in":"path","name":"namespace_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_namespace_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_bulk_delete"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common-no-result"},{"properties":{"result":{"$ref":"#/components/schemas/workers-kv_bulk-result"}},"type":"object"}]}}},"description":"Delete multiple key-value pairs response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common-no-result"},{"properties":{"result":{"$ref":"#/components/schemas/workers-kv_bulk-result"}},"type":"object"}]}}},"description":"Delete multiple key-value pairs response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete multiple key-value pairs","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write"]}},"/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/bulk/get":{"post":{"description":"Retrieve up to 100 KV pairs from the namespace. Keys must contain text-based values. JSON values can optionally be parsed instead of being returned as a string value. Metadata can be included if `withMetadata` is true.","operationId":"workers-kv-namespace-get-multiple-key-value-pairs","parameters":[{"in":"path","name":"namespace_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_namespace_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"keys":{"description":"Array of keys to retrieve (maximum of 100).","items":{"$ref":"#/components/schemas/workers-kv_key_name_bulk"},"maxItems":100,"type":"array"},"type":{"default":"text","description":"Whether to parse JSON values in the response.","enum":["text","json"],"type":"string"},"withMetadata":{"default":false,"description":"Whether to include metadata in the response.","type":"boolean"}},"required":["keys"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common-no-result"},{"properties":{"result":{"oneOf":[{"$ref":"#/components/schemas/workers-kv_bulk-get-result"},{"$ref":"#/components/schemas/workers-kv_bulk-get-result-with-metadata"}]}},"type":"object"}]}}},"description":"Get multiple key-value pairs response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-failure"}}},"description":"Get multiple key-value pairs response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get multiple key-value pairs","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write","Workers KV Storage Read"]}},"/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/keys":{"get":{"description":"Lists a namespace's keys.","operationId":"workers-kv-namespace-list-a-namespace'-s-keys","parameters":[{"in":"path","name":"namespace_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_namespace_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}},{"in":"query","name":"limit","schema":{"default":1000,"description":"Limits the number of keys returned in the response. The cursor attribute may be used to iterate over the next batch of keys if there are more than the limit.","maximum":1000,"minimum":10,"type":"number"}},{"in":"query","name":"prefix","schema":{"description":"Filters returned keys by a name prefix. Exact matches and any key names that begin with the prefix will be returned.","example":"My-Prefix","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the `cursors` object in the `result_info` structure.","example":"6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers-kv_key"},"type":"array"},"result_info":{"properties":{"count":{"description":"Total results returned based on your list parameters.","example":1,"type":"number"},"cursor":{"$ref":"#/components/schemas/workers-kv_cursor"}},"type":"object"}},"type":"object"}]}}},"description":"List a Namespace's Keys response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-failure"}}},"description":"List a Namespace's Keys response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List a Namespace's Keys","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write","Workers KV Storage Read"]}},"/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/metadata/{key_name}":{"get":{"description":"Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name.","operationId":"workers-kv-namespace-read-the-metadata-for-a-key","parameters":[{"in":"path","name":"key_name","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_key_name"}},{"in":"path","name":"namespace_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_namespace_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers-kv_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers-kv_list_metadata"}},"type":"object"}]}}},"description":"Read the metadata for a key response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-failure"}}},"description":"Read the metadata for a key response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Read the metadata for a key","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write","Workers KV Storage Read"]}},"/accounts/{account_id}/storage/kv/namespaces/{namespace_id}/values/{key_name}":{"delete":{"description":"Remove a KV pair from the namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name.","operationId":"workers-kv-namespace-delete-key-value-pair","parameters":[{"in":"path","name":"key_name","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_key_name"}},{"in":"path","name":"namespace_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_namespace_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-no-result"}}},"description":"Delete key-value pair response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-failure"}}},"description":"Delete key-value pair response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete key-value pair","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write"]},"get":{"description":"Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. If the KV-pair is set to expire at some point, the expiration time as measured in seconds since the UNIX epoch will be returned in the `expiration` response header.","operationId":"workers-kv-namespace-read-key-value-pair","parameters":[{"in":"path","name":"key_name","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_key_name"}},{"in":"path","name":"namespace_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_namespace_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/workers-kv_value"}}},"description":"Read key-value pair response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-failure"}}},"description":"Read key-value pair response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Read key-value pair","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write","Workers KV Storage Read"]},"put":{"description":"Write a value identified by a key. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. Body should be the value to be stored. If JSON metadata to be associated with the key/value pair is needed, use `multipart/form-data` content type for your PUT request (see dropdown below in `REQUEST BODY SCHEMA`). Existing values, expirations, and metadata will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored.","operationId":"workers-kv-namespace-write-key-value-pair-with-metadata","parameters":[{"in":"path","name":"key_name","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_key_name"}},{"in":"path","name":"namespace_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_namespace_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers-kv_identifier"}},{"in":"query","name":"expiration","schema":{"$ref":"#/components/schemas/workers-kv_expiration"}},{"in":"query","name":"expiration_ttl","schema":{"$ref":"#/components/schemas/workers-kv_expiration_ttl"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/workers-kv_value"},"x-stainless-only":["http"]},"multipart/form-data":{"encoding":{"metadata":{"contentType":"application/json"}},"schema":{"properties":{"metadata":{"$ref":"#/components/schemas/workers-kv_metadata"},"value":{"$ref":"#/components/schemas/workers-kv_value"}},"required":["value"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-no-result"}}},"description":"Write key-value pair with metadata response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers-kv_api-response-common-failure"}}},"description":"Write key-value pair with metadata response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Write key-value pair with optional metadata","tags":["Workers KV Namespace"],"x-api-token-group":["Workers KV Storage Write"]}},"/accounts/{account_id}/stream":{"get":{"description":"Lists up to 1000 videos from a single request. For a specific range, refer to the optional parameters.","operationId":"stream-videos-list-videos","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}},{"in":"query","name":"status","schema":{"$ref":"#/components/schemas/stream_media_state"}},{"in":"query","name":"creator","schema":{"$ref":"#/components/schemas/stream_creator"}},{"in":"query","name":"type","schema":{"$ref":"#/components/schemas/stream_type"}},{"in":"query","name":"asc","schema":{"$ref":"#/components/schemas/stream_asc"}},{"in":"query","name":"video_name","schema":{"$ref":"#/components/schemas/stream_video_name"}},{"in":"query","name":"search","schema":{"$ref":"#/components/schemas/stream_search"}},{"in":"query","name":"start","schema":{"$ref":"#/components/schemas/stream_start"}},{"in":"query","name":"end","schema":{"$ref":"#/components/schemas/stream_end"}},{"in":"query","name":"include_counts","schema":{"$ref":"#/components/schemas/stream_include_counts"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_video_response_collection"}}},"description":"List videos response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"List videos response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List videos","tags":["Stream Videos"],"x-api-token-group":["Stream Write","Stream Read"]},"post":{"description":"Initiates a video upload using the TUS protocol. On success, the server responds with a status code 201 (created) and includes a `location` header to indicate where the content should be uploaded. Refer to https://tus.io for protocol details.","operationId":"stream-videos-initiate-video-uploads-using-tus","parameters":[{"in":"header","name":"Tus-Resumable","required":true,"schema":{"$ref":"#/components/schemas/stream_tus_resumable"}},{"in":"header","name":"Upload-Creator","schema":{"$ref":"#/components/schemas/stream_creator"}},{"in":"header","name":"Upload-Length","required":true,"schema":{"$ref":"#/components/schemas/stream_upload_length"}},{"in":"header","name":"Upload-Metadata","schema":{"$ref":"#/components/schemas/stream_upload_metadata"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}},{"in":"query","name":"direct_user","schema":{"$ref":"#/components/schemas/stream_direct_user"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Initiate video uploads using TUS response."},"4XX":{"content":{"application/json":{}},"description":"Initiate video uploads using TUS response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Initiate video uploads using TUS","tags":["Stream Videos"],"x-api-token-group":["Stream Write"]}},"/accounts/{account_id}/stream/clip":{"post":{"description":"Clips a video based on the specified start and end times provided in seconds.","operationId":"stream-video-clipping-clip-videos-given-a-start-and-end-time","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_videoClipStandard"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_clipResponseSingle"}}},"description":"Clip videos given a start and end time response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Clip videos given a start and end time response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Clip videos given a start and end time","tags":["Stream Video Clipping"],"x-api-token-group":["Stream Write"]}},"/accounts/{account_id}/stream/copy":{"post":{"description":"Uploads a video to Stream from a provided URL.","operationId":"stream-videos-upload-videos-from-a-url","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}},{"in":"header","name":"Upload-Creator","schema":{"$ref":"#/components/schemas/stream_creator"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_video_copy_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_video_response_single"}}},"description":"Upload videos from a URL response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Upload videos from a URL response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Upload videos from a URL","tags":["Stream Videos"],"x-api-token-group":["Stream Write"]}},"/accounts/{account_id}/stream/direct_upload":{"post":{"description":"Creates a direct upload that allows video uploads without an API key.","operationId":"stream-videos-upload-videos-via-direct-upload-ur-ls","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}},{"in":"header","name":"Upload-Creator","schema":{"$ref":"#/components/schemas/stream_creator"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_direct_upload_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_direct_upload_response"}}},"description":"Upload videos via direct upload URLs response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Upload videos via direct upload URLs response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Upload videos via direct upload URLs","tags":["Stream Videos"],"x-api-token-group":["Stream Write"]}},"/accounts/{account_id}/stream/keys":{"get":{"description":"Lists the video ID and creation date and time when a signing key was created.","operationId":"stream-signing-keys-list-signing-keys","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_key_response_collection"}}},"description":"List signing keys response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"List signing keys response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List signing keys","tags":["Stream Signing Keys"],"x-api-token-group":["Stream Write","Stream Read"]},"post":{"description":"Creates an RSA private key in PEM and JWK formats. Key files are only displayed once after creation. Keys are created, used, and deleted independently of videos, and every key can sign any video.","operationId":"stream-signing-keys-create-signing-keys","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_key_generation_response"}}},"description":"Create signing keys response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Create signing keys response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create signing keys","tags":["Stream Signing Keys"],"x-api-token-group":["Stream Write"]}},"/accounts/{account_id}/stream/keys/{identifier}":{"delete":{"description":"Deletes signing keys and revokes all signed URLs generated with the key.","operationId":"stream-signing-keys-delete-signing-keys","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_deleted_response"}}},"description":"Delete signing keys response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Delete signing keys response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete signing keys","tags":["Stream Signing Keys"],"x-api-token-group":["Stream Write"]}},"/accounts/{account_id}/stream/live_inputs":{"get":{"description":"Lists the live inputs created for an account. To get the credentials needed to stream to a specific live input, request a single live input.","operationId":"stream-live-inputs-list-live-inputs","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}},{"in":"query","name":"include_counts","schema":{"$ref":"#/components/schemas/stream_include_counts"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_live_input_response_collection"}}},"description":"List live inputs response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"List live inputs response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List live inputs","tags":["Stream Live Inputs"],"x-api-token-group":["Stream Write","Stream Read"]},"post":{"description":"Creates a live input, and returns credentials that you or your users can use to stream live video to Cloudflare Stream.","operationId":"stream-live-inputs-create-a-live-input","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_create_input_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_live_input_response_single"}}},"description":"Create a live input response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Create a live input response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a live input","tags":["Stream Live Inputs"],"x-api-token-group":["Stream Write"]}},"/accounts/{account_id}/stream/live_inputs/{live_input_identifier}":{"delete":{"description":"Prevents a live input from being streamed to and makes the live input inaccessible to any future API calls.","operationId":"stream-live-inputs-delete-a-live-input","parameters":[{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_live_input_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Delete a live input response."},"4XX":{"content":{"application/json":{}},"description":"Delete a live input response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a live input","tags":["Stream Live Inputs"],"x-api-token-group":["Stream Write"]},"get":{"description":"Retrieves details of an existing live input.","operationId":"stream-live-inputs-retrieve-a-live-input","parameters":[{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_live_input_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_live_input_response_single"}}},"description":"Retrieve a live input response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Retrieve a live input response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve a live input","tags":["Stream Live Inputs"],"x-api-token-group":["Stream Write","Stream Read"]},"put":{"description":"Updates a specified live input.","operationId":"stream-live-inputs-update-a-live-input","parameters":[{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_live_input_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_update_input_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_live_input_response_single"}}},"description":"Update a live input response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Update a live input response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a live input","tags":["Stream Live Inputs"],"x-api-token-group":["Stream Write"]}},"/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs":{"get":{"description":"Retrieves all outputs associated with a specified live input.","operationId":"stream-live-inputs-list-all-outputs-associated-with-a-specified-live-input","parameters":[{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_live_input_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_output_response_collection"}}},"description":"List all outputs associated with a specified live input response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"List all outputs associated with a specified live input response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List all outputs associated with a specified live input","tags":["Stream Live Inputs"],"x-api-token-group":["Stream Write","Stream Read"]},"post":{"description":"Creates a new output that can be used to simulcast or restream live video to other RTMP or SRT destinations. Outputs are always linked to a specific live input — one live input can have many outputs.","operationId":"stream-live-inputs-create-a-new-output,-connected-to-a-live-input","parameters":[{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_live_input_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_create_output_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_output_response_single"}}},"description":"Create a new output, connected to a live input response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Create a new output, connected to a live input response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a new output, connected to a live input","tags":["Stream Live Inputs"]}},"/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}":{"delete":{"description":"Deletes an output and removes it from the associated live input.","operationId":"stream-live-inputs-delete-an-output","parameters":[{"in":"path","name":"output_identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_output_identifier"}},{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_live_input_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Delete an output response."},"4XX":{"content":{"application/json":{}},"description":"Delete an output response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an output","tags":["Stream Live Inputs"],"x-api-token-group":["Stream Write"]},"put":{"description":"Updates the state of an output.","operationId":"stream-live-inputs-update-an-output","parameters":[{"in":"path","name":"output_identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_output_identifier"}},{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_live_input_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_update_output_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_output_response_single"}}},"description":"Update an output response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Update an output response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an output","tags":["Stream Live Inputs"],"x-api-token-group":["Stream Write"]}},"/accounts/{account_id}/stream/storage-usage":{"get":{"description":"Returns information about an account's storage use.","operationId":"stream-videos-storage-usage","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}},{"in":"query","name":"creator","schema":{"$ref":"#/components/schemas/stream_creator"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_storage_use_response"}}},"description":"Returns information about an account's storage use response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Returns information about an account's storage use response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Storage use","tags":["Stream Videos"],"x-api-token-group":["Stream Write","Stream Read"]}},"/accounts/{account_id}/stream/watermarks":{"get":{"description":"Lists all watermark profiles for an account.","operationId":"stream-watermark-profile-list-watermark-profiles","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_watermark_response_collection"}}},"description":"List watermark profiles response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"List watermark profiles response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List watermark profiles","tags":["Stream Watermark Profile"],"x-api-token-group":["Stream Write","Stream Read"]},"post":{"description":"Creates watermark profiles using a single `HTTP POST multipart/form-data` request.","operationId":"stream-watermark-profile-create-watermark-profiles-via-basic-upload","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/stream_watermark_basic_upload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_watermark_response_single"}}},"description":"Create watermark profiles via basic upload response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Create watermark profiles via basic upload response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create watermark profiles via basic upload","tags":["Stream Watermark Profile"],"x-api-token-group":["Stream Write"]}},"/accounts/{account_id}/stream/watermarks/{identifier}":{"delete":{"description":"Deletes a watermark profile.","operationId":"stream-watermark-profile-delete-watermark-profiles","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_watermark_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-single"},{"properties":{"result":{"example":"","type":"string","x-auditable":true}},"type":"object"}]}}},"description":"Delete watermark profiles response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Delete watermark profiles response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete watermark profiles","tags":["Stream Watermark Profile"],"x-api-token-group":["Stream Write"]},"get":{"description":"Retrieves details for a single watermark profile.","operationId":"stream-watermark-profile-watermark-profile-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_watermark_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_watermark_response_single"}}},"description":"Watermark profile details response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Watermark profile details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Watermark profile details","tags":["Stream Watermark Profile"],"x-api-token-group":["Stream Write","Stream Read"]}},"/accounts/{account_id}/stream/webhook":{"delete":{"description":"Deletes a webhook.","operationId":"stream-webhook-delete-webhooks","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_deleted_response"}}},"description":"Delete webhooks response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Delete webhooks response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete webhooks","tags":["Stream Webhook"],"x-api-token-group":["Stream Write"]},"get":{"description":"Retrieves a list of webhooks.","operationId":"stream-webhook-view-webhooks","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_webhook_response_single"}}},"description":"View webhooks response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"View webhooks response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"View webhooks","tags":["Stream Webhook"],"x-api-token-group":["Stream Write","Stream Read"]},"put":{"description":"Creates a webhook notification.","operationId":"stream-webhook-create-webhooks","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_webhook_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_webhook_response_single"}}},"description":"Create webhooks response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Create webhooks response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create webhooks","tags":["Stream Webhook"],"x-api-token-group":["Stream Write"]}},"/accounts/{account_id}/stream/{identifier}":{"delete":{"description":"Deletes a video and its copies from Cloudflare Stream.","operationId":"stream-videos-delete-video","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Delete video response."},"4XX":{"content":{"application/json":{}},"description":"Delete video response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete video","tags":["Stream Videos"],"x-api-token-group":["Stream Write"]},"get":{"description":"Fetches details for a single video.","operationId":"stream-videos-retrieve-video-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_video_response_single"}}},"description":"Retrieve video details response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Retrieve video details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve video details","tags":["Stream Videos"],"x-api-token-group":["Stream Write","Stream Read"]},"post":{"description":"Edit details for a single video.","operationId":"stream-videos-update-video-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_video_update"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_video_response_single"}}},"description":"Edit video details response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Edit video details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Edit video details","tags":["Stream Videos"]}},"/accounts/{account_id}/stream/{identifier}/audio":{"get":{"description":"Lists additional audio tracks on a video. Note this API will not return information for audio attached to the video upload.","operationId":"list-audio-tracks","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_listAudioTrackResponse"}}},"description":"Lists additional audio tracks on a video."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Lists additional audio tracks on a video response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List additional audio tracks on a video","tags":["Stream Audio Tracks"],"x-api-token-group":["Stream Write","Stream Read"]}},"/accounts/{account_id}/stream/{identifier}/audio/copy":{"post":{"description":"Adds an additional audio track to a video using the provided audio track URL.","operationId":"add-audio-track","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_copyAudioTrack"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_addAudioTrackResponse"}}},"description":"Add audio tracks to a video."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Add audio tracks to a video response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Add audio tracks to a video","tags":["Stream Audio Tracks"]}},"/accounts/{account_id}/stream/{identifier}/audio/{audio_identifier}":{"delete":{"description":"Deletes additional audio tracks on a video. Deleting a default audio track is not allowed. You must assign another audio track as default prior to deletion.","operationId":"delete-audio-tracks","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"audio_identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_audio_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_deleted_response"}}},"description":"Deletes additional audio tracks on a video."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_deleted_response"}}},"description":"Deletes additional audio tracks on a video response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete additional audio tracks on a video","tags":["Stream Audio Tracks"],"x-api-token-group":["Stream Write"]},"patch":{"description":"Edits additional audio tracks on a video. Editing the default status of an audio track to `true` will mark all other audio tracks on the video default status to `false`.","operationId":"edit-audio-tracks","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"audio_identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_audio_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_editAudioTrack"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_addAudioTrackResponse"}}},"description":"Edits additional audio tracks on a video."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Edits additional audio tracks on a video response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Edit additional audio tracks on a video","tags":["Stream Audio Tracks"],"x-api-token-group":["Stream Write"]}},"/accounts/{account_id}/stream/{identifier}/captions":{"get":{"description":"Lists the available captions or subtitles for a specific video.","operationId":"stream-subtitles/-captions-list-captions-or-subtitles","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_language_response_collection"}}},"description":"List captions or subtitles response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"List captions or subtitles response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List captions or subtitles","tags":["Stream Subtitles/Captions"],"x-api-token-group":["Stream Write","Stream Read"]}},"/accounts/{account_id}/stream/{identifier}/captions/{language}":{"delete":{"description":"Removes the captions or subtitles from a video.","operationId":"stream-subtitles/-captions-delete-captions-or-subtitles","parameters":[{"in":"path","name":"language","required":true,"schema":{"$ref":"#/components/schemas/stream_language"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/stream_api-response-common"},{"properties":{"result":{"example":"","type":"string","x-auditable":true}},"type":"object"}]}}},"description":"Delete captions or subtitles response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Delete captions or subtitles response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete captions or subtitles","tags":["Stream Subtitles/Captions"],"x-api-token-group":["Stream Write"]},"get":{"description":"Lists the captions or subtitles for provided language.","operationId":"stream-subtitles/-captions-get-caption-or-subtitle-for-language","parameters":[{"in":"path","name":"language","required":true,"schema":{"$ref":"#/components/schemas/stream_language"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_language_response_single"}}},"description":"List captions or subtitles response for a provided language."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"List captions or subtitles response for a provided language."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List captions or subtitles for a provided language","tags":["Stream Subtitles/Captions"],"x-api-token-group":["Stream Write","Stream Read"]},"put":{"description":"Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. One caption or subtitle file per language is allowed.","operationId":"stream-subtitles/-captions-upload-captions-or-subtitles","parameters":[{"in":"path","name":"language","required":true,"schema":{"$ref":"#/components/schemas/stream_language"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/stream_caption_basic_upload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_language_response_single"}}},"description":"Upload captions or subtitles response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Upload captions or subtitles response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Upload captions or subtitles","tags":["Stream Subtitles/Captions"],"x-api-token-group":["Stream Write"]}},"/accounts/{account_id}/stream/{identifier}/captions/{language}/generate":{"post":{"description":"Generate captions or subtitles for provided language via AI.","operationId":"stream-subtitles/-captions-generate-caption-or-subtitle-for-language","parameters":[{"in":"path","name":"language","required":true,"schema":{"$ref":"#/components/schemas/stream_language"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_language_response_single"}}},"description":"Generate captions or subtitles response for a provided language."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Generate captions or subtitles response for a provided language."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Generate captions or subtitles for a provided language via AI","tags":["Stream Subtitles/Captions"]}},"/accounts/{account_id}/stream/{identifier}/captions/{language}/vtt":{"get":{"description":"Return WebVTT captions for a provided language.","operationId":"stream-subtitles/-captions-get-vtt-caption-or-subtitle","parameters":[{"in":"path","name":"language","required":true,"schema":{"$ref":"#/components/schemas/stream_language"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"text/vtt":{"schema":{"example":"'WEBVTT\n 00:00:00.000 --\u003e 00:00:02.480\n This is example response'\n","type":"string"}}},"description":"Return WebVTT caption or subtitle response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Return WebVTT caption or subtitle response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Return WebVTT captions for a provided language","tags":["Stream Subtitles/Captions"],"x-api-token-group":["Stream Write","Stream Read"]}},"/accounts/{account_id}/stream/{identifier}/downloads":{"delete":{"description":"Delete the downloads for a video. Use `/downloads/{download_type}` instead for type-specific downloads. Available types are `default` and `audio`.","operationId":"stream-m-p-4-downloads-delete-downloads","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_deleted_response"}}},"description":"Delete downloads response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Delete downloads response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete downloads","tags":["Stream MP4 Downloads"],"x-api-token-group":["Stream Write"]},"get":{"description":"Lists the downloads created for a video.","operationId":"stream-m-p-4-downloads-list-downloads","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_downloads_response"}}},"description":"List downloads response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"List downloads response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List downloads","tags":["Stream MP4 Downloads"],"x-api-token-group":["Stream Write","Stream Read"]},"post":{"description":"Creates a download for a video when a video is ready to view. Use `/downloads/{download_type}` instead for type-specific downloads. Available types are `default` and `audio`.","operationId":"stream-m-p-4-downloads-create-downloads","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_downloads_response"}}},"description":"Create downloads response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Create downloads response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create downloads","tags":["Stream MP4 Downloads"]}},"/accounts/{account_id}/stream/{identifier}/downloads/{download_type}":{"delete":{"description":"Delete specific type of download. For backwards-compatibility, DELETE requests to /downloads will delete the default download.","operationId":"stream-downloads-delete-type-specific-downloads","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}},{"in":"path","name":"download_type","required":true,"schema":{"$ref":"#/components/schemas/stream_download_type"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_deleted_response"}}},"description":"Delete downloads response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Delete downloads response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete download","tags":["Stream MP4 Downloads"],"x-api-token-group":["Stream Write"]},"post":{"description":"Creates a download for a video of specified type. For backwards-compatibility, POST requests to /downloads will enable the default download.","operationId":"stream-downloads-create-type-specific-downloads","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_schemas-identifier"}},{"in":"path","name":"download_type","required":true,"schema":{"$ref":"#/components/schemas/stream_download_type"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_downloads_response"}}},"description":"Create download of specified type response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Create downloads of specified type response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create download","tags":["Stream MP4 Downloads"]}},"/accounts/{account_id}/stream/{identifier}/embed":{"get":{"description":"Fetches an HTML code snippet to embed a video in a web page delivered through Cloudflare. On success, returns an HTML fragment for use on web pages to display a video. On failure, returns a JSON response body.","operationId":"stream-videos-retreieve-embed-code-html","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"example":"\u003cstream id=\"ea95132c15732412d22c1476fa83f27a\"\u003e\u003c/stream\u003e\u003cscript data-cfasync=\"false\" defer type=\"text/javascript\" src=\"https://embed.cloudflarestream.com/embed/we4g.fla9.latest.js\"\u003e\u003c/script\u003e","type":"string"}}},"description":"Retreieve embed Code HTML response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Retreieve embed Code HTML response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve embed Code HTML","tags":["Stream Videos"],"x-api-token-group":["Stream Write","Stream Read"]}},"/accounts/{account_id}/stream/{identifier}/token":{"post":{"description":"Creates a signed URL token for a video. If a body is not provided in the request, a token is created with default values.","operationId":"stream-videos-create-signed-url-tokens-for-videos","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/stream_identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/stream_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_signed_token_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_signed_token_response"}}},"description":"Create signed URL tokens for videos response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/stream_api-response-common-failure"}}},"description":"Create signed URL tokens for videos response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create signed URL tokens for videos","tags":["Stream Videos"]}},"/accounts/{account_id}/subscriptions":{"get":{"description":"Lists all of an account's subscriptions.","operationId":"account-subscriptions-list-subscriptions","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_account_subscription_response_collection"}}},"description":"List Subscriptions response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_account_subscription_response_collection"},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"List Subscriptions response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Subscriptions","tags":["Account Subscriptions"],"x-api-token-group":["Billing Write","Billing Read"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates an account subscription.","operationId":"account-subscriptions-create-subscription","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_subscription-v2"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_account_subscription_response_single"}}},"description":"Create Subscription response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_account_subscription_response_single"},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"Create Subscription response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Subscription","tags":["Account Subscriptions"],"x-api-token-group":["Billing Write"],"x-cfPermissionsRequired":{"enum":["#billing:read","#billing:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/subscriptions/{subscription_identifier}":{"delete":{"description":"Deletes an account's subscription.","operationId":"account-subscriptions-delete-subscription","parameters":[{"in":"path","name":"subscription_identifier","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-single"},{"properties":{"result":{"properties":{"subscription_id":{"$ref":"#/components/schemas/bill-subs-api_schemas-identifier"}},"type":"object"}}}]}}},"description":"Delete Subscription response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-single"},{"properties":{"result":{"properties":{"subscription_id":{"$ref":"#/components/schemas/bill-subs-api_schemas-identifier"}},"type":"object"}}}]},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"Delete Subscription response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Subscription","tags":["Account Subscriptions"],"x-api-token-group":["Billing Write"],"x-cfPermissionsRequired":{"enum":["#billing:edit"]}},"put":{"description":"Updates an account subscription.","operationId":"account-subscriptions-update-subscription","parameters":[{"in":"path","name":"subscription_identifier","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_schemas-identifier"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_subscription-v2"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_account_subscription_response_single"}}},"description":"Update Subscription response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_account_subscription_response_single"},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"Update Subscription response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Subscription","tags":["Account Subscriptions"],"x-api-token-group":["Billing Write"],"x-cfPermissionsRequired":{"enum":["#billing:read","#billing:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/teamnet/routes":{"get":{"description":"Lists and filters private network routes in an account.","operationId":"tunnel-route-list-tunnel-routes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"query","name":"comment","schema":{"$ref":"#/components/schemas/tunnel_route_comment"}},{"in":"query","name":"is_deleted","schema":{"description":"If `true`, only include deleted routes. If `false`, exclude deleted routes. If empty, all routes will be included.","type":"boolean"}},{"in":"query","name":"network_subset","schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_ip_network"}],"description":"If set, only list routes that are contained within this IP range."}},{"in":"query","name":"network_superset","schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_ip_network"}],"description":"If set, only list routes that contain this IP range."}},{"in":"query","name":"existed_at","schema":{"$ref":"#/components/schemas/tunnel_existed_at"}},{"in":"query","name":"tunnel_id","schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}},{"in":"query","name":"route_id","schema":{"$ref":"#/components/schemas/tunnel_route_id"}},{"in":"query","name":"tun_types","schema":{"$ref":"#/components/schemas/tunnel_tunnel_types"}},{"in":"query","name":"virtual_network_id","schema":{"$ref":"#/components/schemas/tunnel_virtual_network_id"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/tunnel_per_page"}},{"in":"query","name":"page","schema":{"$ref":"#/components/schemas/tunnel_page_number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_teamnet_response_collection"}}},"description":"List tunnel routes response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_teamnet_response_collection"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"List tunnel routes response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List tunnel routes","tags":["Tunnel Routing"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare One Networks Read","Cloudflare Tunnel Write","Cloudflare Tunnel Read"]},"post":{"description":"Routes a private network through a Cloudflare Tunnel.","operationId":"tunnel-route-create-a-tunnel-route","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_route_comment"},"network":{"$ref":"#/components/schemas/tunnel_ip_network"},"tunnel_id":{"$ref":"#/components/schemas/tunnel_tunnel_id"},"virtual_network_id":{"$ref":"#/components/schemas/tunnel_virtual_network_id_computed_optional"}},"required":["network","tunnel_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_route_response_single"}}},"description":"Create a tunnel route response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_route_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Create a tunnel route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Create a tunnel route","tags":["Tunnel Routing"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare Tunnel Write"]}},"/accounts/{account_id}/teamnet/routes/ip/{ip}":{"get":{"description":"Fetches routes that contain the given IP address.","operationId":"tunnel-route-get-tunnel-route-by-ip","parameters":[{"in":"path","name":"ip","required":true,"schema":{"$ref":"#/components/schemas/tunnel_ip"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"query","name":"virtual_network_id","schema":{"$ref":"#/components/schemas/tunnel_virtual_network_id"}},{"description":"When the virtual_network_id parameter is not provided the request filter will default search routes that are in the default virtual network for the account. If this parameter is set to false, the search will include routes that do not have a virtual network.","in":"query","name":"default_virtual_network_fallback","schema":{"default":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_teamnet_response_single"}}},"description":"Get tunnel route by IP response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_teamnet_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Get tunnel route by IP response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get tunnel route by IP","tags":["Tunnel Routing"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare One Networks Read","Cloudflare Tunnel Write","Cloudflare Tunnel Read"]}},"/accounts/{account_id}/teamnet/routes/network/{ip_network_encoded}":{"delete":{"deprecated":true,"description":"Deletes a private network route from an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format. If no virtual_network_id is provided it will delete the route from the default vnet. If no tun_type is provided it will fetch the type from the tunnel_id or if that is missing it will assume Cloudflare Tunnel as default. If tunnel_id is provided it will delete the route from that tunnel, otherwise it will delete the route based on the vnet and tun_type.\n","operationId":"tunnel-route-delete-a-tunnel-route-with-cidr","parameters":[{"in":"path","name":"ip_network_encoded","required":true,"schema":{"$ref":"#/components/schemas/tunnel_ip_network_encoded"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"query","name":"virtual_network_id","schema":{"$ref":"#/components/schemas/tunnel_virtual_network_id"}},{"in":"query","name":"tun_type","schema":{"$ref":"#/components/schemas/tunnel_tunnel_type"}},{"in":"query","name":"tunnel_id","schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_route_response_single"}}},"description":"Delete a tunnel route response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_route_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Delete a tunnel route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Delete a tunnel route (CIDR Endpoint)","tags":["Tunnel Routing"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare Tunnel Write"],"x-stainless-deprecation-message":"This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs."},"patch":{"deprecated":true,"description":"Updates an existing private network route in an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format.","operationId":"tunnel-route-update-a-tunnel-route-with-cidr","parameters":[{"in":"path","name":"ip_network_encoded","required":true,"schema":{"$ref":"#/components/schemas/tunnel_ip_network_encoded"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_route_response_single"}}},"description":"Update a tunnel route response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_route_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Update a tunnel route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Update a tunnel route (CIDR Endpoint)","tags":["Tunnel Routing"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare Tunnel Write"],"x-stainless-deprecation-message":"This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs."},"post":{"deprecated":true,"description":"Routes a private network through a Cloudflare Tunnel. The CIDR in `ip_network_encoded` must be written in URL-encoded format.","operationId":"tunnel-route-create-a-tunnel-route-with-cidr","parameters":[{"in":"path","name":"ip_network_encoded","required":true,"schema":{"$ref":"#/components/schemas/tunnel_ip_network_encoded"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_route_comment"},"tunnel_id":{"$ref":"#/components/schemas/tunnel_tunnel_id"},"virtual_network_id":{"$ref":"#/components/schemas/tunnel_virtual_network_id"}},"required":["tunnel_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_route_response_single"}}},"description":"Create a tunnel route response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_route_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Create a tunnel route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Create a tunnel route (CIDR Endpoint)","tags":["Tunnel Routing"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare Tunnel Write"],"x-stainless-deprecation-message":"This endpoint and its related APIs are deprecated in favor of the equivalent Tunnel Route (without CIDR) APIs."}},"/accounts/{account_id}/teamnet/routes/{route_id}":{"delete":{"description":"Deletes a private network route from an account.\n","operationId":"tunnel-route-delete-a-tunnel-route","parameters":[{"in":"path","name":"route_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_route_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_route_response_single"}}},"description":"Delete a tunnel route response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_route_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Delete a tunnel route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Delete a tunnel route","tags":["Tunnel Routing"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare Tunnel Write"]},"get":{"description":"Get a private network route in an account.","operationId":"tunnel-route-get-tunnel-route","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"route_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_route_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_route_response_single"}}},"description":"Get a tunnel route response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_route_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Get a tunnel route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get tunnel route","tags":["Tunnel Routing"]},"patch":{"description":"Updates an existing private network route in an account. The fields that are meant to be updated should be provided in the body of the request.","operationId":"tunnel-route-update-a-tunnel-route","parameters":[{"in":"path","name":"route_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_route_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_route_comment"},"network":{"$ref":"#/components/schemas/tunnel_ip_network"},"tunnel_id":{"$ref":"#/components/schemas/tunnel_tunnel_id"},"virtual_network_id":{"$ref":"#/components/schemas/tunnel_virtual_network_id_computed_optional"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_route_response_single"}}},"description":"Update a tunnel route response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_route_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Update a tunnel route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Update a tunnel route","tags":["Tunnel Routing"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare Tunnel Write"]}},"/accounts/{account_id}/teamnet/virtual_networks":{"get":{"description":"Lists and filters virtual networks in an account.","operationId":"tunnel-virtual-network-list-virtual-networks","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"query","name":"id","schema":{"$ref":"#/components/schemas/tunnel_virtual_network_id"}},{"in":"query","name":"name","schema":{"$ref":"#/components/schemas/tunnel_virtual_network_name"}},{"deprecated":true,"in":"query","name":"is_default","schema":{"description":"If `true`, only include the default virtual network. If `false`, exclude the default virtual network. If empty, all virtual networks will be included.","type":"boolean"},"x-stainless-deprecation-message":"Use the is_default_network property instead.","x-stainless-ignore":true},{"in":"query","name":"is_default_network","schema":{"description":"If `true`, only include the default virtual network. If `false`, exclude the default virtual network. If empty, all virtual networks will be included.","type":"boolean"}},{"in":"query","name":"is_deleted","schema":{"description":"If `true`, only include deleted virtual networks. If `false`, exclude deleted virtual networks. If empty, all virtual networks will be included.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_vnet_response_collection"}}},"description":"List virtual networks response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_vnet_response_collection"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"List virtual networks response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List virtual networks","tags":["Tunnel Virtual Network"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare One Networks Read","Cloudflare Tunnel Write","Cloudflare Tunnel Read"]},"post":{"description":"Adds a new virtual network to an account.","operationId":"tunnel-virtual-network-create-a-virtual-network","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_virtual_network_comment"},"is_default":{"deprecated":true,"description":"If `true`, this virtual network is the default for the account.","example":true,"type":"boolean","x-auditable":true,"x-stainless-deprecation-message":"Use the is_default_network property instead.","x-stainless-ignore":true},"is_default_network":{"$ref":"#/components/schemas/tunnel_is_default_network_optional"},"name":{"$ref":"#/components/schemas/tunnel_virtual_network_name"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_vnet_response_single"}}},"description":"Create a virtual network response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_vnet_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Create a virtual network response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Create a virtual network","tags":["Tunnel Virtual Network"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare Tunnel Write"]}},"/accounts/{account_id}/teamnet/virtual_networks/{virtual_network_id}":{"delete":{"description":"Deletes an existing virtual network.","operationId":"tunnel-virtual-network-delete","parameters":[{"in":"path","name":"virtual_network_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_virtual_network_id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_vnet_response_single"}}},"description":"Delete a virtual network response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_vnet_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Delete a virtual network response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Delete a virtual network","tags":["Tunnel Virtual Network"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare Tunnel Write"]},"get":{"description":"Get a virtual network.","operationId":"tunnel-virtual-network-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"virtual_network_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_virtual_network_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_virtual_network_comment"},"is_default_network":{"$ref":"#/components/schemas/tunnel_is_default_network"},"name":{"$ref":"#/components/schemas/tunnel_virtual_network_name"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_vnet_response_single"}}},"description":"A virtual network response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_vnet_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"A virtual network response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get a virtual network","tags":["Tunnel Virtual Network"]},"patch":{"description":"Updates an existing virtual network.","operationId":"tunnel-virtual-network-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"virtual_network_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_virtual_network_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_virtual_network_comment"},"is_default_network":{"$ref":"#/components/schemas/tunnel_is_default_network_optional"},"name":{"$ref":"#/components/schemas/tunnel_virtual_network_name"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_vnet_response_single"}}},"description":"Update a virtual network response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_vnet_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Update a virtual network response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Update a virtual network","tags":["Tunnel Virtual Network"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare Tunnel Write"]}},"/accounts/{account_id}/tokens":{"get":{"description":"List all Account Owned API tokens created for this account.","operationId":"account-api-tokens-list-tokens","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"direction","schema":{"description":"Direction to order results.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_collection_tokens_response"}}},"description":"List Tokens response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"List Tokens response failure"}},"security":[{"api_token":[]}],"summary":"List Tokens","tags":["Account Owned API Tokens"],"x-api-token-group":["Account API Tokens Write","Account API Tokens Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.token.list"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a new Account Owned API token.","operationId":"account-api-tokens-create-token","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_create_payload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_token_create_response"}}},"description":"Create Token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Create Token response failure"}},"security":[{"api_token":[]}],"summary":"Create Token","tags":["Account Owned API Tokens"],"x-api-token-group":["Account API Tokens Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.token.create"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/tokens/permission_groups":{"get":{"description":"Find all available permission groups for Account Owned API Tokens","operationId":"account-api-tokens-list-permission-groups","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"description":"Filter by the name of the permission group.\nThe value must be URL-encoded.","in":"query","name":"name","schema":{"example":"Account%20Settings%20Write","type":"string"}},{"description":"Filter by the scope of the permission group.\nThe value must be URL-encoded.","in":"query","name":"scope","schema":{"example":"com.cloudflare.api.account.zone","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_permissions_group_response_collection"}}},"description":"List Account Owned API Token Permission Groups response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"List Account Owned API Token Permission Groups response failure"}},"security":[{"api_token":[]}],"summary":"List Permission Groups","tags":["Account Owned API Tokens"],"x-api-token-group":["Account API Tokens Write","Account API Tokens Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.token.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/tokens/verify":{"get":{"description":"Test whether a token works.","operationId":"account-api-tokens-verify-token","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_token_verify_response_single_segment"}}},"description":"Verify Token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Verify Token response failure"}},"security":[{"api_token":[]}],"summary":"Verify Token","tags":["Account Owned API Tokens"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/tokens/{token_id}":{"delete":{"description":"Destroy an Account Owned API token.","operationId":"account-api-tokens-delete-token","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"token_id","required":true,"schema":{"$ref":"#/components/schemas/iam_token_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-single-id"}}},"description":"Delete Token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Delete Token response failure"}},"security":[{"api_token":[]}],"summary":"Delete Token","tags":["Account Owned API Tokens"],"x-api-token-group":["Account API Tokens Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.token.delete"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get information about a specific Account Owned API token.","operationId":"account-api-tokens-token-details","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"token_id","required":true,"schema":{"$ref":"#/components/schemas/iam_token_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_token_response"}}},"description":"Token Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Token Details response failure"}},"security":[{"api_token":[]}],"summary":"Token Details","tags":["Account Owned API Tokens"],"x-api-token-group":["Account API Tokens Write","Account API Tokens Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.token.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Update an existing token.","operationId":"account-api-tokens-update-token","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"token_id","required":true,"schema":{"$ref":"#/components/schemas/iam_token_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_token_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_token_response"}}},"description":"Update Token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Update Token response failure"}},"security":[{"api_token":[]}],"summary":"Update Token","tags":["Account Owned API Tokens"],"x-api-token-group":["Account API Tokens Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.token.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/tokens/{token_id}/value":{"put":{"description":"Roll the Account Owned API token secret.","operationId":"account-api-tokens-roll-token","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/iam_account_identifier"}},{"in":"path","name":"token_id","required":true,"schema":{"$ref":"#/components/schemas/iam_token_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_response_single_value"}}},"description":"Roll Token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Roll Token response failure"}},"security":[{"api_token":[]}],"summary":"Roll Token","tags":["Account Owned API Tokens"],"x-api-token-group":["Account API Tokens Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.token.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/tunnels":{"get":{"description":"Lists and filters all types of Tunnels in an account.","operationId":"cloudflare-tunnel-list-all-tunnels","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"query","name":"name","schema":{"description":"A user-friendly name for the tunnel.","example":"blog","type":"string"}},{"in":"query","name":"is_deleted","schema":{"description":"If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.","example":true,"type":"boolean"}},{"in":"query","name":"existed_at","schema":{"$ref":"#/components/schemas/tunnel_existed_at"}},{"in":"query","name":"uuid","schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}},{"in":"query","name":"was_active_at","schema":{"example":"2009-11-10T23:00:00Z","format":"date-time","type":"string"}},{"in":"query","name":"was_inactive_at","schema":{"example":"2009-11-10T23:00:00Z","format":"date-time","type":"string"}},{"in":"query","name":"include_prefix","schema":{"example":"vpc1-","type":"string"}},{"in":"query","name":"exclude_prefix","schema":{"example":"vpc1-","type":"string"}},{"in":"query","name":"tun_types","schema":{"$ref":"#/components/schemas/tunnel_tunnel_types"}},{"in":"query","name":"status","schema":{"$ref":"#/components/schemas/tunnel_status"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/tunnel_per_page"}},{"in":"query","name":"page","schema":{"$ref":"#/components/schemas/tunnel_page_number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_tunnel-response-collection"}}},"description":"List Tunnels response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_tunnel-response-collection"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"List Tunnels response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List All Tunnels","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connectors Read","Cloudflare One Connector: cloudflared Write","Cloudflare One Connector: cloudflared Read","Cloudflare Tunnel Write","Cloudflare Tunnel Read"]}},"/accounts/{account_id}/urlscanner/response/{response_id}":{"get":{"deprecated":true,"description":"Returns the plain response of the network request.","operationId":"urlscanner-get-response-text","parameters":[{"description":"Response hash.","in":"path","name":"response_id","required":true,"schema":{"description":"Response hash.","type":"string"}},{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"responses":{"200":{"content":{"text/plain":{"schema":{"description":"Web resource text/image.","type":"string"}}},"description":"When `har.log.entries[].response._cf.contentAvailable` is `true`, use `response._cf.hash` value to fetch the raw response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Scan ID is not a valid UUID.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success"],"type":"object"}}},"description":"Invalid params."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Scan not found.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success"],"type":"object"}}},"description":"Scan not found."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get raw response","tags":["URL Scanner (Deprecated)"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [V2](https://developers.cloudflare.com/api/resources/url_scanner/subresources/responses/methods/get/) instead."}},"/accounts/{account_id}/urlscanner/scan":{"get":{"deprecated":true,"description":"Search scans by date and webpages' requests, including full URL (after redirects), hostname, and path. \u003cbr/\u003e A successful scan will appear in search results a few minutes after finishing but may take much longer if the system in under load. By default, only successfully completed scans will appear in search results, unless searching by `scanId`. Please take into account that older scans may be removed from the search index at an unspecified time.","operationId":"urlscanner-search-scans","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Scan UUID.","in":"query","name":"scan_id","schema":{"description":"Scan UUID.","format":"uuid","type":"string"}},{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"description":"Limit the number of objects in the response.","example":100,"type":"integer"}},{"description":"Pagination cursor to get the next set of results.","in":"query","name":"next_cursor","schema":{"description":"Pagination cursor to get the next set of results.","type":"string"}},{"description":"Filter scans requested after date (inclusive).","in":"query","name":"date_start","schema":{"description":"Filter scans requested after date (inclusive).","format":"date-time","type":"string"}},{"description":"Filter scans requested before date (inclusive).","in":"query","name":"date_end","schema":{"description":"Filter scans requested before date (inclusive).","format":"date-time","type":"string"}},{"description":"Filter scans by URL of _any_ request made by the webpage","in":"query","name":"url","schema":{"description":"Filter scans by URL of _any_ request made by the webpage","example":"https://example.com/?hello","type":"string"}},{"description":"Filter scans by hostname of _any_ request made by the webpage.","in":"query","name":"hostname","schema":{"description":"Filter scans by hostname of _any_ request made by the webpage.","example":"example.com","type":"string"}},{"description":"Filter scans by url path of _any_ request made by the webpage.","in":"query","name":"path","schema":{"description":"Filter scans by url path of _any_ request made by the webpage.","example":"/samples/subresource-integrity/","type":"string"}},{"description":"Filter scans by IP address (IPv4 or IPv6) of _any_ request made by the webpage.","in":"query","name":"ip","schema":{"description":"Filter scans by IP address (IPv4 or IPv6) of _any_ request made by the webpage.","example":"1.1.1.1","type":"string"}},{"description":"Filter scans by hash of any html/js/css request made by the webpage.","in":"query","name":"hash","schema":{"description":"Filter scans by hash of any html/js/css request made by the webpage.","type":"string"}},{"description":"Filter scans by submitted or scanned URL","in":"query","name":"page_url","schema":{"description":"Filter scans by submitted or scanned URL","type":"string"}},{"description":"Filter scans by main page hostname (domain of effective URL).","in":"query","name":"page_hostname","schema":{"description":"Filter scans by main page hostname (domain of effective URL).","type":"string"}},{"description":"Filter scans by exact match of effective URL path (also supports suffix search).","in":"query","name":"page_path","schema":{"description":"Filter scans by exact match of effective URL path (also supports suffix search).","type":"string"}},{"description":"Filter scans by main page Autonomous System Number (ASN).","in":"query","name":"page_asn","schema":{"description":"Filter scans by main page Autonomous System Number (ASN).","type":"string"}},{"description":"Filter scans by  main page IP address (IPv4 or IPv6).","in":"query","name":"page_ip","schema":{"description":"Filter scans by  main page IP address (IPv4 or IPv6).","type":"string"}},{"description":"Return only scans created by account.","in":"query","name":"account_scans","schema":{"description":"Return only scans created by account.","type":"boolean"}},{"description":"Filter scans by malicious verdict.","in":"query","name":"is_malicious","schema":{"description":"Filter scans by malicious verdict.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Error","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"example":"OK","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"properties":{"tasks":{"items":{"properties":{"country":{"description":"Alpha-2 country code","type":"string"},"success":{"description":"Whether scan was successful or not","type":"boolean"},"time":{"description":"When scan was submitted (UTC)","format":"date-time","type":"string"},"url":{"description":"Scan url (after redirects)","example":"https://www.example.com/","type":"string"},"uuid":{"description":"Scan id","format":"uuid","type":"string"},"visibility":{"description":"Submitted visibility status.","enum":["public","unlisted"],"example":"public","type":"string"}},"required":["uuid","url","success","time","country","visibility"],"type":"object"},"type":"array"}},"required":["tasks"],"type":"object"},"success":{"description":"Whether search request was successful or not","type":"boolean"}},"required":["messages","errors","success","result"],"type":"object"}}},"description":"Search results"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Scan ID is not a valid UUID.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success"],"type":"object"}}},"description":"Invalid params."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Search URL scans","tags":["URL Scanner (Deprecated)"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [V2](https://developers.cloudflare.com/api/resources/url_scanner/subresources/scans/methods/list/) instead."},"post":{"deprecated":true,"description":"Submit a URL to scan. You can also set some options, like the visibility level and custom headers. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/.","operationId":"urlscanner-create-scan","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"country":{"description":"Country to geo egress from","enum":["AF","AL","DZ","AD","AO","AG","AR","AM","AU","AT","AZ","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BR","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CO","KM","CG","CR","CI","HR","CU","CY","CZ","CD","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FJ","FI","FR","GA","GE","DE","GH","GR","GL","GD","GT","GN","GW","GY","HT","HN","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MR","MU","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NZ","NI","NE","NG","KP","MK","NO","OM","PK","PS","PA","PG","PY","PE","PH","PL","PT","QA","RO","RU","RW","SH","KN","LC","VC","WS","SM","ST","SA","SN","RS","SC","SL","SK","SI","SB","SO","ZA","KR","SS","ES","LK","SD","SR","SE","CH","SY","TW","TJ","TZ","TH","BS","GM","TL","TG","TO","TT","TN","TR","TM","UG","UA","AE","GB","US","UY","UZ","VU","VE","VN","YE","ZM","ZW"],"type":"string"},"customHeaders":{"additionalProperties":{"type":"string"},"description":"Set custom headers.","type":"object"},"screenshotsResolutions":{"default":["desktop"],"description":"Take multiple screenshots targeting different device types.","items":{"default":"desktop","description":"Device resolutions.","enum":["desktop","mobile","tablet"],"type":"string"},"type":"array"},"url":{"example":"https://www.example.com","type":"string"},"visibility":{"default":"Public","description":"The option `Public` means it will be included in listings like recent scans and search results. `Unlisted` means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material.","enum":["Public","Unlisted"],"type":"string"}},"required":["url"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Submission unsuccessful","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"example":"Submission successful","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"properties":{"time":{"description":"Time when url was submitted for scanning.","format":"date-time","type":"string"},"url":{"description":"Canonical form of submitted URL. Use this if you want to later search by URL.","type":"string"},"uuid":{"description":"Scan ID.","format":"uuid","type":"string"},"visibility":{"description":"Submitted visibility status.","enum":["public","unlisted"],"example":"public","type":"string"}},"required":["visibility","uuid","url","time"],"type":"object"},"success":{"type":"boolean"}},"required":["messages","errors","success","result"],"type":"object"}}},"description":"Scan request accepted successfully."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Scan ID is not a valid UUID.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success"],"type":"object"}}},"description":"Invalid params."},"409":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Submission unsuccessful","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"properties":{"tasks":{"items":{"properties":{"clientLocation":{"description":"Submitter location","example":"PT","type":"string"},"clientType":{"enum":["Site","Automatic","Api"],"type":"string"},"effectiveUrl":{"description":"URL of the primary request, after all HTTP redirects","example":"http://example.com/","type":"string"},"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"scannedFrom":{"properties":{"colo":{"description":"IATA code of Cloudflare datacenter","example":"MAD","type":"string"}},"required":["colo"],"type":"object"},"status":{"enum":["Queued","InProgress","InPostProcessing","Finished"],"type":"string"},"success":{"example":true,"type":"boolean"},"time":{"example":"2023-05-03T17:05:04.843Z","type":"string"},"timeEnd":{"example":"2023-05-03T17:05:19.374Z","type":"string"},"url":{"description":"Submitted URL","example":"http://example.com","type":"string"},"uuid":{"description":"Scan ID","example":"2ee568d0-bf70-4827-b922-b7088c0f056f","type":"string"},"visibility":{"enum":["Public","Unlisted"],"type":"string"}},"required":["uuid","url","status","success","errors","time","timeEnd","visibility","clientLocation","clientType","effectiveUrl","scannedFrom"],"type":"object"},"type":"array"}},"required":["tasks"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["messages","errors","success","result"],"type":"object"}}},"description":"Scan request denied: hostname was recently scanned."},"429":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Submission unsuccessful","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"example":true,"type":"boolean"}},"required":["messages","errors","success"],"type":"object"}}},"description":"Scan request denied: rate limited."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create URL Scan","tags":["URL Scanner (Deprecated)"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [V2](https://developers.cloudflare.com/api/resources/url_scanner/subresources/scans/methods/create/) instead."}},"/accounts/{account_id}/urlscanner/scan/{scan_id}":{"get":{"deprecated":true,"description":"Get URL scan by uuid","operationId":"urlscanner-get-scan","parameters":[{"description":"Scan UUID.","in":"path","name":"scan_id","required":true,"schema":{"description":"Scan UUID.","format":"uuid","type":"string"}},{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Whether to return full report (scan summary and network log).","in":"query","name":"full","schema":{"description":"Whether to return full report (scan summary and network log).","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Error","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"example":"OK","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"properties":{"scan":{"properties":{"asns":{"description":"Dictionary of Autonomous System Numbers where ASN's are the keys","properties":{"asn":{"description":"ASN's contacted","properties":{"asn":{"example":"15133","type":"string"},"description":{"example":"EDGECAST","type":"string"},"location_alpha2":{"example":"US","type":"string"},"name":{"example":"EDGECAST","type":"string"},"org_name":{"example":"Edgecast Inc.","type":"string"}},"required":["asn","name","description","org_name","location_alpha2"],"type":"object"}},"type":"object"},"certificates":{"items":{"properties":{"issuer":{"type":"string"},"subjectName":{"example":"rkmod.somee.com","type":"string"},"validFrom":{"example":1682684400,"type":"number"},"validTo":{"example":1696698000,"type":"number"}},"required":["issuer","subjectName","validFrom","validTo"],"type":"object"},"type":"array"},"domains":{"properties":{"example.com":{"properties":{"categories":{"properties":{"content":{"items":{"properties":{"id":{"type":"integer"},"name":{"example":"Technology","type":"string"},"super_category_id":{"type":"integer"}},"required":["id","name"],"type":"object"},"type":"array"},"inherited":{"properties":{"content":{"items":{"properties":{"id":{"type":"integer"},"name":{"example":"Technology","type":"string"},"super_category_id":{"type":"integer"}},"required":["id","name"],"type":"object"},"type":"array"},"from":{"example":"example.com","type":"string"},"risks":{"items":{"properties":{"id":{"type":"integer"},"name":{"example":"Technology","type":"string"},"super_category_id":{"type":"integer"}},"required":["id","name"],"type":"object"},"type":"array"}},"type":"object"},"risks":{"items":{"properties":{"id":{"type":"integer"},"name":{"example":"Technology","type":"string"},"super_category_id":{"type":"integer"}},"required":["id","name"],"type":"object"},"type":"array"}},"required":["inherited"],"type":"object"},"dns":{"items":{"properties":{"address":{"example":"93.184.216.34","type":"string"},"dnssec_valid":{"type":"boolean"},"name":{"example":"example.com","type":"string"},"type":{"example":"A","type":"string"}},"required":["name","address","type","dnssec_valid"],"type":"object"},"type":"array"},"name":{"example":"example.com","type":"string"},"rank":{"properties":{"bucket":{"example":"500","type":"string"},"name":{"example":"example.com","type":"string"},"rank":{"description":"Rank in the Global Radar Rank, if set. See more at https://blog.cloudflare.com/radar-domain-rankings/","type":"integer"}},"required":["name","bucket"],"type":"object"},"type":{"example":"Apex domain","type":"string"}},"required":["name","type","categories","dns","rank"],"type":"object"}},"type":"object"},"geo":{"properties":{"continents":{"items":{"description":"GeoIP continent location","example":"North America","type":"string"},"type":"array"},"locations":{"items":{"description":"GeoIP country location","example":"US","type":"string"},"type":"array"}},"required":["locations","continents"],"type":"object"},"ips":{"properties":{"ip":{"properties":{"asn":{"example":"15133","type":"string"},"asnDescription":{"example":"EDGECAST","type":"string"},"asnLocationAlpha2":{"example":"US","type":"string"},"asnName":{"example":"EDGECAST","type":"string"},"asnOrgName":{"example":"Edgecast Inc.","type":"string"},"continent":{"example":"North America","type":"string"},"geonameId":{"example":"6252001","type":"string"},"ip":{"example":"2606:2800:220:1:248:1893:25c8:1946","type":"string"},"ipVersion":{"example":"IPv6","type":"string"},"latitude":{"example":"39.76","type":"string"},"locationAlpha2":{"example":"US","type":"string"},"locationName":{"example":"United States","type":"string"},"longitude":{"example":"-98.5","type":"string"},"subdivision1Name":{"type":"string"},"subdivision2Name":{"type":"string"}},"required":["ip","ipVersion","locationAlpha2","locationName","subdivision1Name","subdivision2Name","latitude","longitude","continent","geonameId","asn","asnName","asnOrgName","asnDescription","asnLocationAlpha2"],"type":"object"}},"type":"object"},"links":{"properties":{"link":{"properties":{"href":{"description":"Outgoing link detected in the DOM","example":"https://www.iana.org/domains/example","type":"string"},"text":{"example":"More information...","type":"string"}},"required":["href","text"],"type":"object"}},"type":"object"},"meta":{"properties":{"processors":{"properties":{"categories":{"properties":{"content":{"items":{"properties":{"id":{"example":155,"type":"integer"},"name":{"example":"Technology","type":"string"},"super_category_id":{"type":"integer"}},"required":["id","name"],"type":"object"},"type":"array"},"risks":{"items":{"properties":{"id":{"example":17,"type":"integer"},"name":{"example":"Newly Seen Domains","type":"string"},"super_category_id":{"example":32,"type":"integer"}},"required":["id","super_category_id","name"],"type":"object"},"type":"array"}},"required":["content","risks"],"type":"object"},"phishing":{"items":{"example":"CredentialHarvester","type":"string"},"type":"array"},"rank":{"properties":{"bucket":{"example":"500","type":"string"},"name":{"example":"example.com","type":"string"},"rank":{"description":"Rank in the Global Radar Rank, if set. See more at https://blog.cloudflare.com/radar-domain-rankings/","type":"integer"}},"required":["name","bucket"],"type":"object"},"tech":{"items":{"properties":{"categories":{"items":{"properties":{"groups":{"items":{"type":"integer"},"type":"array"},"id":{"example":63,"type":"integer"},"name":{"example":"IAAS","type":"string"},"priority":{"example":8,"type":"integer"},"slug":{"example":"iaas","type":"string"}},"required":["id","slug","groups","name","priority"],"type":"object"},"type":"array"},"confidence":{"example":100,"type":"integer"},"description":{"type":"string"},"evidence":{"properties":{"impliedBy":{"items":{"type":"string"},"type":"array"},"patterns":{"items":{"properties":{"confidence":{"example":100,"type":"integer"},"excludes":{"items":{"type":"string"},"type":"array"},"implies":{"items":{"type":"string"},"type":"array"},"match":{"example":"ECS","type":"string"},"name":{"description":"Header or Cookie name when set","example":"server","type":"string"},"regex":{"example":"^ECS","type":"string"},"type":{"example":"headers","type":"string"},"value":{"example":"ECS (dcb/7EEE)","type":"string"},"version":{"type":"string"}},"required":["type","regex","value","match","name","confidence","version","implies","excludes"],"type":"object"},"type":"array"}},"required":["patterns","impliedBy"],"type":"object"},"icon":{"example":"Amazon ECS.svg","type":"string"},"name":{"example":"Amazon ECS","type":"string"},"slug":{"example":"amazon-ecs","type":"string"},"website":{"example":"https://aws.amazon.com/ecs/","type":"string"}},"required":["name","slug","categories","confidence","icon","website","evidence"],"type":"object"},"type":"array"}},"required":["tech","categories","rank","phishing"],"type":"object"}},"required":["processors"],"type":"object"},"page":{"properties":{"asn":{"example":"15133","type":"string"},"asnLocationAlpha2":{"example":"US","type":"string"},"asnname":{"example":"EDGECAST","type":"string"},"console":{"items":{"properties":{"category":{"example":"network","type":"string"},"text":{"example":"Failed to load resource: the server responded with a status of 404 (Not Found)","type":"string"},"type":{"example":"error","type":"string"},"url":{"example":"http://example.com/favicon.ico","type":"string"}},"required":["type","text","category"],"type":"object"},"type":"array"},"cookies":{"items":{"properties":{"domain":{"example":"rkmod.somee.com","type":"string"},"expires":{"example":-1,"type":"number"},"httpOnly":{"type":"boolean"},"name":{"example":"b","type":"string"},"path":{"example":"/","type":"string"},"priority":{"example":"Medium","type":"string"},"sameParty":{"type":"boolean"},"secure":{"type":"boolean"},"session":{"example":true,"type":"boolean"},"size":{"example":2,"type":"number"},"sourcePort":{"example":443,"type":"number"},"sourceScheme":{"example":"Secure","type":"string"},"value":{"example":"b","type":"string"}},"required":["name","value","domain","path","expires","size","httpOnly","secure","session","sameParty","sourceScheme","sourcePort"],"type":"object"},"type":"array"},"country":{"example":"United States","type":"string"},"countryLocationAlpha2":{"example":"US","type":"string"},"domain":{"example":"example.com","type":"string"},"headers":{"items":{"properties":{"name":{"example":"Content-Length","type":"string"},"value":{"example":"648","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"ip":{"example":"2606:2800:220:1:248:1893:25c8:1946","type":"string"},"js":{"properties":{"variables":{"items":{"properties":{"name":{"example":"checkFrame","type":"string"},"type":{"example":"string","type":"string"}},"required":["name","type"],"type":"object"},"type":"array"}},"required":["variables"],"type":"object"},"securityViolations":{"items":{"properties":{"category":{"example":"csp","type":"string"},"text":{"example":"[Report Only] Refused to load the stylesheet 'https://netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css' because it violates the following Content Security Policy directive: ... ","type":"string"},"url":{"example":"http://example.com/","type":"string"}},"required":["text","category","url"],"type":"object"},"type":"array"},"status":{"example":200,"type":"number"},"subdivision1Name":{"type":"string"},"subdivision2name":{"type":"string"},"url":{"example":"http://example.com/","type":"string"}},"required":["url","domain","country","countryLocationAlpha2","subdivision1Name","subdivision2name","ip","asn","asnname","asnLocationAlpha2","cookies","headers","status","js","console","securityViolations"],"type":"object"},"performance":{"items":{"properties":{"connectEnd":{"example":82.59999999403954,"type":"number"},"connectStart":{"example":72.79999999701977,"type":"number"},"decodedBodySize":{"example":1256,"type":"number"},"domComplete":{"example":306,"type":"number"},"domContentLoadedEventEnd":{"example":305.8999999910593,"type":"number"},"domContentLoadedEventStart":{"example":305.8999999910593,"type":"number"},"domInteractive":{"example":305.8999999910593,"type":"number"},"domainLookupEnd":{"example":72.79999999701977,"type":"number"},"domainLookupStart":{"example":2.199999988079071,"type":"number"},"duration":{"example":306,"type":"number"},"encodedBodySize":{"example":648,"type":"number"},"entryType":{"example":"navigation","type":"string"},"fetchStart":{"example":0.8999999910593033,"type":"number"},"initiatorType":{"example":"navigation","type":"string"},"loadEventEnd":{"example":306,"type":"number"},"loadEventStart":{"example":306,"type":"number"},"name":{"example":"http://example.com/","type":"string"},"nextHopProtocol":{"example":"http/1.1","type":"string"},"redirectCount":{"type":"number"},"redirectEnd":{"type":"number"},"redirectStart":{"type":"number"},"requestStart":{"example":82.69999998807907,"type":"number"},"responseEnd":{"example":270.8999999910593,"type":"number"},"responseStart":{"example":265.69999998807907,"type":"number"},"secureConnectionStart":{"type":"number"},"startTime":{"type":"number"},"transferSize":{"example":948,"type":"number"},"type":{"example":"navigate","type":"string"},"unloadEventEnd":{"type":"number"},"unloadEventStart":{"type":"number"},"workerStart":{"type":"number"}},"required":["name","entryType","startTime","duration","initiatorType","nextHopProtocol","workerStart","redirectStart","redirectEnd","fetchStart","domainLookupStart","domainLookupEnd","connectStart","connectEnd","secureConnectionStart","requestStart","responseStart","responseEnd","transferSize","encodedBodySize","decodedBodySize","unloadEventStart","unloadEventEnd","domInteractive","domContentLoadedEventStart","domContentLoadedEventEnd","domComplete","loadEventStart","loadEventEnd","type","redirectCount"],"type":"object"},"type":"array"},"task":{"properties":{"clientLocation":{"description":"Submitter location","example":"PT","type":"string"},"clientType":{"enum":["Site","Automatic","Api"],"type":"string"},"effectiveUrl":{"description":"URL of the primary request, after all HTTP redirects","example":"http://example.com/","type":"string"},"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"scannedFrom":{"properties":{"colo":{"description":"IATA code of Cloudflare datacenter","example":"MAD","type":"string"}},"required":["colo"],"type":"object"},"status":{"enum":["Queued","InProgress","InPostProcessing","Finished"],"type":"string"},"success":{"example":true,"type":"boolean"},"time":{"example":"2023-05-03T17:05:04.843Z","type":"string"},"timeEnd":{"example":"2023-05-03T17:05:19.374Z","type":"string"},"url":{"description":"Submitted URL","example":"http://example.com","type":"string"},"uuid":{"description":"Scan ID","example":"2ee568d0-bf70-4827-b922-b7088c0f056f","type":"string"},"visibility":{"enum":["Public","Unlisted"],"type":"string"}},"required":["uuid","url","status","success","errors","time","timeEnd","visibility","clientLocation","clientType","effectiveUrl","scannedFrom"],"type":"object"},"verdicts":{"properties":{"overall":{"properties":{"categories":{"items":{"properties":{"id":{"example":117,"type":"number"},"name":{"example":"Malware","type":"string"},"super_category_id":{"example":32,"type":"number"}},"required":["id","super_category_id","name"],"type":"object"},"type":"array"},"malicious":{"description":"At least one of our subsystems marked the site as potentially malicious at the time of the scan.","example":true,"type":"boolean"},"phishing":{"items":{"example":"Credential Harvester","type":"string"},"type":"array"}},"required":["malicious","categories","phishing"],"type":"object"}},"required":["overall"],"type":"object"}},"required":["task","meta","page","geo","certificates","performance","verdicts"],"type":"object"}},"required":["scan"],"type":"object"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success","result"],"type":"object"}}},"description":"Scan has finished. It may or may not have been successful."},"202":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"example":"In Progress","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"properties":{"scan":{"properties":{"task":{"properties":{"effectiveUrl":{"example":"http://example.com/","type":"string"},"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"location":{"example":"PT","type":"string"},"region":{"example":"enam","type":"string"},"status":{"example":"InProgress","type":"string"},"success":{"example":true,"type":"boolean"},"time":{"example":"2023-05-03T17:05:04.843Z","type":"string"},"url":{"example":"http://example.com","type":"string"},"uuid":{"example":"2ee568d0-bf70-4827-b922-b7088c0f056f","type":"string"},"visibility":{"example":"Public","type":"string"}},"required":["uuid","url","status","success","errors","time","visibility","location","region","effectiveUrl"],"type":"object"}},"required":["task"],"type":"object"}},"required":["scan"],"type":"object"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success","result"],"type":"object"}}},"description":"Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Scan ID is not a valid UUID.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success"],"type":"object"}}},"description":"Invalid params."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Scan not found.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success"],"type":"object"}}},"description":"Scan not found."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get URL scan","tags":["URL Scanner (Deprecated)"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [V2](https://developers.cloudflare.com/api/resources/url_scanner/subresources/scans/methods/get/) instead."}},"/accounts/{account_id}/urlscanner/scan/{scan_id}/har":{"get":{"deprecated":true,"description":"Get a URL scan's HAR file. See HAR spec at http://www.softwareishard.com/blog/har-12-spec/.","operationId":"urlscanner-get-scan-har","parameters":[{"description":"Scan UUID.","in":"path","name":"scan_id","required":true,"schema":{"description":"Scan UUID.","format":"uuid","type":"string"}},{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Error","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"example":"OK","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"properties":{"har":{"properties":{"log":{"properties":{"creator":{"properties":{"comment":{"example":"https://github.com/sitespeedio/chrome-har","type":"string"},"name":{"example":"chrome-har","type":"string"},"version":{"example":"0.13.1","type":"string"}},"required":["name","version","comment"],"type":"object"},"entries":{"items":{"properties":{"_initialPriority":{"example":"VeryHigh","type":"string"},"_initiator_type":{"example":"other","type":"string"},"_priority":{"example":"VeryHigh","type":"string"},"_requestId":{"example":"DDC779F0CB3746BAF283EC1A51B0F2F8","type":"string"},"_requestTime":{"example":114135.331081,"type":"number"},"_resourceType":{"example":"document","type":"string"},"cache":{"type":"object"},"connection":{"example":"33","type":"string"},"pageref":{"example":"page_1","type":"string"},"request":{"properties":{"bodySize":{"type":"number"},"headers":{"items":{"properties":{"name":{"example":"Upgrade-Insecure-Requests","type":"string"},"value":{"example":"1","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"headersSize":{"example":197,"type":"number"},"httpVersion":{"example":"http/1.1","type":"string"},"method":{"example":"GET","type":"string"},"url":{"example":"http://example.com/","type":"string"}},"required":["method","url","headersSize","bodySize","headers","httpVersion"],"type":"object"},"response":{"properties":{"_transferSize":{"example":1071,"type":"number"},"bodySize":{"example":648,"type":"number"},"content":{"properties":{"compression":{"example":608,"type":"integer"},"mimeType":{"example":"text/html","type":"string"},"size":{"example":1256,"type":"number"}},"required":["mimeType","size"],"type":"object"},"headers":{"items":{"properties":{"name":{"example":"Content-Encoding","type":"string"},"value":{"example":"gzip","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"headersSize":{"example":423,"type":"number"},"httpVersion":{"example":"http/1.1","type":"string"},"redirectURL":{"type":"string"},"status":{"example":200,"type":"number"},"statusText":{"example":"OK","type":"string"}},"required":["httpVersion","redirectURL","status","statusText","content","headersSize","bodySize","headers","_transferSize"],"type":"object"},"serverIPAddress":{"example":"2606:2800:220:1:248:1893:25c8:1946","type":"string"},"startedDateTime":{"example":"2023-05-03T17:05:13.196Z","type":"string"},"time":{"example":268.64,"type":"number"}},"required":["cache","startedDateTime","_requestId","_initialPriority","_priority","pageref","request","time","_initiator_type","_resourceType","response","connection","serverIPAddress","_requestTime"],"type":"object"},"type":"array"},"pages":{"items":{"properties":{"id":{"example":"page_1","type":"string"},"pageTimings":{"properties":{"onContentLoad":{"example":305.408,"type":"number"},"onLoad":{"example":305.169,"type":"number"}},"required":["onLoad","onContentLoad"],"type":"object"},"startedDateTime":{"example":"2023-05-03T17:05:13.195Z","type":"string"},"title":{"example":"http://example.com/","type":"string"}},"required":["id","startedDateTime","title","pageTimings"],"type":"object"},"type":"array"},"version":{"example":"1.2","type":"string"}},"required":["version","creator","pages","entries"],"type":"object"}},"required":["log"],"type":"object"}},"required":["har"],"type":"object"},"success":{"description":"Whether search request was successful or not","type":"boolean"}},"required":["messages","errors","success","result"],"type":"object"}}},"description":"Returns the scan's har."},"202":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"example":"In Progress","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"properties":{"scan":{"properties":{"task":{"properties":{"effectiveUrl":{"example":"http://example.com/","type":"string"},"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"location":{"example":"PT","type":"string"},"region":{"example":"enam","type":"string"},"status":{"example":"InProgress","type":"string"},"success":{"example":true,"type":"boolean"},"time":{"example":"2023-05-03T17:05:04.843Z","type":"string"},"url":{"example":"http://example.com","type":"string"},"uuid":{"example":"2ee568d0-bf70-4827-b922-b7088c0f056f","type":"string"},"visibility":{"example":"Public","type":"string"}},"required":["uuid","url","status","success","errors","time","visibility","location","region","effectiveUrl"],"type":"object"}},"required":["task"],"type":"object"}},"required":["scan"],"type":"object"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success","result"],"type":"object"}}},"description":"Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Scan ID is not a valid UUID.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success"],"type":"object"}}},"description":"Invalid params."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Scan not found.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success"],"type":"object"}}},"description":"Scan not found."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get URL scan's HAR","tags":["URL Scanner (Deprecated)"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [V2](https://developers.cloudflare.com/api/resources/url_scanner/subresources/scans/methods/har/) instead."}},"/accounts/{account_id}/urlscanner/scan/{scan_id}/screenshot":{"get":{"deprecated":true,"description":"Get scan's screenshot by resolution (desktop/mobile/tablet).","operationId":"urlscanner-get-scan-screenshot","parameters":[{"description":"Scan UUID.","in":"path","name":"scan_id","required":true,"schema":{"description":"Scan UUID.","format":"uuid","type":"string"}},{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Target device type.","in":"query","name":"resolution","schema":{"default":"desktop","description":"Target device type.","enum":["desktop","mobile","tablet"],"type":"string"}}],"responses":{"200":{"content":{"image/png":{"schema":{"description":"PNG Image.","type":"string"}}},"description":"Returns the scan's requested screenshot."},"202":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"example":"In Progress","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"properties":{"scan":{"properties":{"task":{"properties":{"effectiveUrl":{"example":"http://example.com/","type":"string"},"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"location":{"example":"PT","type":"string"},"region":{"example":"enam","type":"string"},"status":{"example":"InProgress","type":"string"},"success":{"example":true,"type":"boolean"},"time":{"example":"2023-05-03T17:05:04.843Z","type":"string"},"url":{"example":"http://example.com","type":"string"},"uuid":{"example":"2ee568d0-bf70-4827-b922-b7088c0f056f","type":"string"},"visibility":{"example":"Public","type":"string"}},"required":["uuid","url","status","success","errors","time","visibility","location","region","effectiveUrl"],"type":"object"}},"required":["task"],"type":"object"}},"required":["scan"],"type":"object"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success","result"],"type":"object"}}},"description":"Scan is in progress. Check current status in `result.scan.task.status`. Possible statuses: `Queued`,`InProgress`,`InPostProcessing`,`Finished`."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Scan ID is not a valid UUID.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success"],"type":"object"}}},"description":"Invalid params."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"example":"Scan not found.","type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"description":"Whether request was successful or not","type":"boolean"}},"required":["messages","errors","success"],"type":"object"}}},"description":"Scan not found."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get screenshot","tags":["URL Scanner (Deprecated)"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [V2](https://developers.cloudflare.com/api/resources/url_scanner/subresources/scans/methods/screenshot/) instead."}},"/accounts/{account_id}/urlscanner/v2/bulk":{"post":{"description":"Submit URLs to scan. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/ and take into account scans submitted in bulk have lower priority and may take longer to finish.","operationId":"urlscanner-create-scan-bulk-v2","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"List of urls to scan (up to a 100).","items":{"properties":{"customHeaders":{"additionalProperties":{"type":"string"},"description":"Set custom headers.","type":"object"},"customagent":{"maxLength":4096,"type":"string"},"referer":{"maxLength":4096,"type":"string"},"screenshotsResolutions":{"default":["desktop"],"description":"Take multiple screenshots targeting different device types.","items":{"default":"desktop","description":"Device resolutions.","enum":["desktop","mobile","tablet"],"type":"string"},"type":"array"},"url":{"example":"https://www.example.com","type":"string"},"visibility":{"default":"Public","description":"The option `Public` means it will be included in listings like recent scans and search results. `Unlisted` means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material.","enum":["Public","Unlisted"],"type":"string"}},"required":["url"],"type":"object"},"type":"array"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"api":{"description":"URL to api report.","type":"string"},"options":{"properties":{"useragent":{"type":"string"}},"type":"object"},"result":{"description":"URL to report.","type":"string"},"url":{"description":"Submitted URL","type":"string"},"uuid":{"description":"Scan ID.","format":"uuid","type":"string"},"visibility":{"description":"Submitted visibility status.","enum":["public","unlisted"],"example":"public","type":"string"}},"required":["uuid","result","api","visibility","url"],"type":"object"},"type":"array"}}},"description":"Scan bulk request accepted successfully."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"},"title":{"example":"Invalid url","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"}},"required":["message","status","errors"],"type":"object"}}},"description":"Invalid input."},"429":{"content":{"application/json":{"schema":{"properties":{"description":{"type":"string"},"errors":{"items":{"properties":{"detail":{"example":"DNS Error - Could not resolve domain.","type":"string"},"status":{"example":400,"type":"number"},"title":{"example":"DNS Error - Could not resolve domain.","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"type":"string"},"status":{"example":429,"type":"number"}},"required":["message","status","errors"],"type":"object"}}},"description":"Scan request denied: rate limited."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Bulk create URL Scans","tags":["URL Scanner"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/urlscanner/v2/dom/{scan_id}":{"get":{"description":"Returns a plain text response, with the scan's DOM content as rendered by Chrome.","operationId":"urlscanner-get-scan-dom-v2","parameters":[{"description":"Scan UUID.","in":"path","name":"scan_id","required":true,"schema":{"description":"Scan UUID.","format":"uuid","type":"string"}},{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"responses":{"200":{"content":{"text/plain":{"schema":{"description":"HTML of webpage.","type":"string"}}},"description":"Returns a plain text response, with the scan's DOM content as rendered by Chrome."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"},"title":{"example":"Invalid url","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"}},"required":["message","status","errors"],"type":"object"}}},"description":"Invalid input."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"example":"Queued","type":"string"},"status":{"description":"Status code.","example":404,"type":"integer"},"title":{"example":"Scan is not finished yet.","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"description":"Scan not found or in progress.","example":"Scan is not finished yet.","type":"string"},"status":{"description":"Status code.","example":404,"type":"integer"},"task":{"properties":{"status":{"example":"Queued","type":"string"},"time":{"type":"string"},"url":{"type":"string"},"uuid":{"type":"string"},"visibility":{"example":"public","type":"string"}},"required":["uuid","url","time","status","visibility"],"type":"object"}},"required":["message","status","errors","task"],"type":"object"}}},"description":"Scan not found or in progress."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get URL scan's DOM","tags":["URL Scanner"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/urlscanner/v2/har/{scan_id}":{"get":{"description":"Get a URL scan's HAR file. See HAR spec at http://www.softwareishard.com/blog/har-12-spec/.","operationId":"urlscanner-get-scan-har-v2","parameters":[{"description":"Scan UUID.","in":"path","name":"scan_id","required":true,"schema":{"description":"Scan UUID.","format":"uuid","type":"string"}},{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"log":{"properties":{"creator":{"properties":{"comment":{"example":"https://github.com/sitespeedio/chrome-har","type":"string"},"name":{"example":"chrome-har","type":"string"},"version":{"example":"0.13.1","type":"string"}},"required":["name","version","comment"],"type":"object"},"entries":{"items":{"properties":{"_initialPriority":{"example":"VeryHigh","type":"string"},"_initiator_type":{"example":"other","type":"string"},"_priority":{"example":"VeryHigh","type":"string"},"_requestId":{"example":"DDC779F0CB3746BAF283EC1A51B0F2F8","type":"string"},"_requestTime":{"example":114135.331081,"type":"number"},"_resourceType":{"example":"document","type":"string"},"cache":{"type":"object"},"connection":{"example":"33","type":"string"},"pageref":{"example":"page_1","type":"string"},"request":{"properties":{"bodySize":{"type":"number"},"headers":{"items":{"properties":{"name":{"example":"Upgrade-Insecure-Requests","type":"string"},"value":{"example":"1","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"headersSize":{"example":197,"type":"number"},"httpVersion":{"example":"http/1.1","type":"string"},"method":{"example":"GET","type":"string"},"url":{"example":"http://example.com/","type":"string"}},"required":["method","url","headersSize","bodySize","headers","httpVersion"],"type":"object"},"response":{"properties":{"_transferSize":{"example":1071,"type":"number"},"bodySize":{"example":648,"type":"number"},"content":{"properties":{"compression":{"example":608,"type":"integer"},"mimeType":{"example":"text/html","type":"string"},"size":{"example":1256,"type":"number"}},"required":["mimeType","size"],"type":"object"},"headers":{"items":{"properties":{"name":{"example":"Content-Encoding","type":"string"},"value":{"example":"gzip","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"headersSize":{"example":423,"type":"number"},"httpVersion":{"example":"http/1.1","type":"string"},"redirectURL":{"type":"string"},"status":{"example":200,"type":"number"},"statusText":{"example":"OK","type":"string"}},"required":["httpVersion","redirectURL","status","statusText","content","headersSize","bodySize","headers","_transferSize"],"type":"object"},"serverIPAddress":{"example":"2606:2800:220:1:248:1893:25c8:1946","type":"string"},"startedDateTime":{"example":"2023-05-03T17:05:13.196Z","type":"string"},"time":{"example":268.64,"type":"number"}},"required":["cache","startedDateTime","_requestId","_initialPriority","_priority","pageref","request","time","_initiator_type","_resourceType","response","connection","serverIPAddress","_requestTime"],"type":"object"},"type":"array"},"pages":{"items":{"properties":{"id":{"example":"page_1","type":"string"},"pageTimings":{"properties":{"onContentLoad":{"example":305.408,"type":"number"},"onLoad":{"example":305.169,"type":"number"}},"required":["onLoad","onContentLoad"],"type":"object"},"startedDateTime":{"example":"2023-05-03T17:05:13.195Z","type":"string"},"title":{"example":"http://example.com/","type":"string"}},"required":["id","startedDateTime","title","pageTimings"],"type":"object"},"type":"array"},"version":{"example":"1.2","type":"string"}},"required":["version","creator","pages","entries"],"type":"object"}},"required":["log"],"type":"object"}}},"description":"Returns the scan's har."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"},"title":{"example":"Invalid url","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"}},"required":["message","status","errors"],"type":"object"}}},"description":"Invalid input."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"example":"Queued","type":"string"},"status":{"description":"Status code.","example":404,"type":"integer"},"title":{"example":"Scan is not finished yet.","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"description":"Scan not found or in progress.","example":"Scan is not finished yet.","type":"string"},"status":{"description":"Status code.","example":404,"type":"integer"},"task":{"properties":{"status":{"example":"Queued","type":"string"},"time":{"type":"string"},"url":{"type":"string"},"uuid":{"type":"string"},"visibility":{"example":"public","type":"string"}},"required":["uuid","url","time","status","visibility"],"type":"object"}},"required":["message","status","errors","task"],"type":"object"}}},"description":"Scan not found or in progress."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get URL scan's HAR","tags":["URL Scanner"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/urlscanner/v2/responses/{response_id}":{"get":{"description":"Returns the raw response of the network request. Find the `response_id` in the `data.requests.response.hash`.","operationId":"urlscanner-get-response-v2","parameters":[{"description":"Response hash.","in":"path","name":"response_id","required":true,"schema":{"description":"Response hash.","type":"string"}},{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"responses":{"200":{"content":{"text/plain":{"schema":{"description":"Web resource or image.","type":"string"}}},"description":"Get the raw response by its hash."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"},"title":{"example":"Invalid url","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"}},"required":["message","status","errors"],"type":"object"}}},"description":"Invalid input."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get raw response","tags":["URL Scanner"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/urlscanner/v2/result/{scan_id}":{"get":{"description":"Get URL scan by uuid","operationId":"urlscanner-get-scan-v2","parameters":[{"description":"Scan UUID.","in":"path","name":"scan_id","required":true,"schema":{"description":"Scan UUID.","format":"uuid","type":"string"}},{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"console":{"items":{"properties":{"message":{"properties":{"level":{"type":"string"},"source":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"required":["source","level","text","url"],"type":"object"}},"required":["message"],"type":"object"},"type":"array"},"cookies":{"items":{"properties":{"domain":{"type":"string"},"expires":{"type":"number"},"httpOnly":{"type":"boolean"},"name":{"type":"string"},"path":{"type":"string"},"priority":{"type":"string"},"sameParty":{"type":"boolean"},"secure":{"type":"boolean"},"session":{"type":"boolean"},"size":{"type":"number"},"sourcePort":{"type":"number"},"sourceScheme":{"type":"string"},"value":{"type":"string"}},"required":["name","value","domain","path","expires","size","httpOnly","secure","session","priority","sameParty","sourceScheme","sourcePort"],"type":"object"},"type":"array"},"globals":{"items":{"properties":{"prop":{"type":"string"},"type":{"type":"string"}},"required":["prop","type"],"type":"object"},"type":"array"},"links":{"items":{"properties":{"href":{"type":"string"},"text":{"type":"string"}},"required":["href","text"],"type":"object"},"type":"array"},"performance":{"items":{"properties":{"duration":{"type":"number"},"entryType":{"type":"string"},"name":{"type":"string"},"startTime":{"type":"number"}},"required":["name","entryType","startTime","duration"],"type":"object"},"type":"array"},"requests":{"items":{"properties":{"request":{"properties":{"documentURL":{"type":"string"},"frameId":{"type":"string"},"hasUserGesture":{"type":"boolean"},"initiator":{"properties":{"host":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"required":["type","url","host"],"type":"object"},"loaderId":{"type":"string"},"primaryRequest":{"type":"boolean"},"redirectHasExtraInfo":{"type":"boolean"},"redirectResponse":{"properties":{"charset":{"type":"string"},"headers":{"type":"object"},"mimeType":{"type":"string"},"protocol":{"type":"string"},"remoteIPAddress":{"type":"string"},"remotePort":{"type":"number"},"securityHeaders":{"items":{"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"securityState":{"type":"string"},"status":{"type":"number"},"statusText":{"type":"string"},"url":{"type":"string"}},"required":["url","status","statusText","mimeType","charset","remoteIPAddress","remotePort","protocol","securityState","securityHeaders"],"type":"object"},"request":{"properties":{"headers":{"type":"object"},"initialPriority":{"type":"string"},"isSameSite":{"type":"boolean"},"method":{"type":"string"},"mixedContentType":{"type":"string"},"referrerPolicy":{"type":"string"},"url":{"type":"string"}},"required":["url","method","mixedContentType","initialPriority","referrerPolicy","isSameSite"],"type":"object"},"requestId":{"type":"string"},"type":{"type":"string"},"wallTime":{"type":"number"}},"required":["requestId","documentURL","request","wallTime","initiator","redirectHasExtraInfo","type","hasUserGesture"],"type":"object"},"requests":{"items":{"properties":{"documentURL":{"type":"string"},"frameId":{"type":"string"},"hasUserGesture":{"type":"boolean"},"initiator":{"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"loaderId":{"type":"string"},"redirectHasExtraInfo":{"type":"boolean"},"request":{"properties":{"headers":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"initialPriority":{"type":"string"},"isSameSite":{"type":"boolean"},"method":{"type":"string"},"mixedContentType":{"type":"string"},"referrerPolicy":{"type":"string"},"url":{"type":"string"}},"required":["url","method","headers","mixedContentType","initialPriority","referrerPolicy","isSameSite"],"type":"object"},"requestId":{"type":"string"},"type":{"type":"string"},"wallTime":{"type":"number"}},"required":["requestId","loaderId","frameId","documentURL","wallTime","request","type","initiator","hasUserGesture","redirectHasExtraInfo"],"type":"object"},"type":"array"},"response":{"properties":{"asn":{"properties":{"asn":{"type":"string"},"country":{"type":"string"},"description":{"type":"string"},"ip":{"type":"string"},"name":{"type":"string"},"org":{"type":"string"}},"required":["ip","asn","country","description","name","org"],"type":"object"},"contentAvailable":{"type":"boolean"},"dataLength":{"type":"number"},"encodedDataLength":{"type":"number"},"geoip":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"country_name":{"type":"string"},"geonameId":{"type":"string"},"ll":{"items":{"type":"number"},"type":"array"},"region":{"type":"string"}},"required":["country","region","city","ll","country_name","geonameId"],"type":"object"},"hasExtraInfo":{"type":"boolean"},"hash":{"type":"string"},"requestId":{"type":"string"},"response":{"properties":{"charset":{"type":"string"},"headers":{"type":"object"},"mimeType":{"type":"string"},"protocol":{"type":"string"},"remoteIPAddress":{"type":"string"},"remotePort":{"type":"number"},"securityDetails":{"properties":{"certificateId":{"type":"number"},"certificateTransparencyCompliance":{"type":"string"},"cipher":{"type":"string"},"encryptedClientHello":{"type":"boolean"},"issuer":{"type":"string"},"keyExchange":{"type":"string"},"keyExchangeGroup":{"type":"string"},"protocol":{"type":"string"},"sanList":{"items":{"type":"string"},"type":"array"},"serverSignatureAlgorithm":{"type":"number"},"subjectName":{"type":"string"},"validFrom":{"type":"number"},"validTo":{"type":"number"}},"required":["protocol","keyExchange","keyExchangeGroup","cipher","certificateId","subjectName","sanList","issuer","validFrom","validTo","certificateTransparencyCompliance","serverSignatureAlgorithm","encryptedClientHello"],"type":"object"},"securityHeaders":{"items":{"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"type":"array"},"securityState":{"type":"string"},"status":{"type":"number"},"statusText":{"type":"string"},"url":{"type":"string"}},"required":["url","status","statusText","mimeType","charset","remoteIPAddress","remotePort","protocol","securityState","securityDetails","securityHeaders"],"type":"object"},"size":{"type":"number"},"type":{"type":"string"}},"required":["encodedDataLength","dataLength","requestId","type","response","hasExtraInfo","size","asn","geoip"],"type":"object"}},"required":["request","response"],"type":"object"},"type":"array"}},"required":["requests","cookies","console","links","globals","performance"],"type":"object"},"lists":{"properties":{"asns":{"items":{"type":"string"},"type":"array"},"certificates":{"items":{"properties":{"issuer":{"type":"string"},"subjectName":{"type":"string"},"validFrom":{"type":"number"},"validTo":{"type":"number"}},"required":["issuer","subjectName","validFrom","validTo"],"type":"object"},"type":"array"},"continents":{"items":{"type":"string"},"type":"array"},"countries":{"items":{"type":"string"},"type":"array"},"domains":{"items":{"type":"string"},"type":"array"},"hashes":{"items":{"type":"string"},"type":"array"},"ips":{"items":{"type":"string"},"type":"array"},"linkDomains":{"items":{"type":"string"},"type":"array"},"servers":{"items":{"type":"string"},"type":"array"},"urls":{"items":{"type":"string"},"type":"array"}},"required":["ips","countries","continents","asns","domains","servers","urls","linkDomains","certificates","hashes"],"type":"object"},"meta":{"properties":{"processors":{"properties":{"asn":{"properties":{"data":{"items":{"properties":{"asn":{"type":"string"},"country":{"type":"string"},"description":{"type":"string"},"ip":{"type":"string"},"name":{"type":"string"}},"required":["ip","asn","country","description","name"],"type":"object"},"type":"array"}},"required":["data"],"type":"object"},"dns":{"properties":{"data":{"items":{"properties":{"address":{"type":"string"},"dnssec_valid":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"}},"required":["name","address","type","dnssec_valid"],"type":"object"},"type":"array"}},"required":["data"],"type":"object"},"domainCategories":{"properties":{"data":{"items":{"properties":{"inherited":{"type":"object"},"isPrimary":{"type":"boolean"},"name":{"type":"string"}},"required":["name","isPrimary","inherited"],"type":"object"},"type":"array"}},"required":["data"],"type":"object"},"geoip":{"properties":{"data":{"items":{"properties":{"geoip":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"country_name":{"type":"string"},"ll":{"items":{"type":"number"},"type":"array"},"region":{"type":"string"}},"required":["country","region","city","ll","country_name"],"type":"object"},"ip":{"type":"string"}},"required":["ip","geoip"],"type":"object"},"type":"array"}},"required":["data"],"type":"object"},"phishing":{"properties":{"data":{"items":{"type":"string"},"type":"array"}},"required":["data"],"type":"object"},"radarRank":{"properties":{"data":{"items":{"properties":{"bucket":{"type":"string"},"hostname":{"type":"string"},"rank":{"type":"number"}},"required":["hostname","bucket"],"type":"object"},"type":"array"}},"required":["data"],"type":"object"},"urlCategories":{"properties":{"data":{"items":{"properties":{"content":{"items":{"properties":{"id":{"type":"number"},"name":{"type":"string"},"super_category_id":{"type":"number"}},"required":["id","name","super_category_id"],"type":"object"},"type":"array"},"inherited":{"properties":{"content":{"items":{"properties":{"id":{"type":"number"},"name":{"type":"string"},"super_category_id":{"type":"number"}},"required":["id","name","super_category_id"],"type":"object"},"type":"array"},"from":{"type":"string"},"risks":{"items":{"properties":{"id":{"type":"number"},"name":{"type":"string"},"super_category_id":{"type":"number"}},"required":["id","name","super_category_id"],"type":"object"},"type":"array"}},"required":["from","content","risks"],"type":"object"},"name":{"type":"string"},"risks":{"items":{"properties":{"id":{"type":"number"},"name":{"type":"string"},"super_category_id":{"type":"number"}},"required":["id","name","super_category_id"],"type":"object"},"type":"array"}},"required":["name","content","risks","inherited"],"type":"object"},"type":"array"}},"required":["data"],"type":"object"},"wappa":{"properties":{"data":{"items":{"properties":{"app":{"type":"string"},"categories":{"items":{"properties":{"name":{"type":"string"},"priority":{"type":"number"}},"required":["name","priority"],"type":"object"},"type":"array"},"confidence":{"items":{"properties":{"confidence":{"type":"number"},"name":{"type":"string"},"pattern":{"type":"string"},"patternType":{"type":"string"}},"required":["confidence","pattern","patternType","name"],"type":"object"},"type":"array"},"confidenceTotal":{"type":"number"},"icon":{"type":"string"},"website":{"type":"string"}},"required":["confidence","confidenceTotal","app","icon","website","categories"],"type":"object"},"type":"array"}},"required":["data"],"type":"object"}},"required":["geoip","asn","wappa","domainCategories","dns","radarRank","phishing"],"type":"object"}},"required":["processors"],"type":"object"},"page":{"properties":{"apexDomain":{"type":"string"},"asn":{"type":"string"},"asnname":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"domain":{"type":"string"},"ip":{"type":"string"},"mimeType":{"type":"string"},"screenshot":{"properties":{"dhash":{"type":"string"},"mm3Hash":{"type":"number"},"name":{"type":"string"},"phash":{"type":"string"}},"required":["phash","dhash","mm3Hash","name"],"type":"object"},"server":{"type":"string"},"status":{"example":"200","type":"string"},"title":{"type":"string"},"tlsAgeDays":{"type":"number"},"tlsIssuer":{"type":"string"},"tlsValidDays":{"type":"number"},"tlsValidFrom":{"type":"string"},"url":{"type":"string"}},"required":["asn","asnname","city","country","domain","ip","server","url","mimeType","apexDomain","status","title","tlsIssuer","tlsValidFrom","tlsAgeDays","tlsValidDays"],"type":"object"},"scanner":{"properties":{"colo":{"type":"string"},"country":{"type":"string"}},"required":["country","colo"],"type":"object"},"stats":{"properties":{"IPv6Percentage":{"type":"number"},"domainStats":{"items":{"properties":{"count":{"type":"number"},"countries":{"items":{"type":"string"},"type":"array"},"domain":{"type":"string"},"encodedSize":{"type":"number"},"index":{"type":"number"},"initiators":{"items":{"type":"string"},"type":"array"},"ips":{"items":{"type":"string"},"type":"array"},"redirects":{"type":"number"},"size":{"type":"number"}},"required":["count","ips","domain","size","encodedSize","countries","index","initiators","redirects"],"type":"object"},"type":"array"},"ipStats":{"items":{"properties":{"asn":{"properties":{"asn":{"type":"string"},"country":{"type":"string"},"description":{"type":"string"},"ip":{"type":"string"},"name":{"type":"string"},"org":{"type":"string"}},"required":["ip","asn","country","description","name","org"],"type":"object"},"count":{"type":"number"},"countries":{"items":{"type":"string"},"type":"array"},"domains":{"items":{"type":"string"},"type":"array"},"encodedSize":{"type":"number"},"geoip":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"country_name":{"type":"string"},"ll":{"items":{"type":"number"},"type":"array"},"region":{"type":"string"}},"required":["country","region","city","ll","country_name"],"type":"object"},"index":{"type":"number"},"ip":{"type":"string"},"ipv6":{"type":"boolean"},"redirects":{"type":"number"},"requests":{"type":"number"},"size":{"type":"number"}},"required":["requests","domains","ip","size","encodedSize","countries","index","ipv6","redirects","geoip","asn"],"type":"object"},"type":"array"},"malicious":{"type":"number"},"protocolStats":{"items":{"properties":{"count":{"type":"number"},"countries":{"items":{"type":"string"},"type":"array"},"encodedSize":{"type":"number"},"ips":{"items":{"type":"string"},"type":"array"},"protocol":{"type":"string"},"size":{"type":"number"}},"required":["count","size","encodedSize","ips","countries","protocol"],"type":"object"},"type":"array"},"resourceStats":{"items":{"properties":{"compression":{"type":"number"},"count":{"type":"number"},"countries":{"items":{"type":"string"},"type":"array"},"encodedSize":{"type":"number"},"ips":{"items":{"type":"string"},"type":"array"},"percentage":{"type":"number"},"size":{"type":"number"},"type":{"type":"string"}},"required":["count","size","encodedSize","ips","countries","compression","percentage","type"],"type":"object"},"type":"array"},"securePercentage":{"type":"number"},"secureRequests":{"type":"number"},"serverStats":{"items":{"properties":{"count":{"type":"number"},"countries":{"items":{"type":"string"},"type":"array"},"encodedSize":{"type":"number"},"ips":{"items":{"type":"string"},"type":"array"},"server":{"type":"string"},"size":{"type":"number"}},"required":["count","size","encodedSize","ips","countries","server"],"type":"object"},"type":"array"},"tlsStats":{"items":{"properties":{"count":{"type":"number"},"countries":{"items":{"type":"string"},"type":"array"},"encodedSize":{"type":"number"},"ips":{"items":{"type":"string"},"type":"array"},"protocols":{"properties":{"TLS 1.3 / AES_128_GCM":{"type":"number"}},"required":["TLS 1.3 / AES_128_GCM"],"type":"object"},"securityState":{"type":"string"},"size":{"type":"number"}},"required":["count","size","encodedSize","ips","countries","protocols","securityState"],"type":"object"},"type":"array"},"totalLinks":{"type":"number"},"uniqASNs":{"type":"number"},"uniqCountries":{"type":"number"}},"required":["IPv6Percentage","domainStats","ipStats","malicious","protocolStats","resourceStats","secureRequests","tlsStats","serverStats","securePercentage","totalLinks","uniqCountries","uniqASNs"],"type":"object"},"task":{"properties":{"apexDomain":{"type":"string"},"domURL":{"type":"string"},"domain":{"type":"string"},"method":{"type":"string"},"options":{"properties":{"customHeaders":{"description":"Custom headers set.","type":"object"},"screenshotsResolutions":{"items":{"type":"string"},"type":"array"}},"type":"object"},"reportURL":{"type":"string"},"screenshotURL":{"type":"string"},"source":{"type":"string"},"success":{"type":"boolean"},"time":{"type":"string"},"url":{"type":"string"},"uuid":{"type":"string"},"visibility":{"type":"string"}},"required":["uuid","url","time","visibility","source","method","domain","apexDomain","reportURL","screenshotURL","domURL","options","success"],"type":"object"},"verdicts":{"properties":{"overall":{"properties":{"categories":{"items":{"type":"string"},"type":"array"},"hasVerdicts":{"type":"boolean"},"malicious":{"type":"boolean"},"tags":{"items":{"type":"string"},"type":"array"}},"required":["malicious","hasVerdicts","categories","tags"],"type":"object"}},"required":["overall"],"type":"object"}},"required":["data","page","lists","meta","scanner","stats","task","verdicts"],"type":"object"}}},"description":"Scan has finished. It may or may not have been successful."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"},"title":{"example":"Invalid url","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"}},"required":["message","status","errors"],"type":"object"}}},"description":"Invalid input."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"example":"Queued","type":"string"},"status":{"description":"Status code.","example":404,"type":"integer"},"title":{"example":"Scan is not finished yet.","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"description":"Scan not found or in progress.","example":"Scan is not finished yet.","type":"string"},"status":{"description":"Status code.","example":404,"type":"integer"},"task":{"properties":{"status":{"example":"Queued","type":"string"},"time":{"type":"string"},"url":{"type":"string"},"uuid":{"type":"string"},"visibility":{"example":"public","type":"string"}},"required":["uuid","url","time","status","visibility"],"type":"object"}},"required":["message","status","errors","task"],"type":"object"}}},"description":"Scan not found or in progress."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get URL scan","tags":["URL Scanner"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/urlscanner/v2/scan":{"post":{"description":"Submit a URL to scan. Check limits at https://developers.cloudflare.com/security-center/investigate/scan-limits/.","operationId":"urlscanner-create-scan-v2","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"country":{"description":"Country to geo egress from","enum":["AF","AL","DZ","AD","AO","AG","AR","AM","AU","AT","AZ","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BR","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CO","KM","CG","CR","CI","HR","CU","CY","CZ","CD","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FJ","FI","FR","GA","GE","DE","GH","GR","GL","GD","GT","GN","GW","GY","HT","HN","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MR","MU","MX","FM","MD","MC","MN","MS","MA","MZ","MM","NA","NR","NP","NL","NZ","NI","NE","NG","KP","MK","NO","OM","PK","PS","PA","PG","PY","PE","PH","PL","PT","QA","RO","RU","RW","SH","KN","LC","VC","WS","SM","ST","SA","SN","RS","SC","SL","SK","SI","SB","SO","ZA","KR","SS","ES","LK","SD","SR","SE","CH","SY","TW","TJ","TZ","TH","BS","GM","TL","TG","TO","TT","TN","TR","TM","UG","UA","AE","GB","US","UY","UZ","VU","VE","VN","YE","ZM","ZW"],"type":"string"},"customHeaders":{"additionalProperties":{"type":"string"},"description":"Set custom headers.","type":"object"},"customagent":{"maxLength":4096,"type":"string"},"referer":{"maxLength":4096,"type":"string"},"screenshotsResolutions":{"default":["desktop"],"description":"Take multiple screenshots targeting different device types.","items":{"default":"desktop","description":"Device resolutions.","enum":["desktop","mobile","tablet"],"type":"string"},"type":"array"},"url":{"example":"https://www.example.com","type":"string"},"visibility":{"default":"Public","description":"The option `Public` means it will be included in listings like recent scans and search results. `Unlisted` means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material.","enum":["Public","Unlisted"],"type":"string"}},"required":["url"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"api":{"description":"URL to api report.","type":"string"},"message":{"example":"Submission successful","type":"string"},"options":{"properties":{"useragent":{"type":"string"}},"type":"object"},"result":{"description":"Public URL to report.","type":"string"},"url":{"description":"Canonical form of submitted URL. Use this if you want to later search by URL.","type":"string","x-auditable":true},"uuid":{"description":"Scan ID.","format":"uuid","type":"string","x-auditable":true},"visibility":{"description":"Submitted visibility status.","enum":["public","unlisted"],"example":"public","type":"string"}},"required":["message","uuid","result","api","visibility","url"],"type":"object"}}},"description":"Scan request accepted successfully."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"},"title":{"example":"Invalid url","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"}},"required":["message","status","errors"],"type":"object"}}},"description":"Invalid input."},"409":{"content":{"application/json":{"schema":{"properties":{"description":{"example":"Scan request denied: hostname was recently scanned","type":"string"},"errors":{"items":{"properties":{"detail":{"example":"DNS Error - Could not resolve domain.","type":"string"},"status":{"example":400,"type":"number"},"title":{"example":"DNS Error - Could not resolve domain.","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"example":"Scan prevented ...","type":"string"},"status":{"example":409,"type":"number"}},"required":["message","status","errors"],"type":"object"}}},"description":"Scan request denied: hostname was recently scanned."},"429":{"content":{"application/json":{"schema":{"properties":{"description":{"type":"string"},"errors":{"items":{"properties":{"detail":{"example":"DNS Error - Could not resolve domain.","type":"string"},"status":{"example":400,"type":"number"},"title":{"example":"DNS Error - Could not resolve domain.","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"type":"string"},"status":{"example":429,"type":"number"}},"required":["message","status","errors"],"type":"object"}}},"description":"Scan request denied: rate limited."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create URL Scan","tags":["URL Scanner"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/urlscanner/v2/screenshots/{scan_id}.png":{"get":{"description":"Get scan's screenshot by resolution (desktop/mobile/tablet).","operationId":"urlscanner-get-scan-screenshot-v2","parameters":[{"description":"Scan UUID.","in":"path","name":"scan_id","required":true,"schema":{"description":"Scan UUID.","format":"uuid","type":"string"}},{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Target device type.","in":"query","name":"resolution","schema":{"default":"desktop","description":"Target device type.","enum":["desktop","mobile","tablet"],"type":"string"}}],"responses":{"200":{"content":{"image/png":{"schema":{"description":"PNG Image.","type":"string"}}},"description":"Returns the scan's requested screenshot."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"},"title":{"example":"Invalid url","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"}},"required":["message","status","errors"],"type":"object"}}},"description":"Invalid input."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"example":"Queued","type":"string"},"status":{"description":"Status code.","example":404,"type":"integer"},"title":{"example":"Scan is not finished yet.","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"description":"Scan not found or in progress.","example":"Scan is not finished yet.","type":"string"},"status":{"description":"Status code.","example":404,"type":"integer"},"task":{"properties":{"status":{"example":"Queued","type":"string"},"time":{"type":"string"},"url":{"type":"string"},"uuid":{"type":"string"},"visibility":{"example":"public","type":"string"}},"required":["uuid","url","time","status","visibility"],"type":"object"}},"required":["message","status","errors","task"],"type":"object"}}},"description":"Scan not found or in progress."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get screenshot","tags":["URL Scanner"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/urlscanner/v2/search":{"get":{"description":"Use a subset of ElasticSearch Query syntax to filter scans. Some example queries:\u003cbr/\u003e \u003cbr/\u003e- 'path:\"/bundles/jquery.js\"': Searches for scans who requested resources with the given path.\u003cbr/\u003e- 'page.asn:AS24940 AND hash:xxx': Websites hosted in AS24940 where a resource with the given hash was downloaded.\u003cbr/\u003e- 'page.domain:microsoft* AND verdicts.malicious:true AND NOT page.domain:microsoft.com': malicious scans whose hostname starts with \"microsoft\".\u003cbr/\u003e- 'apikey:me AND date:[2025-01 TO 2025-02]': my scans from 2025 January to 2025 February.","operationId":"urlscanner-search-scans-v2","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"description":"Account ID.","type":"string"}},{"description":"Limit the number of objects in the response.","in":"query","name":"size","schema":{"description":"Limit the number of objects in the response.","example":100,"type":"integer"}},{"description":"Filter scans","in":"query","name":"q","schema":{"description":"Filter scans","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"results":{"items":{"properties":{"_id":{"example":"9626f773-9ffb-4cfb-89d3-30b120fc8011","type":"string"},"page":{"properties":{"asn":{"example":"AS15133","type":"string"},"country":{"example":"US","type":"string"},"ip":{"example":"93.184.215.14","type":"string"},"url":{"example":"https://example.com","type":"string"}},"required":["country","ip","url","asn"],"type":"object"},"result":{"example":"https://radar.clouflare.com/scan/9626f773-9ffb-4cfb-89d3-30b120fc8011","type":"string"},"stats":{"properties":{"dataLength":{"example":2512,"type":"number"},"requests":{"example":2,"type":"number"},"uniqCountries":{"example":1,"type":"number"},"uniqIPs":{"example":1,"type":"number"}},"required":["uniqIPs","uniqCountries","dataLength","requests"],"type":"object"},"task":{"properties":{"time":{"example":"2024-09-30T23:54:02.881000+00:00","type":"string"},"url":{"example":"https://example.com","type":"string"},"uuid":{"example":"9626f773-9ffb-4cfb-89d3-30b120fc8011","type":"string"},"visibility":{"example":"public","type":"string"}},"required":["visibility","time","uuid","url"],"type":"object"},"verdicts":{"properties":{"malicious":{"type":"boolean"}},"required":["malicious"],"type":"object"}},"required":["task","stats","page","verdicts","_id","result"],"type":"object"},"type":"array"}},"required":["results"],"type":"object"}}},"description":"Search results"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"},"title":{"example":"Invalid url","type":"string"}},"required":["title","detail","status"],"type":"object"},"type":"array"},"message":{"type":"string"},"status":{"description":"Status code.","example":400,"type":"integer"}},"required":["message","status","errors"],"type":"object"}}},"description":"Invalid input."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Search URL scans","tags":["URL Scanner"],"x-api-token-group":["URL Scanner Write","URL Scanner Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/vectorize/indexes":{"get":{"deprecated":true,"description":"Returns a list of Vectorize Indexes","operationId":"vectorize-(-deprecated)-list-vectorize-indexes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/vectorize_create-index-response"},"type":"array"}}}]}}},"description":"List Vectorize Index Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"List Vectorize Index Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Vectorize Indexes (Deprecated)","tags":["Vectorize Beta (Deprecated)"],"x-api-token-group":["Vectorize Write","Vectorize Read"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of the GET `/accounts/{account_id}/vectorize/v2/indexes` endpoint.","display":true,"id":"vectorize_list_index_deprecation"},"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.list"]}},"post":{"deprecated":true,"description":"Creates and returns a new Vectorize Index.","operationId":"vectorize-(-deprecated)-create-vectorize-index","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vectorize_create-index-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_create-index-response"}}}]}}},"description":"Create Vectorize Index Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Create Vectorize Index Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Vectorize Index (Deprecated)","tags":["Vectorize Beta (Deprecated)"],"x-api-token-group":["Vectorize Write"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes` endpoint.","display":true,"id":"vectorize_create_index_deprecation"},"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.create"]}}},"/accounts/{account_id}/vectorize/indexes/{index_name}":{"delete":{"deprecated":true,"description":"Deletes the specified Vectorize Index.","operationId":"vectorize-(-deprecated)-delete-vectorize-index","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}}}]}}},"description":"Delete Vectorize Index Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Delete Vectorize Index Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Vectorize Index (Deprecated)","tags":["Vectorize Beta (Deprecated)"],"x-api-token-group":["Vectorize Write"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of the DELETE `/accounts/{account_id}/vectorize/v2/indexes/{index_name}` endpoint.","display":true,"id":"vectorize_delete_index_deprecation"},"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.delete"]}},"get":{"deprecated":true,"description":"Returns the specified Vectorize Index.","operationId":"vectorize-(-deprecated)-get-vectorize-index","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_create-index-response"}}}]}}},"description":"Get Vectorize Index Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Get Vectorize Index Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Vectorize Index (Deprecated)","tags":["Vectorize Beta (Deprecated)"],"x-api-token-group":["Vectorize Write","Vectorize Read"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of the GET `/accounts/{account_id}/vectorize/v2/indexes/{index_name}` endpoint.","display":true,"id":"vectorize_get_index_deprecation"},"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.read"]}},"put":{"deprecated":true,"description":"Updates and returns the specified Vectorize Index.","operationId":"vectorize-(-deprecated)-update-vectorize-index","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vectorize_update-index-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_create-index-response"}}}]}}},"description":"Update Vectorize Index Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Update Vectorize Index Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Vectorize Index (Deprecated)","tags":["Vectorize Beta (Deprecated)"],"x-api-token-group":["Vectorize Write"],"x-cfDeprecation":{"description":"This endpoint has been deprecated and will soon be removed.","display":true,"id":"vectorize_update_index_deprecation"},"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.update"]}}},"/accounts/{account_id}/vectorize/indexes/{index_name}/delete-by-ids":{"post":{"deprecated":true,"description":"Delete a set of vectors from an index by their vector identifiers.","operationId":"vectorize-(-deprecated)-delete-vectors-by-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vectorize_index-delete-vectors-by-id-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_index-delete-vectors-by-id-response"}}}]}}},"description":"Delete Vector Identifiers Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Delete Vector Identifiers Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Vectors By Identifier (Deprecated)","tags":["Vectorize Beta (Deprecated)"],"x-api-token-group":["Vectorize Write"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids` endpoint.","display":true,"id":"vectorize_delete_by_ids_deprecation"}}},"/accounts/{account_id}/vectorize/indexes/{index_name}/get-by-ids":{"post":{"deprecated":true,"description":"Get a set of vectors from an index by their vector identifiers.","operationId":"vectorize-(-deprecated)-get-vectors-by-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vectorize_index-get-vectors-by-id-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_index-get-vectors-by-id-response"}}}]}}},"description":"Get Vectors By Identifier Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Get Vectors By Identifier Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Vectors By Identifier (Deprecated)","tags":["Vectorize Beta (Deprecated)"],"x-api-token-group":["Vectorize Write","Vectorize Read"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids` endpoint.","display":true,"id":"vectorize_get_by_ids_deprecation"}}},"/accounts/{account_id}/vectorize/indexes/{index_name}/insert":{"post":{"deprecated":true,"description":"Inserts vectors into the specified index and returns the count of the vectors successfully inserted.","operationId":"vectorize-(-deprecated)-insert-vector","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"requestBody":{"content":{"application/x-ndjson":{"schema":{"description":"ndjson file containing vectors to insert.","example":"@/path/to/vectors.ndjson","format":"binary","type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_index-insert-response"}}}]}}},"description":"Insert Vectors Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Insert Vectors Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Insert Vectors (Deprecated)","tags":["Vectorize Beta (Deprecated)"],"x-api-token-group":["Vectorize Write"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert` endpoint.","display":true,"id":"vectorize_insert_deprecation"},"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.update"]}}},"/accounts/{account_id}/vectorize/indexes/{index_name}/query":{"post":{"deprecated":true,"description":"Finds vectors closest to a given vector in an index.","operationId":"vectorize-(-deprecated)-query-vector","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vectorize_index-query-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_index-query-response"}}}]}}},"description":"Query Vectors Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Query Vectors Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Query Vectors (Deprecated)","tags":["Vectorize Beta (Deprecated)"],"x-api-token-group":["Vectorize Write","Vectorize Read"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query` endpoint.","display":true,"id":"vectorize_query_deprecation"},"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.read"]}}},"/accounts/{account_id}/vectorize/indexes/{index_name}/upsert":{"post":{"deprecated":true,"description":"Upserts vectors into the specified index, creating them if they do not exist and returns the count of values and ids successfully inserted.","operationId":"vectorize-(-deprecated)-upsert-vector","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"requestBody":{"content":{"application/x-ndjson":{"schema":{"description":"ndjson file containing vectors to upsert.","example":"@/path/to/vectors.ndjson","format":"binary","type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_index-upsert-response"}}}]}}},"description":"Insert Vectors Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Insert Vectors Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Upsert Vectors (Deprecated)","tags":["Vectorize Beta (Deprecated)"],"x-api-token-group":["Vectorize Write"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of the POST `/accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert` endpoint.","display":true,"id":"vectorize_upsert_deprecation"}}},"/accounts/{account_id}/vectorize/v2/indexes":{"get":{"description":"Returns a list of Vectorize Indexes","operationId":"vectorize-list-vectorize-indexes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/vectorize_create-index-response"},"type":"array"}}}]}}},"description":"List Vectorize Index Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"List Vectorize Index Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Vectorize Indexes","tags":["Vectorize"],"x-api-token-group":["Vectorize Write","Vectorize Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.list"]}},"post":{"description":"Creates and returns a new Vectorize Index.","operationId":"vectorize-create-vectorize-index","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vectorize_create-index-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_create-index-response"}}}]}}},"description":"Create Vectorize Index Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Create Vectorize Index Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Vectorize Index","tags":["Vectorize"],"x-api-token-group":["Vectorize Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.create"]}}},"/accounts/{account_id}/vectorize/v2/indexes/{index_name}":{"delete":{"description":"Deletes the specified Vectorize Index.","operationId":"vectorize-delete-vectorize-index","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}}}]}}},"description":"Delete Vectorize Index Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Delete Vectorize Index Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Vectorize Index","tags":["Vectorize"],"x-api-token-group":["Vectorize Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.delete"]}},"get":{"description":"Returns the specified Vectorize Index.","operationId":"vectorize-get-vectorize-index","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_create-index-response"}}}]}}},"description":"Get Vectorize Index Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Get Vectorize Index Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Vectorize Index","tags":["Vectorize"],"x-api-token-group":["Vectorize Write","Vectorize Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.read"]}}},"/accounts/{account_id}/vectorize/v2/indexes/{index_name}/delete_by_ids":{"post":{"description":"Delete a set of vectors from an index by their vector identifiers.","operationId":"vectorize-delete-vectors-by-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vectorize_index-delete-vectors-by-id-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_index-delete-vectors-by-id-v2-response"}}}]}}},"description":"Delete Vector Identifiers Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Delete Vector Identifiers Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Vectors By Identifier","tags":["Vectorize"],"x-api-token-group":["Vectorize Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.delete"]}}},"/accounts/{account_id}/vectorize/v2/indexes/{index_name}/get_by_ids":{"post":{"description":"Get a set of vectors from an index by their vector identifiers.","operationId":"vectorize-get-vectors-by-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vectorize_index-get-vectors-by-id-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_index-get-vectors-by-id-response"}}}]}}},"description":"Get Vectors By Identifier Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Get Vectors By Identifier Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Vectors By Identifier","tags":["Vectorize"],"x-api-token-group":["Vectorize Write","Vectorize Read"]}},"/accounts/{account_id}/vectorize/v2/indexes/{index_name}/info":{"get":{"description":"Get information about a vectorize index.","operationId":"vectorize-index-info","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_index-info-response"}}}]}}},"description":"Get Vectorize Index Info Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Get Vectorize Index Info Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Vectorize Index Info","tags":["Vectorize"],"x-api-token-group":["Vectorize Write","Vectorize Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.read"]}}},"/accounts/{account_id}/vectorize/v2/indexes/{index_name}/insert":{"post":{"description":"Inserts vectors into the specified index and returns a mutation id corresponding to the vectors enqueued for insertion.","operationId":"vectorize-insert-vector","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}},{"in":"query","name":"unparsable-behavior","schema":{"description":"Behavior for ndjson parse failures.","enum":["error","discard"],"type":"string"}}],"requestBody":{"content":{"application/x-ndjson":{"schema":{"description":"ndjson file containing vectors to insert.","example":"@/path/to/vectors.ndjson","format":"binary","type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_index-insert-v2-response"}}}]}}},"description":"Insert Vectors Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Insert Vectors Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Insert Vectors","tags":["Vectorize"],"x-api-token-group":["Vectorize Write"]}},"/accounts/{account_id}/vectorize/v2/indexes/{index_name}/list":{"get":{"description":"Returns a paginated list of vector identifiers from the specified index.","operationId":"vectorize-list-vectors","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}},{"in":"query","name":"count","schema":{"default":100,"description":"Maximum number of vectors to return","example":50,"maximum":1000,"minimum":1,"type":"integer"}},{"in":"query","name":"cursor","schema":{"description":"Cursor for pagination to get the next page of results","example":"suUTaDY5PFUiRweVccnzyt9n75suNPbXHPshvCzue5mHjtj7Letjvzlza9eGj099","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_index-list-vectors-response"}}}]}}},"description":"List Vectors Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"List Vectors Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Vectors","tags":["Vectorize"],"x-api-token-group":["Vectorize Write","Vectorize Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.read"]}}},"/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/create":{"post":{"description":"Enable metadata filtering based on metadata property. Limited to 10 properties.","operationId":"vectorize-create-metadata-index","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vectorize_create-metadata-index-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_create-metadata-index-response"}}}]}}},"description":"Create Metadata Index Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Create Metadata Index Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Metadata Index","tags":["Vectorize"],"x-api-token-group":["Vectorize Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.create"]}}},"/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/delete":{"post":{"description":"Allow Vectorize to delete the specified metadata index.","operationId":"vectorize-delete-metadata-index","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vectorize_delete-metadata-index-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_delete-metadata-index-response"}}}]}}},"description":"Delete Metadata Index Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Delete Metadata Index Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Metadata Index","tags":["Vectorize"],"x-api-token-group":["Vectorize Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.vectorize.index.delete"]}}},"/accounts/{account_id}/vectorize/v2/indexes/{index_name}/metadata_index/list":{"get":{"description":"List Metadata Indexes for the specified Vectorize Index.","operationId":"vectorize-list-metadata-indexes","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_list-metadata-index-response"}}}]}}},"description":"List Metadata Index Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"List Metadata Index Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Metadata Indexes","tags":["Vectorize"],"x-api-token-group":["Vectorize Write","Vectorize Read"]}},"/accounts/{account_id}/vectorize/v2/indexes/{index_name}/query":{"post":{"description":"Finds vectors closest to a given vector in an index.","operationId":"vectorize-query-vector","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vectorize_index-query-v2-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_index-query-v2-response"}}}]}}},"description":"Query Vectors Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Query Vectors Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Query Vectors","tags":["Vectorize"],"x-api-token-group":["Vectorize Write","Vectorize Read"]}},"/accounts/{account_id}/vectorize/v2/indexes/{index_name}/upsert":{"post":{"description":"Upserts vectors into the specified index, creating them if they do not exist and returns a mutation id corresponding to the vectors enqueued for upsertion.","operationId":"vectorize-upsert-vector","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/vectorize_identifier"}},{"in":"path","name":"index_name","required":true,"schema":{"$ref":"#/components/schemas/vectorize_index-name"}},{"in":"query","name":"unparsable-behavior","schema":{"description":"Behavior for ndjson parse failures.","enum":["error","discard"],"type":"string"}}],"requestBody":{"content":{"application/x-ndjson":{"schema":{"description":"ndjson file containing vectors to upsert.","example":"@/path/to/vectors.ndjson","format":"binary","type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/vectorize_index-upsert-v2-response"}}}]}}},"description":"Upsert Vectors Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/vectorize_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/vectorize_api-response-common-failure"}]}}},"description":"Upsert Vectors Failure Response"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Upsert Vectors","tags":["Vectorize"],"x-api-token-group":["Vectorize Write"]}},"/accounts/{account_id}/waiting_rooms":{"get":{"description":"Lists waiting rooms for account.","operationId":"waiting-room-list-waiting-rooms-account","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}},{"$ref":"#/components/parameters/waitingroom_page"},{"$ref":"#/components/parameters/waitingroom_per_page"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_response_collection"}}},"description":"List waiting rooms for account response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_response_collection"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"List waiting rooms for account response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List waiting rooms for account","tags":["Waiting Room"],"x-api-token-group":["Account Waiting Rooms Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_id}/warp_connector":{"get":{"description":"Lists and filters Warp Connector Tunnels in an account.","operationId":"cloudflare-tunnel-list-warp-connector-tunnels","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"query","name":"name","schema":{"description":"A user-friendly name for the tunnel.","example":"blog","type":"string"}},{"in":"query","name":"is_deleted","schema":{"description":"If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.","example":true,"type":"boolean"}},{"in":"query","name":"existed_at","schema":{"$ref":"#/components/schemas/tunnel_existed_at"}},{"in":"query","name":"uuid","schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}},{"in":"query","name":"was_active_at","schema":{"example":"2009-11-10T23:00:00Z","format":"date-time","type":"string"}},{"in":"query","name":"was_inactive_at","schema":{"example":"2009-11-10T23:00:00Z","format":"date-time","type":"string"}},{"in":"query","name":"include_prefix","schema":{"example":"vpc1-","type":"string"}},{"in":"query","name":"exclude_prefix","schema":{"example":"vpc1-","type":"string"}},{"in":"query","name":"status","schema":{"$ref":"#/components/schemas/tunnel_status"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/tunnel_per_page"}},{"in":"query","name":"page","schema":{"$ref":"#/components/schemas/tunnel_page_number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_warp-connector-response-collection"}}},"description":"List Warp Connector Tunnels response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_warp-connector-response-collection"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"List Warp Connector Tunnels response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List Warp Connector Tunnels","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connectors Read","Cloudflare One Connector: WARP Write","Cloudflare One Connector: WARP Read"]},"post":{"description":"Creates a new Warp Connector Tunnel in an account.","operationId":"cloudflare-tunnel-create-a-warp-connector-tunnel","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/tunnel_tunnel_name"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_warp-connector-response-single"}}},"description":"Create a Warp Connector Tunnel response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_warp-connector-response-single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Create a Warp Connector Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Create a Warp Connector Tunnel","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connector: WARP Write"]}},"/accounts/{account_id}/warp_connector/{tunnel_id}":{"delete":{"description":"Deletes a Warp Connector Tunnel from an account.","operationId":"cloudflare-tunnel-delete-a-warp-connector-tunnel","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_warp-connector-response-single"}}},"description":"Delete a Warp Connector Tunnel response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_warp-connector-response-single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Delete a Warp Connector Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Delete a Warp Connector Tunnel","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connector: WARP Write"]},"get":{"description":"Fetches a single Warp Connector Tunnel.","operationId":"cloudflare-tunnel-get-a-warp-connector-tunnel","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_warp-connector-response-single"}}},"description":"Get a Warp Connector Tunnel response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_warp-connector-response-single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Get a Warp Connector Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get a Warp Connector Tunnel","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connectors Read","Cloudflare One Connector: WARP Write","Cloudflare One Connector: WARP Read"]},"patch":{"description":"Updates an existing Warp Connector Tunnel.","operationId":"cloudflare-tunnel-update-a-warp-connector-tunnel","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/tunnel_tunnel_name"},"tunnel_secret":{"$ref":"#/components/schemas/tunnel_tunnel_secret"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_warp-connector-response-single"}}},"description":"Update a Warp Connector Tunnel response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_warp-connector-response-single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Update a Warp Connector Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Update a Warp Connector Tunnel","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connector: WARP Write"]}},"/accounts/{account_id}/warp_connector/{tunnel_id}/token":{"get":{"description":"Gets the token used to associate warp device with a specific Warp Connector tunnel.","operationId":"cloudflare-tunnel-get-a-warp-connector-tunnel-token","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_tunnel_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_tunnel_response_token"}}},"description":"Get a Warp Connector Tunnel token response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_tunnel_response_token"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Get a Warp Connector Tunnel token response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get a Warp Connector Tunnel token","tags":["Cloudflare Tunnel"],"x-api-token-group":["Cloudflare One Connectors Write","Cloudflare One Connector: cloudflared Write","Cloudflare Tunnel Write"]}},"/accounts/{account_id}/workers/account-settings":{"get":{"description":"Fetches Worker account settings for an account.","operationId":"worker-account-settings-fetch-worker-account-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_account-settings"}},"required":["result"],"type":"object"}]}}},"description":"Fetch Worker Account Settings response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Fetch Worker Account Settings response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Fetch Worker Account Settings","tags":["Worker Account Settings"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","DNS View Write","DNS View Read","SCIM Provisioning","Load Balancers Account Write","Load Balancers Account Read","Zero Trust: PII Read","DDoS Botnet Feed Write","DDoS Botnet Feed Read","Workers R2 Storage Write","Workers R2 Storage Read","DDoS Protection Write","DDoS Protection Read","Workers Tail Read","Workers KV Storage Write","Workers KV Storage Read","Workers Scripts Write","Workers Scripts Read","Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read","Account Firewall Access Rules Write","Account Firewall Access Rules Read","DNS Firewall Write","DNS Firewall Read","Billing Write","Billing Read","Account Settings Write","Account Settings Read"]},"put":{"description":"Creates Worker account settings for an account.","operationId":"worker-account-settings-create-worker-account-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_account-settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_account-settings"}},"required":["result"],"type":"object"}]}}},"description":"Create Worker Account Settings response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Create Worker Account Settings response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Worker Account Settings","tags":["Worker Account Settings"],"x-api-token-group":["Account Settings Write"]}},"/accounts/{account_id}/workers/assets/upload":{"post":{"description":"Upload assets ahead of creating a Worker version.  To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/.","operationId":"worker-assets-upload","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"query","name":"base64","required":true,"schema":{"description":"Whether the file contents are base64-encoded. Must be `true`.","enum":[true],"type":"boolean"}}],"requestBody":{"content":{"multipart/form-data":{"encoding":{"*":{"contentType":"*/*"}},"schema":{"additionalProperties":{"description":"Base-64 encoded contents of the file. The content type of the file should be included to ensure a valid \"Content-Type\" header is included in asset responses.","type":"string"},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_completed-upload-assets-response"}}},"description":"Upload Assets response."},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_upload-assets-response"}}},"description":"Upload Assets response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Upload Assets response failure."}},"security":[{"assets_jwt":[]}],"summary":"Upload Assets","tags":["Worker Script"]}},"/accounts/{account_id}/workers/dispatch/namespaces":{"get":{"description":"Fetch a list of Workers for Platforms namespaces.","operationId":"namespace-worker-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_namespace-list-response"}}},"description":"Fetch a list of Workers for Platforms namespaces."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Failure to get list of Workers for Platforms namespaces."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List dispatch namespaces","tags":["Workers for Platforms"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"post":{"description":"Create a new Workers for Platforms namespace.","operationId":"namespace-worker-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"The name of the dispatch namespace.","example":"my-dispatch-namespace","type":"string","x-auditable":true}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_namespace-single-response"}}},"description":"Fetch a list of Workers for Platforms namespaces."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Failure to get list of Workers for Platforms namespaces."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create dispatch namespace","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}":{"delete":{"description":"Delete a Workers for Platforms namespace.","operationId":"namespace-worker-delete-namespace","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-null-result"}}},"description":"Delete a Workers for Platforms namespace."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Failure to delete Workers for Platforms namespace."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete dispatch namespace","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]},"get":{"description":"Get a Workers for Platforms namespace.","operationId":"namespace-worker-get-namespace","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_namespace-single-response"}}},"description":"Get a Workers for Platforms namespace."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Failure to get Workers for Platforms namespace."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get dispatch namespace","tags":["Workers for Platforms"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"patch":{"description":"Patch a Workers for Platforms namespace. Omitted fields are left unchanged.","operationId":"namespace-worker-patch-namespace","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"The name of the dispatch namespace.","example":"my-dispatch-namespace","type":"string","x-auditable":true},"trusted_workers":{"$ref":"#/components/schemas/workers_trusted_workers"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_namespace-single-response"}}},"description":"Patch a Workers for Platforms namespace."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Failure to patch Workers for Platforms namespace."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch dispatch namespace","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]},"put":{"description":"Update a Workers for Platforms namespace.","operationId":"namespace-worker-put-namespace","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"The name of the dispatch namespace.","example":"my-dispatch-namespace","type":"string","x-auditable":true},"trusted_workers":{"$ref":"#/components/schemas/workers_trusted_workers"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_namespace-single-response"}}},"description":"Update a Workers for Platforms namespace."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Failure to update Workers for Platforms namespace."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update dispatch namespace","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts":{"delete":{"description":"Delete multiple scripts from a Workers for Platforms namespace based on optional tag filters.","operationId":"namespace-worker-delete-scripts","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"description":"Filter scripts by tags before deletion. Format: comma-separated list of tag:allowed pairs where allowed is 'yes' or 'no'.","in":"query","name":"tags","schema":{"example":"production:yes,staging:no","type":"string"}},{"description":"Limit the number of scripts to delete.","in":"query","name":"limit","schema":{"example":1000,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_namespace-script-delete-bulk-response"}}},"description":"Delete scripts in namespace response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Delete scripts in namespace response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Scripts in Namespace","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]},"get":{"description":"Fetch a list of scripts uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-list-scripts","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"description":"Filter scripts by tags. Format: comma-separated list of tag:allowed pairs where allowed is 'yes' or 'no'.","in":"query","name":"tags","schema":{"example":"production:yes,staging:no","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers_namespace-script-response"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"List scripts in namespace response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"List scripts in namespace response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Scripts in Namespace","tags":["Workers for Platforms"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]}},"/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}":{"delete":{"description":"Delete a worker from a Workers for Platforms namespace. This call has no response body on a successful delete.","operationId":"namespace-worker-script-delete-worker","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"description":"If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script.","in":"query","name":"force","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-null-result"}}},"description":"Delete Worker response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Delete Worker response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Worker","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]},"get":{"description":"Fetch information about a script uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-script-worker-details","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_namespace-script-response-single"}}},"description":"Worker Details Response (Workers for Platforms)."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Worker Details Failure (Workers for Platforms)."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Worker Details","tags":["Workers for Platforms"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"put":{"description":"Upload a worker module to a Workers for Platforms namespace. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.","operationId":"namespace-worker-script-upload-worker-module","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"$ref":"#/components/requestBodies/workers_script_upload"},"responses":{"200":{"$ref":"#/components/responses/workers_200"},"4XX":{"$ref":"#/components/responses/workers_4XX"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Upload Worker Module","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/assets-upload-session":{"post":{"description":"Start uploading a collection of assets for use in a Worker version. To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/.","operationId":"namespace-worker-script-update-create-assets-upload-session","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_create-assets-upload-session-object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_create-assets-upload-session-response"}}},"description":"Create Assets Upload Session response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Create Assets Upload Session response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Assets Upload Session","tags":["Workers for Platforms"]}},"/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/bindings":{"get":{"description":"Fetch script bindings from a script uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-get-script-bindings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_bindings"}},"required":["result"],"type":"object"}]}}},"description":"Fetch script bindings (Workers for Platforms)."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Fetch script bindings failure (Workers for Platforms)."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Script Bindings","tags":["Workers for Platforms"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]}},"/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/content":{"get":{"description":"Fetch script content from a script uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-get-script-content","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"string":{"schema":{"example":"export default {\n  async fetch(request, env, ctx) {\n    return new Response(\"Hello, world!\");\n  }\n};\n","type":"string"}}},"description":"Get script content."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Get script content failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Script Content","tags":["Workers for Platforms"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"put":{"description":"Put script content for a script uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-put-script-content","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"description":"The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part.","in":"header","name":"CF-WORKER-BODY-PART","schema":{"type":"string"}},{"description":"The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part.","in":"header","name":"CF-WORKER-MAIN-MODULE-PART","schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"encoding":{"files":{"contentType":"application/javascript+module, text/javascript+module, application/javascript, text/javascript, text/x-python, text/x-python-requirement, application/wasm, text/plain, application/octet-stream, application/source-map"},"metadata":{"contentType":"application/json"}},"schema":{"properties":{"files":{"description":"An array of modules (often JavaScript files) comprising a Worker script. At least one module must be present and referenced in the metadata as `main_module` or `body_part` by filename.\u003cbr/\u003ePossible Content-Type(s) are: `application/javascript+module`, `text/javascript+module`, `application/javascript`, `text/javascript`, `text/x-python`, `text/x-python-requirement`, `application/wasm`, `text/plain`, `application/octet-stream`, `application/source-map`.","items":{"format":"binary","type":"string"},"type":"array","x-stainless-collection-type":"set"},"metadata":{"description":"JSON-encoded metadata about the uploaded parts and Worker configuration.","properties":{"body_part":{"description":"Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker.","example":"worker.js","type":"string"},"main_module":{"description":"Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.","example":"worker.js","type":"string"}},"type":"object"}},"required":["metadata"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_script-response-single"}}},"description":"Put script content (Workers for Platforms)."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Put script content failure (Workers for Platforms)."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Put Script Content","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets":{"get":{"description":"List secrets bound to a script uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-list-script-secrets","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers_secret"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"List script secrets."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"List script secrets failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Script Secrets","tags":["Workers for Platforms"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"put":{"description":"Add a secret to a script uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-put-script-secrets","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_secret"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_secret"}},"required":["result"],"type":"object"}]}}},"description":"Fetch script bindings (Workers for Platforms)."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Fetch script bindings failure (Workers for Platforms)."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Add script secret","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/secrets/{secret_name}":{"delete":{"description":"Remove a secret from a script uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-delete-script-secret","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"in":"path","name":"secret_name","required":true,"schema":{"$ref":"#/components/schemas/workers_secret_name"}},{"in":"query","name":"url_encoded","schema":{"$ref":"#/components/schemas/workers_secret_name_url_encoded"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-null-result"}}},"description":"Delete script secret binding (Workers for Platforms)."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Delete script secret failure (Workers for Platforms)."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete script secret","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]},"get":{"description":"Get a given secret binding (value omitted) on a script uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-get-script-secrets","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"in":"path","name":"secret_name","required":true,"schema":{"$ref":"#/components/schemas/workers_secret_name"}},{"in":"query","name":"url_encoded","schema":{"$ref":"#/components/schemas/workers_secret_name_url_encoded"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_secret"}},"required":["result"],"type":"object"}]}}},"description":"Get script secret (Workers for Platforms)."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Get script secret failure (Workers for Platforms)."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get secret binding","tags":["Workers for Platforms"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]}},"/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/settings":{"get":{"description":"Get script settings from a script uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-get-script-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_script-and-version-settings-item"}},"type":"object"}]}}},"description":"Fetch script settings."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Fetch script settings failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Script Settings","tags":["Workers for Platforms"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"patch":{"description":"Patch script metadata, such as bindings.","operationId":"namespace-worker-patch-script-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"content":{"multipart/form-data":{"encoding":{"settings":{"contentType":"application/json"}},"schema":{"properties":{"settings":{"$ref":"#/components/schemas/workers_script-and-version-settings-item"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_script-and-version-settings-item"}},"type":"object"}]}}},"description":"Patch script settings."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Patch script settings failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Script Settings","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags":{"get":{"description":"Fetch tags from a script uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-get-script-tags","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"example":["free","customer"],"items":{"$ref":"#/components/schemas/workers_tag"},"type":"array"}},"type":"object"}]}}},"description":"Fetch script tags."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Fetch script tags failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Script Tags","tags":["Workers for Platforms"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"put":{"description":"Put script tags for a script uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-put-script-tags","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_tags"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"example":["my-tag"],"items":{"$ref":"#/components/schemas/workers_tag"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"Fetch script tags."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Fetch script tags failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Put Script Tags","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/dispatch/namespaces/{dispatch_namespace}/scripts/{script_name}/tags/{tag}":{"delete":{"description":"Delete script tag for a script uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-delete-script-tag","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"in":"path","name":"tag","required":true,"schema":{"$ref":"#/components/schemas/workers_tag"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-null-result"}}},"description":"Delete script tag."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Delete script tag failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Script Tag","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]},"put":{"description":"Put a single tag on a script uploaded to a Workers for Platforms namespace.","operationId":"namespace-worker-put-script-tag","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"dispatch_namespace","required":true,"schema":{"$ref":"#/components/schemas/workers_dispatch_namespace_name"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"in":"path","name":"tag","required":true,"schema":{"$ref":"#/components/schemas/workers_tag"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-null-result"}}},"description":"Put script tag."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Put script tag failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Put Script Tag","tags":["Workers for Platforms"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/domains":{"get":{"description":"Lists all Worker Domains for an account.","operationId":"worker-domain-list-domains","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_account_identifier"}},{"in":"query","name":"zone_name","schema":{"$ref":"#/components/schemas/workers_zone_name"}},{"in":"query","name":"service","schema":{"$ref":"#/components/schemas/workers_schemas-service"}},{"in":"query","name":"zone_id","schema":{"$ref":"#/components/schemas/workers_zone_identifier"}},{"in":"query","name":"hostname","schema":{"description":"Hostname of the Worker Domain.","example":"foo.example.com","type":"string"}},{"in":"query","name":"environment","schema":{"description":"Worker environment associated with the zone and hostname.","example":"production","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_domain-response-collection"}}},"description":"List Domains response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_domain-response-collection"},{"$ref":"#/components/schemas/workers_api-response-common-failure"}]}}},"description":"List Domains response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Domains","tags":["Worker Domain"],"x-api-token-group":["Workers Scripts Write","Workers Scripts Read"]},"put":{"description":"Attaches a Worker to a zone and hostname.","operationId":"worker-domain-attach-to-domain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"environment":{"$ref":"#/components/schemas/workers_schemas-environment"},"hostname":{"$ref":"#/components/schemas/workers_hostname"},"service":{"$ref":"#/components/schemas/workers_schemas-service"},"zone_id":{"$ref":"#/components/schemas/workers_zone_identifier"}},"required":["zone_id","hostname","service"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_domain-response-single"}}},"description":"Attach to Domain response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_domain-response-single"},{"$ref":"#/components/schemas/workers_api-response-common-failure"}]}}},"description":"Attach to Domain response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Attach to Domain","tags":["Worker Domain"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/domains/{domain_id}":{"delete":{"description":"Detaches a Worker from a zone and hostname.","operationId":"worker-domain-detach-from-domain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_account_identifier"}},{"in":"path","name":"domain_id","required":true,"schema":{"$ref":"#/components/schemas/workers_domain_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Detach from Domain response."},"4XX":{"content":{"application/json":{}},"description":"Detach from Domain response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Detach from Domain","tags":["Worker Domain"],"x-api-token-group":["Workers Scripts Write"]},"get":{"description":"Gets a Worker domain.","operationId":"worker-domain-get-a-domain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_account_identifier"}},{"in":"path","name":"domain_id","required":true,"schema":{"$ref":"#/components/schemas/workers_domain_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_domain-response-single"}}},"description":"Get a Domain response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_domain-response-single"},{"$ref":"#/components/schemas/workers_api-response-common-failure"}]}}},"description":"Get a Domain response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get a Domain","tags":["Worker Domain"],"x-api-token-group":["Workers Scripts Write","Workers Scripts Read"]}},"/accounts/{account_id}/workers/durable_objects/namespaces":{"get":{"description":"Returns the Durable Object namespaces owned by an account.","operationId":"durable-objects-namespace-list-namespaces","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"description":"Current page.","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"Items per-page.","in":"query","name":"per_page","schema":{"default":20,"maximum":1000,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers_namespace"},"type":"array"}},"type":"object"}]}}},"description":"List Namespaces response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/workers_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers_namespace"},"type":"array"}},"type":"object"}]},{"$ref":"#/components/schemas/workers_api-response-common-failure"}]}}},"description":"List Namespaces response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Namespaces","tags":["Durable Objects Namespace"],"x-api-token-group":["Workers Scripts Write","Workers Scripts Read"]}},"/accounts/{account_id}/workers/durable_objects/namespaces/{id}/objects":{"get":{"description":"Returns the Durable Objects in a given namespace.","operationId":"durable-objects-namespace-list-objects","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/workers_schemas-id"}},{"in":"query","name":"limit","schema":{"default":1000,"description":"The number of objects to return. The cursor attribute may be used to iterate over the next batch of objects if there are more than the limit.","maximum":10000,"minimum":10,"type":"number"}},{"in":"query","name":"cursor","schema":{"description":"Opaque token indicating the position from which to continue when requesting the next set of records. A valid value for the cursor can be obtained from the cursors object in the result_info structure.","example":"AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers_object"},"type":"array"},"result_info":{"properties":{"count":{"description":"Total results returned based on your list parameters.","example":1,"type":"number"},"cursor":{"$ref":"#/components/schemas/workers_cursor"}},"type":"object"}},"type":"object"}]}}},"description":"List Objects response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/workers_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers_object"},"type":"array"},"result_info":{"properties":{"count":{"description":"Total results returned based on your list parameters.","example":1,"type":"number"},"cursor":{"$ref":"#/components/schemas/workers_cursor"}},"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/workers_api-response-common-failure"}]}}},"description":"List Objects response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Objects","tags":["Durable Objects Namespace"],"x-api-token-group":["Workers Scripts Write","Workers Scripts Read"]}},"/accounts/{account_id}/workers/observability/destinations":{"get":{"description":"List your Workers Observability Telemetry Destinations","operationId":"destination.list","parameters":[{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"number"}},{"in":"query","name":"perPage","schema":{"default":20,"maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"in":"query","name":"orderBy","schema":{"default":"updated","enum":["created","updated"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"enum":["Successful request"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"items":{"properties":{"configuration":{"properties":{"destination_conf":{"type":"string"},"headers":{"additionalProperties":{"type":"string"},"type":"object"},"jobStatus":{"properties":{"error_message":{"type":"string"},"last_complete":{"type":"string"},"last_error":{"type":"string"}},"required":["last_complete","last_error","error_message"],"type":"object"},"logpushDataset":{"anyOf":[{"enum":["opentelemetry-traces"],"type":"string"},{"enum":["opentelemetry-logs"],"type":"string"}]},"type":{"enum":["logpush"],"type":"string"},"url":{"type":"string"}},"required":["type","logpushDataset","destination_conf","url","headers","jobStatus"],"type":"object"},"enabled":{"type":"boolean"},"name":{"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","type":"string"},"scripts":{"items":{"type":"string"},"type":"array"},"slug":{"type":"string"}},"required":["slug","name","enabled","configuration","scripts"],"type":"object"},"type":"array"},"success":{"enum":[true],"type":"boolean"}},"required":["messages","success","errors","result"],"type":"object"}}},"description":"Successful request"},"401":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Unauthorized"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Not found"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Internal error"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Internal error"}},"summary":"Get Destinations","tags":["Destinations"],"x-api-token-group":["Workers Observability Write","Workers Observability Read"]},"parameters":[{"description":"Your Cloudflare account ID.","in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"post":{"description":"Create a new Workers Observability Telemetry Destination","operationId":"destination.create","requestBody":{"content":{"application/json":{"schema":{"properties":{"configuration":{"properties":{"headers":{"additionalProperties":{"type":"string"},"type":"object"},"logpushDataset":{"anyOf":[{"enum":["opentelemetry-traces"],"type":"string"},{"enum":["opentelemetry-logs"],"type":"string"}]},"type":{"enum":["logpush"],"type":"string"},"url":{"type":"string"}},"required":["type","logpushDataset","url","headers"],"type":"object"},"enabled":{"type":"boolean"},"name":{"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","type":"string"}},"required":["name","enabled","configuration"],"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"enum":["Resource created"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"properties":{"configuration":{"properties":{"destination_conf":{"type":"string"},"logpushDataset":{"anyOf":[{"enum":["opentelemetry-traces"],"type":"string"},{"enum":["opentelemetry-logs"],"type":"string"}]},"logpushJob":{"type":"number"},"type":{"enum":["logpush"],"type":"string"},"url":{"type":"string"}},"required":["type","logpushDataset","logpushJob","destination_conf","url"],"type":"object"},"enabled":{"type":"boolean"},"name":{"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","type":"string"},"scripts":{"items":{"type":"string"},"type":"array"},"slug":{"type":"string"}},"required":["slug","name","enabled","configuration","scripts"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["messages","success","errors","result"],"type":"object"}}},"description":"Resource created"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Bad Request"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Unauthorized"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Internal error"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Internal error"}},"summary":"Create Destination","tags":["Destinations"],"x-api-token-group":["Workers Observability Write"]}},"/accounts/{account_id}/workers/observability/destinations/{slug}":{"delete":{"description":"Delete a Workers Observability Telemetry Destination","operationId":"destinations.delete","parameters":[{"in":"path","name":"slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"enum":["Successful request"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"properties":{"configuration":{"properties":{"destination_conf":{"type":"string"},"logpushDataset":{"anyOf":[{"enum":["opentelemetry-traces"],"type":"string"},{"enum":["opentelemetry-logs"],"type":"string"}]},"logpushJob":{"type":"number"},"type":{"enum":["logpush"],"type":"string"},"url":{"type":"string"}},"required":["type","logpushDataset","logpushJob","destination_conf","url"],"type":"object"},"enabled":{"type":"boolean"},"name":{"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","type":"string"},"scripts":{"items":{"type":"string"},"type":"array"},"slug":{"type":"string"}},"required":["slug","name","enabled","configuration","scripts"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["messages","success","errors"],"type":"object"}}},"description":"Successful request"},"401":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Unauthorized"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Not found"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Internal error"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Internal error"}},"summary":"Delete Destination","tags":["Destinations"],"x-api-token-group":["Workers Observability Write"]},"parameters":[{"description":"Your Cloudflare account ID.","in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"patch":{"description":"Update an existing Workers Observability Telemetry Destination","operationId":"destination.update","parameters":[{"in":"path","name":"slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"configuration":{"properties":{"headers":{"additionalProperties":{"type":"string"},"type":"object"},"type":{"enum":["logpush"],"type":"string"},"url":{"type":"string"}},"required":["type","url","headers"],"type":"object"},"enabled":{"type":"boolean"}},"required":["enabled","configuration"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"enum":["Successful request"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"properties":{"configuration":{"properties":{"destination_conf":{"type":"string"},"logpushDataset":{"anyOf":[{"enum":["opentelemetry-traces"],"type":"string"},{"enum":["opentelemetry-logs"],"type":"string"}]},"logpushJob":{"type":"number"},"type":{"enum":["logpush"],"type":"string"},"url":{"type":"string"}},"required":["type","logpushDataset","logpushJob","destination_conf","url"],"type":"object"},"enabled":{"type":"boolean"},"name":{"pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]$","type":"string"},"scripts":{"items":{"type":"string"},"type":"array"},"slug":{"type":"string"}},"required":["slug","name","enabled","configuration","scripts"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["messages","success","errors","result"],"type":"object"}}},"description":"Successful request"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Bad Request"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Unauthorized"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Not found"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Internal error"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Internal error"}},"summary":"Update Destination","tags":["Destinations"],"x-api-token-group":["Workers Observability Write"]}},"/accounts/{account_id}/workers/observability/telemetry/keys":{"parameters":[{"description":"Your Cloudflare account ID.","in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"post":{"description":"List all the keys in your telemetry events.","operationId":"telemetry.keys.list","requestBody":{"content":{"application/json":{"schema":{"properties":{"datasets":{"default":[],"items":{"type":"string"},"type":"array"},"filters":{"default":[],"items":{"properties":{"key":{"type":"string"},"operation":{"enum":["includes","not_includes","starts_with","regex","exists","is_null","in","not_in","eq","neq","gt","gte","lt","lte","=","!=","\u003e","\u003e=","\u003c","\u003c=","INCLUDES","DOES_NOT_INCLUDE","MATCH_REGEX","EXISTS","DOES_NOT_EXIST","IN","NOT_IN","STARTS_WITH"],"type":"string"},"type":{"enum":["string","number","boolean"],"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","operation","type"],"type":"object"},"type":"array"},"from":{"type":"number"},"keyNeedle":{"description":"Search for a specific substring in the keys.","properties":{"isRegex":{"type":"boolean"},"matchCase":{"type":"boolean"},"value":{"allOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"maxLength":1000,"type":"string"}]}},"required":["value"],"type":"object"},"limit":{"type":"number"},"needle":{"description":"Search for a specific substring in any of the events","properties":{"isRegex":{"type":"boolean"},"matchCase":{"type":"boolean"},"value":{"allOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"maxLength":1000,"type":"string"}]}},"required":["value"],"type":"object"},"to":{"type":"number"}},"type":"object"}}},"description":"Find keys in your telemetry events, matching a specific filter or needle.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"enum":["Successful request"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"items":{"properties":{"key":{"type":"string"},"lastSeenAt":{"type":"number"},"type":{"enum":["string","boolean","number"],"type":"string"}},"required":["key","type","lastSeenAt"],"type":"object"},"type":"array"},"success":{"enum":[true],"type":"boolean"}},"required":["messages","success","errors","result"],"type":"object"}}},"description":"Successful request"},"401":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Unauthorized"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Internal error"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Internal error"}},"summary":"List keys","tags":["Keys"],"x-api-token-group":["Workers Observability Write"]}},"/accounts/{account_id}/workers/observability/telemetry/query":{"parameters":[{"description":"Your Cloudflare account ID.","in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"post":{"description":"Runs a temporary or saved query","operationId":"telemetry.query","requestBody":{"content":{"application/json":{"schema":{"properties":{"chart":{"description":"Whether to include timeseties data in the response","type":"boolean"},"compare":{"description":"Whether to include comparison data with previous time periods","type":"boolean"},"dry":{"default":false,"description":"Whether to perform a dry run without saving the results of the query. Useful for validation","type":"boolean"},"granularity":{"description":"Time granularity for aggregating results (in milliseconds). Controls the bucketing of time-series data","type":"number"},"ignoreSeries":{"default":false,"description":"Whether to ignore time-series data in the results and return only aggregated values","type":"boolean"},"limit":{"default":50,"description":"Maximum number of events to return.","maximum":2000,"type":"number"},"offset":{"description":"Cursor for pagination to retrieve the next set of results","type":"string"},"offsetBy":{"description":"Number of events to skip for pagination. Used in conjunction with offset","type":"number"},"offsetDirection":{"description":"Direction for offset-based pagination (e.g., 'next', 'prev')","type":"string"},"parameters":{"description":"Optional parameters to pass to the query execution","properties":{"calculations":{"description":"Create Calculations to compute as part of the query.","items":{"properties":{"alias":{"type":"string"},"key":{"type":"string"},"keyType":{"enum":["string","number","boolean"],"type":"string"},"operator":{"enum":["uniq","count","max","min","sum","avg","median","p001","p01","p05","p10","p25","p75","p90","p95","p99","p999","stddev","variance","COUNT_DISTINCT","COUNT","MAX","MIN","SUM","AVG","MEDIAN","P001","P01","P05","P10","P25","P75","P90","P95","P99","P999","STDDEV","VARIANCE"],"type":"string"}},"required":["operator"],"type":"object"},"type":"array"},"datasets":{"description":"Set the Datasets to query. Leave it empty to query all the datasets.","example":[],"items":{"type":"string"},"type":"array"},"filterCombination":{"description":"Set a Flag to describe how to combine the filters on the query.","enum":["and","or","AND","OR"],"type":"string"},"filters":{"description":"Configure the Filters to apply to the query.","items":{"properties":{"key":{"type":"string"},"operation":{"enum":["includes","not_includes","starts_with","regex","exists","is_null","in","not_in","eq","neq","gt","gte","lt","lte","=","!=","\u003e","\u003e=","\u003c","\u003c=","INCLUDES","DOES_NOT_INCLUDE","MATCH_REGEX","EXISTS","DOES_NOT_EXIST","IN","NOT_IN","STARTS_WITH"],"type":"string"},"type":{"enum":["string","number","boolean"],"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","operation","type"],"type":"object"},"type":"array"},"groupBys":{"description":"Define how to group the results of the query.","items":{"properties":{"type":{"enum":["string","number","boolean"],"type":"string"},"value":{"type":"string"}},"required":["type","value"],"type":"object"},"type":"array"},"havings":{"description":"Configure the Having clauses that filter on calculations in the query result.","items":{"properties":{"key":{"type":"string"},"operation":{"enum":["eq","neq","gt","gte","lt","lte"],"type":"string"},"value":{"type":"number"}},"required":["key","operation","value"],"type":"object"},"type":"array"},"limit":{"description":"Set a limit on the number of results / records returned by the query","maximum":2000,"minimum":0,"type":"integer"},"needle":{"description":"Define an expression to search using full-text search.","properties":{"isRegex":{"type":"boolean"},"matchCase":{"type":"boolean"},"value":{"allOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"maxLength":1000,"type":"string"}]}},"required":["value"],"type":"object"},"orderBy":{"description":"Configure the order of the results returned by the query.","properties":{"order":{"description":"Set the order of the results","enum":["asc","desc"],"type":"string"},"value":{"description":"Configure which Calculation to order the results by.","type":"string"}},"required":["value"],"type":"object"}},"type":"object"},"patternType":{"description":"Type of pattern to search for when using pattern-based views","enum":["message","error"],"type":"string"},"queryId":{"description":"Unique identifier for the query to execute","type":"string"},"timeframe":{"description":"Time range for the query execution","properties":{"from":{"description":"Start timestamp for the query timeframe (Unix timestamp in milliseconds)","type":"number"},"to":{"description":"End timestamp for the query timeframe (Unix timestamp in milliseconds)","type":"number"}},"required":["to","from"],"type":"object"},"view":{"default":"calculations","description":"View type for presenting the query results.","enum":["traces","events","calculations","invocations","requests","patterns"],"type":"string"}},"required":["queryId","timeframe"],"type":"object"}}},"description":"Query your observability events, requests, and traces. Build visualizations and identify insights.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"enum":["Successful request"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"$ref":"#/components/schemas/workers-observability_query_results"},"success":{"enum":[true],"type":"boolean"}},"required":["messages","success","errors","result"],"type":"object"}}},"description":"Successful request"},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Bad Request"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Unauthorized"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Internal error"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Internal error"}},"summary":"Run a query","tags":["Query run"],"x-api-token-group":["Workers Observability Write"]}},"/accounts/{account_id}/workers/observability/telemetry/values":{"parameters":[{"description":"Your Cloudflare account ID.","in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"post":{"description":"List unique values found in your events","operationId":"telemetry.values.list","requestBody":{"content":{"application/json":{"schema":{"properties":{"datasets":{"items":{"type":"string"},"type":"array"},"filters":{"default":[],"items":{"properties":{"key":{"type":"string"},"operation":{"enum":["includes","not_includes","starts_with","regex","exists","is_null","in","not_in","eq","neq","gt","gte","lt","lte","=","!=","\u003e","\u003e=","\u003c","\u003c=","INCLUDES","DOES_NOT_INCLUDE","MATCH_REGEX","EXISTS","DOES_NOT_EXIST","IN","NOT_IN","STARTS_WITH"],"type":"string"},"type":{"enum":["string","number","boolean"],"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","operation","type"],"type":"object"},"type":"array"},"key":{"type":"string"},"limit":{"default":50,"type":"number"},"needle":{"description":"Search for a specific substring in the event.","properties":{"isRegex":{"type":"boolean"},"matchCase":{"type":"boolean"},"value":{"allOf":[{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},{"maxLength":1000,"type":"string"}]}},"required":["value"],"type":"object"},"timeframe":{"properties":{"from":{"type":"number"},"to":{"type":"number"}},"required":["to","from"],"type":"object"},"type":{"enum":["string","boolean","number"],"type":"string"}},"required":["timeframe","key","type","datasets"],"type":"object"}}},"description":"Get Values","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"enum":["Successful request"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"items":{"properties":{"dataset":{"type":"string"},"key":{"type":"string"},"type":{"enum":["string","boolean","number"],"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["key","type","value","dataset"],"type":"object"},"type":"array"},"success":{"enum":[true],"type":"boolean"}},"required":["messages","success","errors","result"],"type":"object"}}},"description":"Successful request"},"401":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Unauthorized"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"detail":{"type":"string"},"message":{"enum":["Internal error"],"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"success":{"enum":[false],"type":"boolean"}},"required":["errors","success","messages"],"type":"object"}}},"description":"Internal error"}},"summary":"List values","tags":["Values"],"x-api-token-group":["Workers Observability Write"]}},"/accounts/{account_id}/workers/scripts":{"get":{"description":"Fetch a list of uploaded workers.","operationId":"worker-script-list-workers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"description":"Filter scripts by tags. Format: comma-separated list of tag:allowed pairs where allowed is 'yes' or 'no'.","in":"query","name":"tags","schema":{"example":"production:yes,staging:no","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_script-response-collection"}}},"description":"List Workers response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"List Workers response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Workers","tags":["Worker Script"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]}},"/accounts/{account_id}/workers/scripts-search":{"get":{"description":"Search for Workers in an account.","operationId":"worker-script-search-workers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"query","name":"name","schema":{"description":"Worker name to search for. Both exact and partial matches are returned.","example":"my-worker","type":"string"}},{"in":"query","name":"id","schema":{"description":"Worker ID (also called tag) to search for. Only exact matches are returned.","example":"bdf3567828824b74aadd550004cf4913","type":"string"}},{"in":"query","name":"order_by","schema":{"default":"name","description":"Property to sort results by. Results are sorted in ascending order.","enum":["created_on","modified_on","name"],"example":"created_on","type":"string"}},{"description":"Current page.","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"Items per page.","in":"query","name":"per_page","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-collection"},{"properties":{"result":{"items":{"properties":{"created_on":{"$ref":"#/components/schemas/workers_created_on"},"environment_is_default":{"description":"Whether the environment is the default environment.","example":true,"type":"boolean"},"environment_name":{"description":"Name of the environment.","example":"production","type":"string"},"modified_on":{"$ref":"#/components/schemas/workers_modified_on"},"script_name":{"$ref":"#/components/schemas/workers_script_name"},"script_tag":{"$ref":"#/components/schemas/workers_identifier"},"service_name":{"description":"Name of the service.","example":"my-service","type":"string"}},"required":["script_tag","script_name","created_on","modified_on"],"type":"object"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"Search Workers success."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Search Workers failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Search Workers","tags":["Worker Script"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]}},"/accounts/{account_id}/workers/scripts/{script_name}":{"delete":{"description":"Delete your worker. This call has no response body on a successful delete.","operationId":"worker-script-delete-worker","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"description":"If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script.","in":"query","name":"force","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-null-result"}}},"description":"Delete Worker response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Delete Worker response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Worker","tags":["Worker Script"],"x-api-token-group":["Workers Scripts Write"]},"get":{"description":"Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.","operationId":"worker-script-download-worker","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/javascript":{"schema":{"example":"export default {\n  async fetch(request, env, ctx) {\n    return new Response(\"Hello, world!\");\n  }\n};\n","type":"string"}},"multipart/form-data":{"schema":{"additionalProperties":{"description":"Modules used by the Worker, including JavaScript files and source maps.","format":"binary","type":"string"},"type":"object"}}},"description":"Worker successfully downloaded. Returns script content as a multipart form, with no metadata part and no JSON encoding applied."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Download Worker response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Download Worker","tags":["Worker Script"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"put":{"description":"Upload a worker module. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.","operationId":"worker-script-upload-worker-module","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"$ref":"#/components/requestBodies/workers_script_upload"},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_script-response-upload-single"},{"example":{"errors":[],"messages":[],"result":{"created_on":"2022-05-05T05:15:11.602148Z","etag":"777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1","handlers":["fetch"],"id":"this-is_my_script-01","logpush":false,"modified_on":"2022-05-20T19:02:56.446492Z","placement_mode":"smart","startup_time_ms":10,"tail_consumers":[{"environment":"production","service":"my-log-consumer"}],"usage_model":"standard"},"success":true},"type":"object"}]}}},"description":"Upload Worker Module response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Upload Worker Module response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Upload Worker Module","tags":["Worker Script"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/scripts/{script_name}/assets-upload-session":{"post":{"description":"Start uploading a collection of assets for use in a Worker version. To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/.","operationId":"worker-script-update-create-assets-upload-session","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_create-assets-upload-session-object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_create-assets-upload-session-response"}}},"description":"Create Assets Upload Session response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_create-assets-upload-session-response"},{"$ref":"#/components/schemas/workers_api-response-common-failure"}]}}},"description":"Create Assets Upload Session response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Assets Upload Session","tags":["Worker Script"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/scripts/{script_name}/content":{"put":{"description":"Put script content without touching config or metadata.","operationId":"worker-script-put-content","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"description":"The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part.","in":"header","name":"CF-WORKER-BODY-PART","schema":{"type":"string"}},{"description":"The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part.","in":"header","name":"CF-WORKER-MAIN-MODULE-PART","schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"encoding":{"files":{"contentType":"application/javascript+module, text/javascript+module, application/javascript, text/javascript, text/x-python, text/x-python-requirement, application/wasm, text/plain, application/octet-stream, application/source-map"},"metadata":{"contentType":"application/json"}},"schema":{"properties":{"files":{"description":"An array of modules (often JavaScript files) comprising a Worker script. At least one module must be present and referenced in the metadata as `main_module` or `body_part` by filename.\u003cbr/\u003ePossible Content-Type(s) are: `application/javascript+module`, `text/javascript+module`, `application/javascript`, `text/javascript`, `text/x-python`, `text/x-python-requirement`, `application/wasm`, `text/plain`, `application/octet-stream`, `application/source-map`.","items":{"format":"binary","type":"string"},"type":"array","x-stainless-collection-type":"set"},"metadata":{"description":"JSON-encoded metadata about the uploaded parts and Worker configuration.","properties":{"body_part":{"description":"Name of the uploaded file that contains the Worker script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker.","example":"worker.js","type":"string"},"main_module":{"description":"Name of the uploaded file that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.","example":"worker.js","type":"string"}},"type":"object"}},"required":["metadata"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_script-response-single"}}},"description":"Put script content."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Put script content failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Put script content","tags":["Worker Script"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/scripts/{script_name}/content/v2":{"get":{"description":"Fetch script content only.","operationId":"worker-script-get-content","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"string":{"schema":{"example":"export default {\n  async fetch(request, env, ctx) {\n    return new Response(\"Hello, world!\");\n  }\n};\n","type":"string"}}},"description":"Fetch script content."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Fetch script content failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get script content","tags":["Worker Script"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]}},"/accounts/{account_id}/workers/scripts/{script_name}/deployments":{"get":{"description":"List of Worker Deployments. The first deployment in the list is the latest deployment actively serving traffic.","operationId":"worker-deployments-list-deployments","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"properties":{"deployments":{"items":{"$ref":"#/components/schemas/workers_deployment"},"type":"array"}},"required":["deployments"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"List Deployments response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"List Deployments response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Deployments","tags":["Worker Deployments"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"post":{"description":"Deployments configure how [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions) are deployed to traffic. A deployment can consist of one or two versions of a Worker.","operationId":"worker-deployments-create-deployment","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"description":"If set to true, the deployment will be created even if normally blocked by something such rolling back to an older version when a secret has changed.","in":"query","name":"force","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_deployment"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_deployment"}},"required":["result"],"type":"object"}]}}},"description":"Create Deployment response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Create Deployment response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Deployment","tags":["Worker Deployments"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/scripts/{script_name}/deployments/{deployment_id}":{"delete":{"description":"Delete a Worker Deployment. The latest deployment, which is actively serving traffic, cannot be deleted. All other deployments can be deleted.","operationId":"worker-deployments-delete-deployment","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"in":"path","name":"deployment_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common"}}},"description":"Delete Deployment response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Delete Deployment response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Deployment","tags":["Worker Deployments"],"x-api-token-group":["Workers Scripts Write"]},"get":{"description":"Get information about a Worker Deployment.","operationId":"worker-deployments-get-deployment","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"in":"path","name":"deployment_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_deployment"}},"required":["result"],"type":"object"}]}}},"description":"Get Deployment response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Get Deployment response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Deployment","tags":["Worker Deployments"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]}},"/accounts/{account_id}/workers/scripts/{script_name}/schedules":{"get":{"description":"Fetches Cron Triggers for a Worker.","operationId":"worker-cron-trigger-get-cron-triggers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"properties":{"schedules":{"items":{"$ref":"#/components/schemas/workers_schedule"},"type":"array"}},"required":["schedules"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"Get Cron Triggers response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Get Cron Triggers response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Cron Triggers","tags":["Worker Cron Trigger"],"x-api-token-group":["Workers Scripts Write","Workers Scripts Read"]},"put":{"description":"Updates Cron Triggers for a Worker.","operationId":"worker-cron-trigger-update-cron-triggers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/workers_schedule"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"properties":{"schedules":{"items":{"$ref":"#/components/schemas/workers_schedule"},"type":"array"}},"required":["schedules"],"type":"object"}},"required":["result"],"type":"object"}]}}},"description":"Update Cron Triggers response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Update Cron Triggers response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Cron Triggers","tags":["Worker Cron Trigger"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/scripts/{script_name}/script-settings":{"get":{"description":"Get script-level settings when using [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions). Includes Logpush and Tail Consumers.","operationId":"worker-script-settings-get-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_script-settings-response"}}},"description":"Fetch script settings."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Fetch script settings failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Script Settings","tags":["Worker Script"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"patch":{"description":"Patch script-level settings when using [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions). Including but not limited to Logpush and Tail Consumers.","operationId":"worker-script-settings-patch-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_script-settings-item"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_script-settings-response"}}},"description":"Patch script settings."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Patch script settings failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Script Settings","tags":["Worker Script"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/scripts/{script_name}/secrets":{"get":{"description":"List secrets bound to a script.","operationId":"worker-list-script-secrets","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers_secret"},"type":"array"}},"type":"object"}]}}},"description":"List script secrets."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"List script secrets failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List script secrets","tags":["Worker Script"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"put":{"description":"Add a secret to a script.","operationId":"worker-put-script-secret","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_secret"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_secret"}},"type":"object"}]}}},"description":"Put script secret binding success."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Put script secret binding failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Add script secret","tags":["Worker Script"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/scripts/{script_name}/secrets/{secret_name}":{"delete":{"description":"Remove a secret from a script.","operationId":"worker-delete-script-secret","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"in":"path","name":"secret_name","required":true,"schema":{"$ref":"#/components/schemas/workers_secret_name"}},{"in":"query","name":"url_encoded","schema":{"$ref":"#/components/schemas/workers_secret_name_url_encoded"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-null-result"}}},"description":"Delete script secret binding."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Delete script secret failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete script secret","tags":["Worker Script"],"x-api-token-group":["Workers Scripts Write"]},"get":{"description":"Get a given secret binding (value omitted) on a script.","operationId":"worker-get-script-secret","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"in":"path","name":"secret_name","required":true,"schema":{"$ref":"#/components/schemas/workers_secret_name"}},{"in":"query","name":"url_encoded","schema":{"$ref":"#/components/schemas/workers_secret_name_url_encoded"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_secret"}},"type":"object"}]}}},"description":"Get script secret binding."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Get script secret failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get secret binding","tags":["Worker Script"]}},"/accounts/{account_id}/workers/scripts/{script_name}/settings":{"get":{"description":"Get metadata and config, such as bindings or usage model.","operationId":"worker-script-get-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_script-and-version-settings-response"}}},"description":"Fetch settings."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Fetch settings failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Settings","tags":["Worker Script"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"patch":{"description":"Patch metadata or config, such as bindings or usage model.","operationId":"worker-script-patch-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"content":{"multipart/form-data":{"encoding":{"settings":{"contentType":"application/json"}},"schema":{"properties":{"settings":{"$ref":"#/components/schemas/workers_script-and-version-settings-item"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_script-and-version-settings-response"}}},"description":"Patch settings."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Patch settings failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Settings","tags":["Worker Script"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/scripts/{script_name}/subdomain":{"delete":{"description":"Disable all workers.dev subdomains for a Worker.","operationId":"worker-script-delete-subdomain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_subdomain"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Delete subdomain response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Delete subdomain response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Worker subdomain","tags":["Worker Script"],"x-api-token-group":["Workers Scripts Write"]},"get":{"description":"Get if the Worker is available on the workers.dev subdomain.","operationId":"worker-script-get-subdomain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_subdomain"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Get subdomain response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Get subdomain response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Worker subdomain","tags":["Worker Script"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"post":{"description":"Enable or disable the Worker on the workers.dev subdomain.","operationId":"worker-script-post-subdomain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"enabled":{"description":"Whether the Worker should be available on the workers.dev subdomain.","example":true,"type":"boolean","x-auditable":true},"previews_enabled":{"description":"Whether the Worker's Preview URLs should be available on the workers.dev subdomain.","example":false,"type":"boolean","x-auditable":true,"x-stainless-terraform-configurability":"computed_optional"}},"required":["enabled"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_subdomain"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Post subdomain response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Post subdomain response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Post Worker subdomain","tags":["Worker Script"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/scripts/{script_name}/tails":{"get":{"description":"Get list of tails currently deployed on a Worker.","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_tail"}},"required":["result"],"type":"object"}]}}},"description":"List Tails response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"List Tails response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Tails","tags":["Worker Tail Logs"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write"]},"post":{"description":"Starts a tail that receives logs and exception from a Worker.","operationId":"worker-tail-logs-start-tail","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_tail"}},"required":["result"],"type":"object"}]}}},"description":"Start Tail response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Start Tail response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Start Tail","tags":["Worker Tail Logs"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write"]}},"/accounts/{account_id}/workers/scripts/{script_name}/tails/{id}":{"delete":{"description":"Deletes a tail from a Worker.","operationId":"worker-tail-logs-delete-tail","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}},{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common"}}},"description":"Delete Tail response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Delete Tail response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Tail","tags":["Worker Tail Logs"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write"]}},"/accounts/{account_id}/workers/scripts/{script_name}/usage-model":{"get":{"description":"Fetches the Usage Model for a given Worker.","operationId":"worker-script-fetch-usage-model","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_usage-model-response"}}},"description":"Fetch Usage Model response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Fetch Usage Model response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Fetch Usage Model","tags":["Worker Script"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"put":{"description":"Updates the Usage Model for a given Worker. Requires a Workers Paid subscription.","operationId":"worker-script-update-usage-model","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_script_name"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"usage_model":{"$ref":"#/components/schemas/workers_usage_model"},"user_limits":{"$ref":"#/components/schemas/workers_user_limits"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_usage-model-response"}}},"description":"Update Usage Model response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Update Usage Model response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Usage Model","tags":["Worker Script"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/scripts/{script_name}/versions":{"get":{"description":"List of Worker Versions. The first version in the list is the latest version.","operationId":"worker-versions-list-versions","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_schemas-script_name"}},{"description":"Only return versions that can be used in a deployment. Ignores pagination.","in":"query","name":"deployable","schema":{"default":false,"type":"boolean"}},{"description":"Current page.","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"Items per-page.","in":"query","name":"per_page","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_versions-list-response"}}},"description":"List Versions response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_versions-list-response"},{"$ref":"#/components/schemas/workers_api-response-common-failure"}]}}},"description":"List Versions response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Versions","tags":["Worker Versions"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"post":{"description":"Upload a Worker Version without deploying to Cloudflare's network. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.","operationId":"worker-versions-upload-version","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_schemas-script_name"}}],"requestBody":{"$ref":"#/components/requestBodies/workers_version-post"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_versions-upload-response"}}},"description":"Upload Version response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_versions-upload-response"},{"$ref":"#/components/schemas/workers_api-response-common-failure"}]}}},"description":"Upload Version response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Upload Version","tags":["Worker Versions"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/scripts/{script_name}/versions/{version_id}":{"get":{"operationId":"worker-versions-get-version-detail","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/workers_schemas-script_name"}},{"in":"path","name":"version_id","required":true,"schema":{"$ref":"#/components/schemas/workers_version_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_versions-single-response"}}},"description":"Get Version Detail response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_versions-single-response"},{"$ref":"#/components/schemas/workers_api-response-common-failure"}]}}},"description":"Get Version Detail response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Version Detail","tags":["Worker Versions"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]}},"/accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/content":{"get":{"description":"Get script content from a worker with an environment.","operationId":"worker-environment-get-script-content","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"service_name","required":true,"schema":{"$ref":"#/components/schemas/workers_service"}},{"in":"path","name":"environment_name","required":true,"schema":{"$ref":"#/components/schemas/workers_environment"}}],"responses":{"200":{"content":{"string":{"schema":{"example":"export default {\n  async fetch(request, env, ctx) {\n    return new Response(\"Hello, world!\");\n  }\n};\n","type":"string"}}},"description":"Get script content."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Get script content failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get script content","tags":["Worker Environment"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"put":{"description":"Put script content from a worker with an environment.","operationId":"worker-environment-put-script-content","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"service_name","required":true,"schema":{"$ref":"#/components/schemas/workers_service"}},{"in":"path","name":"environment_name","required":true,"schema":{"$ref":"#/components/schemas/workers_environment"}},{"description":"The multipart name of a script upload part containing script content in service worker format. Alternative to including in a metadata part.","in":"header","name":"CF-WORKER-BODY-PART","schema":{"type":"string"}},{"description":"The multipart name of a script upload part containing script content in es module format. Alternative to including in a metadata part.","in":"header","name":"CF-WORKER-MAIN-MODULE-PART","schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"encoding":{"files":{"contentType":"application/javascript+module, text/javascript+module, application/javascript, text/javascript, text/x-python, text/x-python-requirement, application/wasm, text/plain, application/octet-stream, application/source-map"},"metadata":{"contentType":"application/json"}},"schema":{"properties":{"files":{"description":"An array of modules (often JavaScript files) comprising a Worker script. At least one module must be present and referenced in the metadata as `main_module` or `body_part` by filename.\u003cbr/\u003ePossible Content-Type(s) are: `application/javascript+module`, `text/javascript+module`, `application/javascript`, `text/javascript`, `text/x-python`, `text/x-python-requirement`, `application/wasm`, `text/plain`, `application/octet-stream`, `application/source-map`.","items":{"format":"binary","type":"string"},"type":"array","x-stainless-collection-type":"set"},"metadata":{"description":"JSON-encoded metadata about the uploaded parts and Worker configuration.","properties":{"body_part":{"description":"Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the `fetch` event). Indicates a `service worker syntax` Worker.","example":"worker.js","type":"string"},"main_module":{"description":"Name of the part in the multipart request that contains the main module (e.g. the file exporting a `fetch` handler). Indicates a `module syntax` Worker.","example":"worker.js","type":"string"}},"type":"object"}},"required":["metadata"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_script-response-single"}}},"description":"Put script content."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Put script content failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Put script content","tags":["Worker Environment"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/services/{service_name}/environments/{environment_name}/settings":{"get":{"description":"Get script settings from a worker with an environment.","operationId":"worker-script-environment-get-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"service_name","required":true,"schema":{"$ref":"#/components/schemas/workers_service"}},{"in":"path","name":"environment_name","required":true,"schema":{"$ref":"#/components/schemas/workers_environment"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_script-settings-response"}}},"description":"Fetch script settings."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Fetch script settings failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Script Settings","tags":["Worker Environment"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"patch":{"description":"Patch script metadata, such as bindings.","operationId":"worker-script-environment-patch-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"service_name","required":true,"schema":{"$ref":"#/components/schemas/workers_service"}},{"in":"path","name":"environment_name","required":true,"schema":{"$ref":"#/components/schemas/workers_environment"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_script-settings-response"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_script-settings-response"}}},"description":"Patch script settings."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Patch script settings failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Script Settings","tags":["Worker Environment"]}},"/accounts/{account_id}/workers/subdomain":{"delete":{"description":"Deletes a Workers subdomain for an account.","operationId":"worker-subdomain-delete-subdomain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"responses":{"204":{"description":"Subdomain deleted successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Delete Subdomain response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Subdomain","tags":["Worker Subdomain"],"x-api-token-group":["Workers Scripts Write"]},"get":{"description":"Returns a Workers subdomain for an account.","operationId":"worker-subdomain-get-subdomain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_schemas-subdomain"}},"required":["result"],"type":"object"}]}}},"description":"Get Subdomain response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Get Subdomain response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Subdomain","tags":["Worker Subdomain"],"x-api-token-group":["Workers Scripts Write","Workers Scripts Read"]},"put":{"description":"Creates a Workers subdomain for an account.","operationId":"worker-subdomain-create-subdomain","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_schemas-subdomain"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_schemas-subdomain"}},"required":["result"],"type":"object"}]}}},"description":"Create Subdomain response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Create Subdomain response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Subdomain","tags":["Worker Subdomain"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/workers":{"get":{"description":"List all Workers for an account.","operationId":"listWorkers","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"description":"Current page.","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"Items per-page.","in":"query","name":"per_page","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers_Worker"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"List Workers success."},"401":{"$ref":"#/components/responses/workers_ErrorAuth"},"500":{"$ref":"#/components/responses/workers_ErrorInternalServer"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Workers","tags":["Workers"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"post":{"description":"Create a new Worker.","operationId":"createWorker","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_Worker"},{"required":["name"],"type":"object"}]}}},"description":"Worker creation parameters.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_Worker"}},"required":["result"],"type":"object"}]}}},"description":"Create Worker success."},"400":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"discriminator":{"mapping":{"100102":"#/components/schemas/workers_ErrorWorkerTagLengthLimit","100132":"#/components/schemas/workers_ErrorWorkerNameSubdomainLengthLimit","100134":"#/components/schemas/workers_ErrorWorkerTagInvalid","10016":"#/components/schemas/workers_ErrorWorkerNameInvalid","10021":"#/components/schemas/workers_ErrorWorkerInvalid","100308":"#/components/schemas/workers_ErrorWorkerObservabilitySamplingRateInvalid","100315":"#/components/schemas/workers_ErrorWorkerNamePreviewLengthLimit"},"propertyName":"code"},"oneOf":[{"$ref":"#/components/schemas/workers_ErrorWorkerNameInvalid"},{"$ref":"#/components/schemas/workers_ErrorWorkerInvalid"},{"$ref":"#/components/schemas/workers_ErrorWorkerTagLengthLimit"},{"$ref":"#/components/schemas/workers_ErrorWorkerNameSubdomainLengthLimit"},{"$ref":"#/components/schemas/workers_ErrorWorkerTagInvalid"},{"$ref":"#/components/schemas/workers_ErrorWorkerObservabilitySamplingRateInvalid"},{"$ref":"#/components/schemas/workers_ErrorWorkerNamePreviewLengthLimit"}],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Bad Request - Invalid input data."},"401":{"$ref":"#/components/responses/workers_ErrorAuth"},"403":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"discriminator":{"mapping":{"100103":"#/components/schemas/workers_ErrorWorkerTagLimit","10037":"#/components/schemas/workers_ErrorWorkerLimit"},"propertyName":"code"},"oneOf":[{"$ref":"#/components/schemas/workers_ErrorWorkerLimit"},{"$ref":"#/components/schemas/workers_ErrorWorkerTagLimit"}],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Forbidden - Access denied or limit exceeded."},"409":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"discriminator":{"mapping":{"10040":"#/components/schemas/workers_ErrorWorkerNameConflict"},"propertyName":"code"},"oneOf":[{"$ref":"#/components/schemas/workers_ErrorWorkerNameConflict"}],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Conflict - Resource already exists."},"500":{"$ref":"#/components/responses/workers_ErrorInternalServer"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Worker","tags":["Workers"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/workers/{worker_id}":{"delete":{"description":"Delete a Worker and all its associated resources (versions, deployments, etc.).","operationId":"deleteWorker","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"worker_id","required":true,"schema":{"description":"Identifier for the Worker, which can be ID or name.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common"}}},"description":"Delete Worker success."},"400":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"discriminator":{"mapping":{"10003":"#/components/schemas/workers_ErrorMissingParam"},"propertyName":"code"},"oneOf":[{"$ref":"#/components/schemas/workers_ErrorMissingParam"}],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Bad Request - Missing or invalid parameters."},"401":{"$ref":"#/components/responses/workers_ErrorAuth"},"404":{"$ref":"#/components/responses/workers_ErrorWorkerNotFound"},"500":{"$ref":"#/components/responses/workers_ErrorInternalServer"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Worker","tags":["Workers"],"x-api-token-group":["Workers Scripts Write"]},"get":{"description":"Get details about a specific Worker.","operationId":"getWorker","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"worker_id","required":true,"schema":{"description":"Identifier for the Worker, which can be ID or name.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_Worker"}},"required":["result"],"type":"object"}]}}},"description":"Get Worker success."},"400":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"discriminator":{"mapping":{"10003":"#/components/schemas/workers_ErrorMissingParam"},"propertyName":"code"},"oneOf":[{"$ref":"#/components/schemas/workers_ErrorMissingParam"}],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Bad Request - Missing or invalid parameters."},"404":{"$ref":"#/components/responses/workers_ErrorWorkerNotFound"},"500":{"$ref":"#/components/responses/workers_ErrorInternalServer"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Worker","tags":["Workers"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"patch":{"description":"Perform a partial update on a Worker, where omitted properties are left unchanged from their current values.","operationId":"editWorker","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"worker_id","required":true,"schema":{"description":"Identifier for the Worker, which can be ID or name.","type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_Worker"},{"type":"object"}]}}},"description":"Worker partial update parameters.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_Worker"}},"required":["result"],"type":"object"}]}}},"description":"Partially Update Worker success."},"400":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"discriminator":{"mapping":{"10003":"#/components/schemas/workers_ErrorMissingParam","100102":"#/components/schemas/workers_ErrorWorkerTagLengthLimit","100132":"#/components/schemas/workers_ErrorWorkerNameSubdomainLengthLimit","100134":"#/components/schemas/workers_ErrorWorkerTagInvalid","10016":"#/components/schemas/workers_ErrorWorkerNameInvalid","10021":"#/components/schemas/workers_ErrorWorkerInvalid","100308":"#/components/schemas/workers_ErrorWorkerObservabilitySamplingRateInvalid","100315":"#/components/schemas/workers_ErrorWorkerNamePreviewLengthLimit"},"propertyName":"code"},"oneOf":[{"$ref":"#/components/schemas/workers_ErrorMissingParam"},{"$ref":"#/components/schemas/workers_ErrorWorkerNameInvalid"},{"$ref":"#/components/schemas/workers_ErrorWorkerInvalid"},{"$ref":"#/components/schemas/workers_ErrorWorkerTagLengthLimit"},{"$ref":"#/components/schemas/workers_ErrorWorkerTagInvalid"},{"$ref":"#/components/schemas/workers_ErrorWorkerNameSubdomainLengthLimit"},{"$ref":"#/components/schemas/workers_ErrorWorkerNamePreviewLengthLimit"},{"$ref":"#/components/schemas/workers_ErrorWorkerObservabilitySamplingRateInvalid"}],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Bad Request - Invalid input data."},"401":{"$ref":"#/components/responses/workers_ErrorAuth"},"403":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"discriminator":{"mapping":{"100103":"#/components/schemas/workers_ErrorWorkerTagLimit","10037":"#/components/schemas/workers_ErrorWorkerLimit"},"propertyName":"code"},"oneOf":[{"$ref":"#/components/schemas/workers_ErrorWorkerLimit"},{"$ref":"#/components/schemas/workers_ErrorWorkerTagLimit"}],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Forbidden - Insufficient permissions or quota exceeded."},"404":{"$ref":"#/components/responses/workers_ErrorWorkerNotFound"},"409":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"discriminator":{"mapping":{"10040":"#/components/schemas/workers_ErrorWorkerNameConflict"},"propertyName":"code"},"oneOf":[{"$ref":"#/components/schemas/workers_ErrorWorkerNameConflict"}],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Conflict - Worker name already exists."},"500":{"$ref":"#/components/responses/workers_ErrorInternalServer"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Edit Worker","tags":["Workers"]},"put":{"description":"Perform a complete replacement of a Worker, where omitted properties are set to their default values. This is the exact same as the Create Worker endpoint, but operates on an existing Worker. To perform a partial update instead, use the Edit Worker endpoint.","operationId":"updateWorker","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"worker_id","required":true,"schema":{"description":"Identifier for the Worker, which can be ID or name.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_Worker"},{"required":["name"],"type":"object"}]}}},"description":"Worker update parameters.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_Worker"}},"required":["result"],"type":"object"}]}}},"description":"Update Worker success."},"400":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"discriminator":{"mapping":{"10003":"#/components/schemas/workers_ErrorMissingParam","100102":"#/components/schemas/workers_ErrorWorkerTagLengthLimit","100132":"#/components/schemas/workers_ErrorWorkerNameSubdomainLengthLimit","100134":"#/components/schemas/workers_ErrorWorkerTagInvalid","10016":"#/components/schemas/workers_ErrorWorkerNameInvalid","10021":"#/components/schemas/workers_ErrorWorkerInvalid","100308":"#/components/schemas/workers_ErrorWorkerObservabilitySamplingRateInvalid","100315":"#/components/schemas/workers_ErrorWorkerNamePreviewLengthLimit"},"propertyName":"code"},"oneOf":[{"$ref":"#/components/schemas/workers_ErrorMissingParam"},{"$ref":"#/components/schemas/workers_ErrorWorkerNameInvalid"},{"$ref":"#/components/schemas/workers_ErrorWorkerInvalid"},{"$ref":"#/components/schemas/workers_ErrorWorkerTagLengthLimit"},{"$ref":"#/components/schemas/workers_ErrorWorkerTagInvalid"},{"$ref":"#/components/schemas/workers_ErrorWorkerNameSubdomainLengthLimit"},{"$ref":"#/components/schemas/workers_ErrorWorkerNamePreviewLengthLimit"},{"$ref":"#/components/schemas/workers_ErrorWorkerObservabilitySamplingRateInvalid"}],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Bad Request - Invalid input data."},"401":{"$ref":"#/components/responses/workers_ErrorAuth"},"403":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"discriminator":{"mapping":{"100103":"#/components/schemas/workers_ErrorWorkerTagLimit","10037":"#/components/schemas/workers_ErrorWorkerLimit"},"propertyName":"code"},"oneOf":[{"$ref":"#/components/schemas/workers_ErrorWorkerLimit"},{"$ref":"#/components/schemas/workers_ErrorWorkerTagLimit"}],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Forbidden - Insufficient permissions or quota exceeded."},"404":{"$ref":"#/components/responses/workers_ErrorWorkerNotFound"},"409":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common-failure"},{"properties":{"errors":{"items":{"discriminator":{"mapping":{"10040":"#/components/schemas/workers_ErrorWorkerNameConflict"},"propertyName":"code"},"oneOf":[{"$ref":"#/components/schemas/workers_ErrorWorkerNameConflict"}],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}]}}},"description":"Conflict - Worker name already exists."},"500":{"$ref":"#/components/responses/workers_ErrorInternalServer"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Worker","tags":["Workers"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/workers/{worker_id}/versions":{"get":{"description":"List all versions for a Worker.","operationId":"listWorkerVersions","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"worker_id","required":true,"schema":{"description":"Identifier for the Worker, which can be ID or name.","type":"string"}},{"description":"Current page.","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"}},{"description":"Items per-page.","in":"query","name":"per_page","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers_Version"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"List versions success."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"List versions failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Versions","tags":["Versions"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]},"post":{"description":"Create a new version.","operationId":"createWorkerVersion","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"worker_id","required":true,"schema":{"description":"Identifier for the Worker, which can be ID or name.","type":"string"}},{"in":"query","name":"deploy","schema":{"description":"If true, a deployment will be created that sends 100% of traffic to the new version.","type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_Version"}}},"description":"Version creation parameters.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_Version"}},"required":["result"],"type":"object"}]}}},"description":"Create version success."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Create version failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Version","tags":["Versions"],"x-api-token-group":["Workers Scripts Write"]}},"/accounts/{account_id}/workers/workers/{worker_id}/versions/{version_id}":{"delete":{"description":"Delete a version.","operationId":"deleteWorkerVersion","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"worker_id","required":true,"schema":{"description":"Identifier for the Worker, which can be ID or name.","type":"string"}},{"in":"path","name":"version_id","required":true,"schema":{"description":"Identifier for the version, which can be ID or the literal \"latest\" to operate on the most recently created version.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common"}}},"description":"Delete version success."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Delete version failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Version","tags":["Versions"]},"get":{"description":"Get details about a specific version.","operationId":"getWorkerVersion","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"worker_id","required":true,"schema":{"description":"Identifier for the Worker, which can be ID or name.","type":"string"}},{"in":"path","name":"version_id","required":true,"schema":{"description":"Identifier for the version, which can be ID or the literal \"latest\" to operate on the most recently created version.","type":"string"}},{"in":"query","name":"include","schema":{"description":"Whether to include the `modules` property of the version in the response, which contains code and sourcemap content and may add several megabytes to the response size.","enum":["modules"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_Version"}},"required":["result"],"type":"object"}]}}},"description":"Get version success."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Get version failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Version","tags":["Versions"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"]}},"/accounts/{account_id}/workflows":{"get":{"operationId":"wor-list-workflows","parameters":[{"in":"query","name":"per_page","schema":{"default":10,"maximum":100,"minimum":1,"type":"number"}},{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"number"}},{"description":"Allows filtering workflows` name.","in":"query","name":"search","schema":{"description":"Allows filtering workflows` name.","maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"items":{"properties":{"class_name":{"type":"string"},"created_on":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"instances":{"properties":{"complete":{"type":"number"},"errored":{"type":"number"},"paused":{"type":"number"},"queued":{"type":"number"},"running":{"type":"number"},"terminated":{"type":"number"},"waiting":{"type":"number"},"waitingForPause":{"type":"number"}},"type":"object"},"modified_on":{"format":"date-time","type":"string"},"name":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"},"script_name":{"type":"string"},"triggered_on":{"format":"date-time","nullable":true,"type":"string"}},"required":["name","id","created_on","modified_on","script_name","class_name","triggered_on","instances"],"type":"object"},"type":"array"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","result","messages"],"type":"object"}}},"description":"List of all Workflows belonging to a account."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Input Validation Error."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List all Workflows","tags":["Workflows"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/workflows/{workflow_name}":{"delete":{"description":"Deletes a Workflow. This only deletes the Workflow and does not delete or modify any Worker associated to this Workflow or bounded to it.","operationId":"wor-delete-workflow","parameters":[{"in":"path","name":"workflow_name","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"properties":{"status":{"enum":["ok"],"type":"string"},"success":{"nullable":true,"type":"boolean"}},"required":["success","status"],"type":"object"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","result","messages"],"type":"object"}}},"description":"Deletes a Workflow."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Workflow has no deployed versions."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Workflow not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Deletes a Workflow","tags":["Workflows"],"x-api-token-group":["Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"wor-get-workflow-details","parameters":[{"in":"path","name":"workflow_name","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"properties":{"class_name":{"type":"string"},"created_on":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"instances":{"properties":{"complete":{"type":"number"},"errored":{"type":"number"},"paused":{"type":"number"},"queued":{"type":"number"},"running":{"type":"number"},"terminated":{"type":"number"},"waiting":{"type":"number"},"waitingForPause":{"type":"number"}},"type":"object"},"modified_on":{"format":"date-time","type":"string"},"name":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"},"script_name":{"type":"string"},"triggered_on":{"format":"date-time","nullable":true,"type":"string"}},"required":["name","id","created_on","modified_on","script_name","class_name","triggered_on","instances"],"type":"object"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","result","messages"],"type":"object"}}},"description":"Get Workflow details."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Workflow has no deployed versions."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Workflow not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Workflow details","tags":["Workflows"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"operationId":"wor-create-or-modify-workflow","parameters":[{"in":"path","name":"workflow_name","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"class_name":{"maxLength":255,"minLength":1,"type":"string"},"script_name":{"maxLength":255,"minLength":1,"type":"string"}},"required":["script_name","class_name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"properties":{"class_name":{"type":"string"},"created_on":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"is_deleted":{"type":"number"},"modified_on":{"format":"date-time","type":"string"},"name":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"},"script_name":{"type":"string"},"terminator_running":{"type":"number"},"triggered_on":{"format":"date-time","nullable":true,"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["version_id","name","id","created_on","modified_on","script_name","class_name","triggered_on","is_deleted","terminator_running"],"type":"object"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","result","messages"],"type":"object"}}},"description":"Create/modify a Workflow based on a deployed script with an existing `WorkflowEntrypoint` class. Must be done after deploying the corresponding script."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create/modify Workflow","tags":["Workflows"],"x-api-token-group":["Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/workflows/{workflow_name}/instances":{"get":{"operationId":"wor-list-workflow-instances","parameters":[{"in":"path","name":"workflow_name","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"description":"`page` and `cursor` are mutually exclusive, use one or the other.","in":"query","name":"page","schema":{"description":"`page` and `cursor` are mutually exclusive, use one or the other.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":50,"maximum":100,"minimum":1,"type":"number"}},{"description":"`page` and `cursor` are mutually exclusive, use one or the other.","in":"query","name":"cursor","schema":{"description":"`page` and `cursor` are mutually exclusive, use one or the other.","type":"string"}},{"description":"should only be used when `cursor` is used, defines a new direction for the cursor","in":"query","name":"direction","schema":{"description":"should only be used when `cursor` is used, defines a new direction for the cursor","enum":["asc","desc"],"type":"string"}},{"in":"query","name":"status","schema":{"enum":["queued","running","paused","errored","terminated","complete","waitingForPause","waiting"],"type":"string"}},{"description":"Accepts ISO 8601 with no timezone offsets and in UTC.","in":"query","name":"date_start","schema":{"description":"Accepts ISO 8601 with no timezone offsets and in UTC.","format":"date-time","type":"string"}},{"description":"Accepts ISO 8601 with no timezone offsets and in UTC.","in":"query","name":"date_end","schema":{"description":"Accepts ISO 8601 with no timezone offsets and in UTC.","format":"date-time","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"items":{"properties":{"created_on":{"format":"date-time","type":"string"},"ended_on":{"format":"date-time","nullable":true,"type":"string"},"id":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"},"modified_on":{"format":"date-time","type":"string"},"started_on":{"format":"date-time","nullable":true,"type":"string"},"status":{"enum":["queued","running","paused","errored","terminated","complete","waitingForPause","waiting"],"type":"string"},"version_id":{"format":"uuid","type":"string"},"workflow_id":{"format":"uuid","type":"string"}},"required":["id","created_on","modified_on","started_on","ended_on","workflow_id","version_id","status"],"type":"object"},"type":"array"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","result","messages"],"type":"object"}}},"description":"List of workflow instances."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Input Validation Error."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Workflow Name not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List of workflow instances","tags":["Workflows"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"wor-create-new-workflow-instance","parameters":[{"in":"path","name":"workflow_name","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"instance_id":{"maximum":100,"minimum":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"},"instance_retention":{"type":"object"},"params":{"type":"object"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"properties":{"id":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"},"status":{"enum":["queued","running","paused","errored","terminated","complete","waitingForPause","waiting"],"type":"string"},"version_id":{"format":"uuid","type":"string"},"workflow_id":{"format":"uuid","type":"string"}},"required":["id","workflow_id","version_id","status"],"type":"object"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","result","messages"],"type":"object"}}},"description":"Create workflow instance. Body is a JSON parsable string that it's passed into the new instance as the event payload."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Provided Workflow ID is not valid."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Workflow Name not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a new workflow instance","tags":["Workflows"],"x-api-token-group":["Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/workflows/{workflow_name}/instances/batch":{"post":{"operationId":"wor-batch-create-workflow-instance","parameters":[{"in":"path","name":"workflow_name","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"properties":{"instance_id":{"maximum":100,"minimum":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"},"instance_retention":{"type":"object"},"params":{"type":"object"}},"type":"object"},"maxItems":100,"minItems":1,"type":"array"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"items":{"properties":{"id":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"},"status":{"enum":["queued","running","paused","errored","terminated","complete","waitingForPause","waiting"],"type":"string"},"version_id":{"format":"uuid","type":"string"},"workflow_id":{"format":"uuid","type":"string"}},"required":["id","workflow_id","version_id","status"],"type":"object"},"type":"array"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","result","messages"],"type":"object"}}},"description":"Batch create workflow instances. Body is a JSON list that contain all payloads and ids that are passed into the new instance as the event payload."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Provided Workflow ID is not valid."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Workflow Name not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Batch create new Workflow instances","tags":["Workflows"],"x-api-token-group":["Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/workflows/{workflow_name}/instances/batch/terminate":{"post":{"operationId":"wor-batch-terminate-workflow-instances","parameters":[{"in":"path","name":"workflow_name","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"maximum":100,"minimum":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"},"maxItems":100,"minItems":1,"type":"array"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"properties":{"instancesTerminated":{"type":"number"},"status":{"enum":["ok","already_running"],"type":"string"}},"required":["status","instancesTerminated"],"type":"object"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","result","messages"],"type":"object"}}},"description":"Batch terminate instances of a workflow, via a async job. Body is a JSON list that contain the ids of the instances to terminate."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Provided Workflow ID is not valid."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Workflow Name not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Batch terminate instances of a workflow","tags":["Workflows"],"x-api-token-group":["Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/workflows/{workflow_name}/instances/terminate":{"get":{"operationId":"wor-status-terminate-workflow-instances","parameters":[{"in":"path","name":"workflow_name","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"properties":{"status":{"enum":["running","not_running"],"type":"string"}},"required":["status"],"type":"object"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","result","messages"],"type":"object"}}},"description":"Get status of the job responsible for terminate all instances of a workflow."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Input Validation Error."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Workflow Name not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get status of the job responsible for terminate all instances of a workflow","tags":["Workflows"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}":{"get":{"operationId":"wor-describe-workflow-instance","parameters":[{"in":"path","name":"workflow_name","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"instance_id","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"properties":{"end":{"format":"date-time","nullable":true,"type":"string"},"error":{"nullable":true,"properties":{"message":{"type":"string"},"name":{"type":"string"}},"required":["name","message"],"type":"object"},"output":{"anyOf":[{"type":"string"},{"type":"number"}]},"params":{"type":"object"},"queued":{"format":"date-time","type":"string"},"start":{"format":"date-time","nullable":true,"type":"string"},"status":{"enum":["queued","running","paused","errored","terminated","complete","waitingForPause","waiting"],"type":"string"},"steps":{"items":{"anyOf":[{"properties":{"attempts":{"items":{"properties":{"end":{"format":"date-time","nullable":true,"type":"string"},"error":{"nullable":true,"properties":{"message":{"type":"string"},"name":{"type":"string"}},"required":["name","message"],"type":"object"},"start":{"format":"date-time","type":"string"},"success":{"nullable":true,"type":"boolean"}},"required":["start","end","success","error"],"type":"object"},"type":"array"},"config":{"properties":{"retries":{"properties":{"backoff":{"enum":["constant","linear","exponential"],"type":"string"},"delay":{"anyOf":[{},{"type":"number"}]},"limit":{"type":"number"}},"required":["limit","delay"],"type":"object"},"timeout":{"anyOf":[{},{"type":"number"}]}},"required":["retries","timeout"],"type":"object"},"end":{"format":"date-time","nullable":true,"type":"string"},"name":{"type":"string"},"output":{"type":"object"},"start":{"format":"date-time","type":"string"},"success":{"nullable":true,"type":"boolean"},"type":{"enum":["step"],"type":"string"}},"required":["name","start","end","attempts","config","output","success","type"],"type":"object"},{"properties":{"end":{"format":"date-time","type":"string"},"error":{"nullable":true,"properties":{"message":{"type":"string"},"name":{"type":"string"}},"required":["name","message"],"type":"object"},"finished":{"type":"boolean"},"name":{"type":"string"},"start":{"format":"date-time","type":"string"},"type":{"enum":["sleep"],"type":"string"}},"required":["name","start","end","finished","type","error"],"type":"object"},{"properties":{"trigger":{"properties":{"source":{"type":"string"}},"required":["source"],"type":"object"},"type":{"enum":["termination"],"type":"string"}},"required":["type","trigger"],"type":"object"},{"properties":{"end":{"format":"date-time","type":"string"},"error":{"nullable":true,"properties":{"message":{"type":"string"},"name":{"type":"string"}},"required":["name","message"],"type":"object"},"finished":{"type":"boolean"},"name":{"type":"string"},"output":{"anyOf":[{"type":"object"},{"type":"string"},{"type":"number"},{"type":"boolean"}]},"start":{"format":"date-time","type":"string"},"type":{"enum":["waitForEvent"],"type":"string"}},"required":["name","start","end","finished","type","output","error"],"type":"object"}]},"type":"array"},"success":{"nullable":true,"type":"boolean"},"trigger":{"properties":{"source":{"enum":["unknown","api","binding","event","cron"],"type":"string"}},"required":["source"],"type":"object"},"versionId":{"format":"uuid","type":"string"}},"required":["params","trigger","versionId","queued","start","end","steps","success","error","status","output"],"type":"object"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","result","messages"],"type":"object"}}},"description":"Get all logs and status from the instance."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Bad Request."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Instance not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get logs and status from instance","tags":["Workflows"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/events/{event_type}":{"post":{"operationId":"wor-send-event-workflow-instance","parameters":[{"in":"path","name":"workflow_name","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"instance_id","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"event_type","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"type":"object"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages"],"type":"object"}}},"description":"Send an event to an instance."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Bad Request."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Workflow not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Send event to instance","tags":["Workflows"],"x-api-token-group":["Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status":{"patch":{"operationId":"wor-change-status-workflow-instance","parameters":[{"in":"path","name":"workflow_name","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"instance_id","required":true,"schema":{"maxLength":100,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"status":{"description":"Apply action to instance.","enum":["resume","pause","terminate","restart"],"type":"string"}},"required":["status"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"properties":{"status":{"enum":["queued","running","paused","errored","terminated","complete","waitingForPause","waiting"],"type":"string"},"timestamp":{"description":"Accepts ISO 8601 with no timezone offsets and in UTC.","format":"date-time","type":"string"}},"required":["status","timestamp"],"type":"object"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","result","messages"],"type":"object"}}},"description":"Change status of instance - it can be paused, resumed or terminated."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Bad Request."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Instance not found."},"409":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Instance not in a restartable state."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Change status of instance","tags":["Workflows"],"x-api-token-group":["Workers Scripts Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/workflows/{workflow_name}/versions":{"get":{"operationId":"wor-list-workflow-versions","parameters":[{"in":"path","name":"workflow_name","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"query","name":"per_page","schema":{"default":50,"maximum":100,"minimum":1,"type":"number"}},{"in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"number"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"items":{"properties":{"class_name":{"type":"string"},"created_on":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"modified_on":{"format":"date-time","type":"string"},"workflow_id":{"format":"uuid","type":"string"}},"required":["created_on","modified_on","id","workflow_id","class_name"],"type":"object"},"type":"array"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","result","messages"],"type":"object"}}},"description":"List deployed workflow versions."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Bad Request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List deployed Workflow versions","tags":["Workflows"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}":{"get":{"operationId":"wor-describe-workflow-versions","parameters":[{"in":"path","name":"workflow_name","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9-_]*$","type":"string"}},{"in":"path","name":"version_id","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"result":{"properties":{"class_name":{"type":"string"},"created_on":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"modified_on":{"format":"date-time","type":"string"},"workflow_id":{"format":"uuid","type":"string"}},"required":["created_on","modified_on","id","workflow_id","class_name"],"type":"object"},"result_info":{"properties":{"count":{"type":"number"},"cursor":{"type":"string"},"page":{"type":"number"},"per_page":{"type":"number"},"total_count":{"type":"number"}},"required":["per_page","count","total_count"],"type":"object"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","result","messages"],"type":"object"}}},"description":"Get specific version details."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Bad Request."},"404":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"type":"array"},"messages":{"items":{"type":"string"},"type":"array"},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"enum":[false],"type":"boolean"}},"required":["success","messages","errors","result"],"type":"object"}}},"description":"Version not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Workflow version details","tags":["Workflows"],"x-api-token-group":["Workers Tail Read","Workers Scripts Write","Workers Scripts Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.workers.write","com.cloudflare.api.workers.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/zerotrust/connectivity_settings":{"get":{"description":"Gets the Zero Trust Connectivity Settings for the given account.","operationId":"zero-trust-accounts-get-connectivity-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_zero_trust_connectivity_settings_response"}}},"description":"Get Zero Trust Connectivity Settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}}},"description":"Get Zero Trust Connectivity Settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get Zero Trust Connectivity Settings","tags":["Zero Trust Connectivity Settings"],"x-api-token-group":["Zero Trust Report","Zero Trust Read","Zero Trust Write"]},"patch":{"description":"Updates the Zero Trust Connectivity Settings for the given account.","operationId":"zero-trust-accounts-patch-connectivity-settings","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"icmp_proxy_enabled":{"$ref":"#/components/schemas/tunnel_icmp_proxy_enabled"},"offramp_warp_enabled":{"$ref":"#/components/schemas/tunnel_offramp_warp_enabled"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_zero_trust_connectivity_settings_response"}}},"description":"Update Zero Trust Connectivity Settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}}},"description":"Update Zero Trust Connectivity Settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Updates the Zero Trust Connectivity Settings","tags":["Zero Trust Connectivity Settings"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/zerotrust/routes/hostname":{"get":{"description":"Lists and filters hostname routes in an account.","operationId":"zero-trust-networks-route-hostname-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"query","name":"id","schema":{"$ref":"#/components/schemas/tunnel_hostname_route_id"}},{"description":"If set, only list hostname routes that contain a substring of the given value, the filter is case-insensitive.","in":"query","name":"hostname","schema":{"$ref":"#/components/schemas/tunnel_hostname"}},{"description":"If set, only list hostname routes that point to a specific tunnel.","in":"query","name":"tunnel_id","schema":{"$ref":"#/components/schemas/tunnel_components-schemas-tunnel_id"}},{"in":"query","name":"comment","schema":{"$ref":"#/components/schemas/tunnel_hostname_query_comment"}},{"in":"query","name":"existed_at","schema":{"$ref":"#/components/schemas/tunnel_existed_at"}},{"in":"query","name":"is_deleted","schema":{"default":false,"description":"If `true`, only return deleted hostname routes. If `false`, exclude deleted hostname routes.","example":true,"type":"boolean"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/tunnel_per_page"}},{"in":"query","name":"page","schema":{"$ref":"#/components/schemas/tunnel_page_number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_hostname_route_response_collection"}}},"description":"List hostname routes response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_hostname_route_response_collection"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"List hostname routes failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List hostname routes","tags":["Zero Trust Hostname Route"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare One Networks Read","Cloudflare Tunnel Write","Cloudflare Tunnel Read"]},"post":{"description":"Create a hostname route.","operationId":"zero-trust-networks-route-hostname-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_hostname_comment"},"hostname":{"$ref":"#/components/schemas/tunnel_hostname"},"tunnel_id":{"$ref":"#/components/schemas/tunnel_components-schemas-tunnel_id"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_hostname_route_response_single"}}},"description":"Create hostname route response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_hostname_route_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Create hostname route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Create hostname route","tags":["Zero Trust Hostname Route"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare Tunnel Write"]}},"/accounts/{account_id}/zerotrust/routes/hostname/{hostname_route_id}":{"delete":{"description":"Delete a hostname route.","operationId":"zero-trust-networks-route-hostname-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"hostname_route_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_hostname_route_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_hostname_route_response_single"}}},"description":"Delete hostname route response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_hostname_route_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Delete hostname route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Delete hostname route","tags":["Zero Trust Hostname Route"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare Tunnel Write"]},"get":{"description":"Get a hostname route.","operationId":"zero-trust-networks-route-hostname-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"hostname_route_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_hostname_route_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_hostname_route_response_single"}}},"description":"Get hostname route response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_hostname_route_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Get hostname route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Get hostname route","tags":["Zero Trust Hostname Route"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare One Networks Read","Cloudflare Tunnel Write","Cloudflare Tunnel Read"]},"patch":{"description":"Updates a hostname route.","operationId":"zero-trust-networks-route-hostname-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"hostname_route_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_hostname_route_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_hostname_comment"},"hostname":{"$ref":"#/components/schemas/tunnel_hostname"},"tunnel_id":{"$ref":"#/components/schemas/tunnel_components-schemas-tunnel_id"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_hostname_route_response_single"}}},"description":"Update hostname route response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_hostname_route_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Update hostname route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Update hostname route","tags":["Zero Trust Hostname Route"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare Tunnel Write"]}},"/accounts/{account_id}/zerotrust/subnets":{"get":{"description":"Lists and filters subnets in an account.","operationId":"zero-trust-networks-subnets-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"description":"If set, only list subnets with the given name","in":"query","name":"name","schema":{"$ref":"#/components/schemas/tunnel_subnet_query_name"}},{"in":"query","name":"comment","schema":{"$ref":"#/components/schemas/tunnel_subnet_query_comment"}},{"in":"query","name":"network","schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_ip_network_encoded"}],"description":"If set, only list the subnet whose network exactly matches the given CIDR."}},{"in":"query","name":"existed_at","schema":{"$ref":"#/components/schemas/tunnel_existed_at"}},{"description":"If set, only include subnets in the given address family - `v4` or `v6`","in":"query","name":"address_family","schema":{"$ref":"#/components/schemas/tunnel_address_family"}},{"in":"query","name":"is_default_network","schema":{"description":"If `true`, only include default subnets. If `false`, exclude default subnets subnets. If not set, all subnets will be included.","type":"boolean"}},{"in":"query","name":"is_deleted","schema":{"description":"If `true`, only include deleted subnets. If `false`, exclude deleted subnets. If not set, all subnets will be included.","type":"boolean"}},{"in":"query","name":"sort_order","schema":{"description":"Sort order of the results. `asc` means oldest to newest, `desc` means newest to oldest. If not set, they will not be in any particular order.","enum":["asc","desc"],"type":"string"}},{"in":"query","name":"subnet_types","schema":{"description":"If set, the types of subnets to include, separated by comma.","enum":["cloudflare_source","warp"],"example":"cloudflare_source,warp","type":"string"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/tunnel_per_page"}},{"in":"query","name":"page","schema":{"$ref":"#/components/schemas/tunnel_page_number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_subnet_response_collection"}}},"description":"List subnets response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_subnet_response_collection"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"List subnets response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"List Subnets","tags":["Zero Trust Subnets"],"x-api-token-group":["Cloudflare One Networks Write","Cloudflare One Networks Read"]}},"/accounts/{account_id}/zerotrust/subnets/cloudflare_source/{address_family}":{"patch":{"description":"Updates the Cloudflare Source subnet of the given address family","operationId":"zero-trust-networks-subnet-update-cloudflare-source","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_account_id"}},{"in":"path","name":"address_family","required":true,"schema":{"$ref":"#/components/schemas/tunnel_address_family"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"$ref":"#/components/schemas/tunnel_subnet_comment"},"name":{"$ref":"#/components/schemas/tunnel_subnet_name"},"network":{"$ref":"#/components/schemas/tunnel_subnet_ip_network"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_subnet_response_single"}}},"description":"Update subnet response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_subnet_response_single"},{"$ref":"#/components/schemas/tunnel_api-response-common-failure"}]}}},"description":"Update subnet response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"summary":"Update Cloudflare Source Subnet","tags":["Zero Trust Subnets"],"x-api-token-group":["Cloudflare One Networks Write"]}},"/accounts/{account_id}/zt_risk_scoring/behaviors":{"get":{"operationId":"dlp-risk-score-behaviors-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"behaviors":{"additionalProperties":{"$ref":"#/components/schemas/dlp_Behavior"},"type":"object"}},"required":["behaviors"],"type":"object"}},"type":"object"}]}}},"description":"Risk scoring behaviors."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Failed to get risk scoring behaviors."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get all behaviors and associated configuration","tags":["Zero Trust Risk Scoring"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"put":{"operationId":"dlp-risk-score-behaviors-put","parameters":[{"description":"Account ID.","in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_UpdateBehaviors"}}},"description":"Behaviors.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"behaviors":{"additionalProperties":{"$ref":"#/components/schemas/dlp_UpdateBehavior"},"type":"object"}},"required":["behaviors"],"type":"object"}},"type":"object"}]}}},"description":"Dataset created successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Dataset creation failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update configuration for risk behaviors","tags":["Zero Trust Risk Scoring"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/zt_risk_scoring/integrations":{"get":{"operationId":"dlp-zt-risk-score-integration-list","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dlp_RiskScoreIntegration"},"type":"array"}},"type":"object"}]}}},"description":"List response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"List failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List all risk score integrations for the account.","tags":["Zero Trust Risk Scoring Integrations"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"post":{"operationId":"dlp-zt-risk-score-integration-create","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_CreateIntegrationBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"account_tag":{"description":"The Cloudflare account tag.","type":"string"},"active":{"description":"Whether this integration is enabled and should export changes in risk score.","type":"boolean"},"created_at":{"description":"When the integration was created in RFC3339 format.","format":"date-time","type":"string"},"id":{"description":"The id of the integration, a UUIDv4.","format":"uuid","type":"string"},"integration_type":{"$ref":"#/components/schemas/dlp_RiskScoreIntegrationType"},"reference_id":{"description":"A reference ID defined by the client.\nShould be set to the Access-Okta IDP integration ID.\nUseful when the risk-score integration needs to be associated with a secondary asset and recalled using that ID.","type":"string"},"tenant_url":{"description":"The base URL for the tenant. E.g. \"https://tenant.okta.com\".","type":"string"},"well_known_url":{"description":"The URL for the Shared Signals Framework configuration, e.g. \"/.well-known/sse-configuration/{integration_uuid}/\". https://openid.net/specs/openid-sse-framework-1_0.html#rfc.section.6.2.1.","type":"string"}},"required":["id","account_tag","integration_type","reference_id","tenant_url","well_known_url","active","created_at"],"type":"object"}},"type":"object"}]}}},"description":"Create response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Create failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create new risk score integration.","tags":["Zero Trust Risk Scoring Integrations"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/zt_risk_scoring/integrations/reference_id/{reference_id}":{"get":{"operationId":"dlp-zt-risk-score-integration-get-by-reference-id","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"reference_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"account_tag":{"description":"The Cloudflare account tag.","type":"string"},"active":{"description":"Whether this integration is enabled and should export changes in risk score.","type":"boolean"},"created_at":{"description":"When the integration was created in RFC3339 format.","format":"date-time","type":"string"},"id":{"description":"The id of the integration, a UUIDv4.","format":"uuid","type":"string"},"integration_type":{"$ref":"#/components/schemas/dlp_RiskScoreIntegrationType"},"reference_id":{"description":"A reference ID defined by the client.\nShould be set to the Access-Okta IDP integration ID.\nUseful when the risk-score integration needs to be associated with a secondary asset and recalled using that ID.","type":"string"},"tenant_url":{"description":"The base URL for the tenant. E.g. \"https://tenant.okta.com\".","type":"string"},"well_known_url":{"description":"The URL for the Shared Signals Framework configuration, e.g. \"/.well-known/sse-configuration/{integration_uuid}/\". https://openid.net/specs/openid-sse-framework-1_0.html#rfc.section.6.2.1.","type":"string"}},"required":["id","account_tag","integration_type","reference_id","tenant_url","well_known_url","active","created_at"],"type":"object"}},"type":"object"}]}}},"description":"Get response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Get failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get risk score integration by reference id.","tags":["Zero Trust Risk Scoring Integrations"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]}},"/accounts/{account_id}/zt_risk_scoring/integrations/{integration_id}":{"delete":{"operationId":"dlp-zt-risk-score-integration-delete","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"integration_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]}}},"description":"Delete response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Delete failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a risk score integration.","tags":["Zero Trust Risk Scoring Integrations"],"x-api-token-group":["Zero Trust Write"]},"get":{"operationId":"dlp-zt-risk-score-integration-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"integration_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"account_tag":{"description":"The Cloudflare account tag.","type":"string"},"active":{"description":"Whether this integration is enabled and should export changes in risk score.","type":"boolean"},"created_at":{"description":"When the integration was created in RFC3339 format.","format":"date-time","type":"string"},"id":{"description":"The id of the integration, a UUIDv4.","format":"uuid","type":"string"},"integration_type":{"$ref":"#/components/schemas/dlp_RiskScoreIntegrationType"},"reference_id":{"description":"A reference ID defined by the client.\nShould be set to the Access-Okta IDP integration ID.\nUseful when the risk-score integration needs to be associated with a secondary asset and recalled using that ID.","type":"string"},"tenant_url":{"description":"The base URL for the tenant. E.g. \"https://tenant.okta.com\".","type":"string"},"well_known_url":{"description":"The URL for the Shared Signals Framework configuration, e.g. \"/.well-known/sse-configuration/{integration_uuid}/\". https://openid.net/specs/openid-sse-framework-1_0.html#rfc.section.6.2.1.","type":"string"}},"required":["id","account_tag","integration_type","reference_id","tenant_url","well_known_url","active","created_at"],"type":"object"}},"type":"object"}]}}},"description":"Get response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Get failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get risk score integration by id.","tags":["Zero Trust Risk Scoring Integrations"],"x-api-token-group":["Zero Trust Read","Zero Trust Write"]},"put":{"description":"Overwrite the reference_id, tenant_url, and active values with the ones provided.","operationId":"dlp-zt-risk-score-integration-update","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"integration_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_UpdateIntegrationBody"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"properties":{"account_tag":{"description":"The Cloudflare account tag.","type":"string"},"active":{"description":"Whether this integration is enabled and should export changes in risk score.","type":"boolean"},"created_at":{"description":"When the integration was created in RFC3339 format.","format":"date-time","type":"string"},"id":{"description":"The id of the integration, a UUIDv4.","format":"uuid","type":"string"},"integration_type":{"$ref":"#/components/schemas/dlp_RiskScoreIntegrationType"},"reference_id":{"description":"A reference ID defined by the client.\nShould be set to the Access-Okta IDP integration ID.\nUseful when the risk-score integration needs to be associated with a secondary asset and recalled using that ID.","type":"string"},"tenant_url":{"description":"The base URL for the tenant. E.g. \"https://tenant.okta.com\".","type":"string"},"well_known_url":{"description":"The URL for the Shared Signals Framework configuration, e.g. \"/.well-known/sse-configuration/{integration_uuid}/\". https://openid.net/specs/openid-sse-framework-1_0.html#rfc.section.6.2.1.","type":"string"}},"required":["id","account_tag","integration_type","reference_id","tenant_url","well_known_url","active","created_at"],"type":"object"}},"type":"object"}]}}},"description":"Update response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Update failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a risk score integration.","tags":["Zero Trust Risk Scoring Integrations"],"x-api-token-group":["Zero Trust Write"]}},"/accounts/{account_id}/zt_risk_scoring/summary":{"get":{"operationId":"dlp-risk-score-summary-get","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-collection"},{"properties":{"result":{"properties":{"users":{"items":{"$ref":"#/components/schemas/dlp_UserRiskInfo"},"type":"array"}},"required":["users"],"type":"object"}},"type":"object"}]}}},"description":"Risk score for all users in the account."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Failed to get risk scores."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get risk score info for all users in the account","tags":["Zero Trust Risk Scoring"],"x-api-token-group":["Zero Trust: PII Read"]}},"/accounts/{account_id}/zt_risk_scoring/{user_id}":{"get":{"operationId":"dlp-risk-score-summary-get-for-user","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"user_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-collection"},{"properties":{"result":{"properties":{"email":{"type":"string"},"events":{"items":{"$ref":"#/components/schemas/dlp_RiskEvent"},"type":"array"},"last_reset_time":{"format":"date-time","nullable":true,"type":"string"},"name":{"type":"string"},"risk_level":{"allOf":[{"$ref":"#/components/schemas/dlp_RiskLevel"}]}},"required":["name","email","events"],"type":"object"}},"type":"object"}]}}},"description":"Risk events."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Failed to get risk events."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get risk event/score information for a specific user","tags":["Zero Trust Risk Scoring"],"x-api-token-group":["Zero Trust: PII Read"]}},"/accounts/{account_id}/zt_risk_scoring/{user_id}/reset":{"post":{"operationId":"dlp-risk-score-reset-post","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"user_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dlp_api-response-single"},{"properties":{"result":{"nullable":true,"type":"object"}},"type":"object"}]}}},"description":"Dataset created successfully."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dlp_api-response-common-failure"}}},"description":"Dataset creation failed."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Clear the risk score for a particular user","tags":["Zero Trust Risk Scoring"],"x-api-token-group":["Zero Trust Write"]}},"/certificates":{"get":{"description":"List all existing Origin CA certificates for a given zone. You can use an Origin CA Key as your User Service Key or an API token when calling this endpoint ([see above](#requests)).","operationId":"origin-ca-list-certificates","parameters":[{"in":"query","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of records per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"limit","schema":{"description":"Limit to the number of records returned.","example":10,"type":"integer"}},{"in":"query","name":"offset","schema":{"description":"Offset the results","example":10,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_collection"}}},"description":"List Certificates response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"List Certificates response failure"}},"security":[{"user_service_key":[]},{"api_token":[]}],"summary":"List Certificates","tags":["Origin CA"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create an Origin CA certificate. You can use an Origin CA Key as your User Service Key or an API token when calling this endpoint ([see above](#requests)).","operationId":"origin-ca-create-certificate","requestBody":{"content":{"application/json":{"schema":{"properties":{"csr":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_csr"},"hostnames":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostnames"},"request_type":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_request_type"},"requested_validity":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_requested_validity"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single"}}},"description":"Create Certificate response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Create Certificate response failure"}},"security":[{"user_service_key":[]},{"api_token":[]}],"summary":"Create Certificate","tags":["Origin CA"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/certificates/{certificate_id}":{"delete":{"description":"Revoke an existing Origin CA certificate by its serial number. You can use an Origin CA Key as your User Service Key or an API token when calling this endpoint ([see above](#requests)).","operationId":"origin-ca-revoke-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_revoke_response"}}},"description":"Revoke Certificate response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_revoke_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Revoke Certificate response failure"}},"security":[{"user_service_key":[]},{"api_token":[]}],"summary":"Revoke Certificate","tags":["Origin CA"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get an existing Origin CA certificate by its serial number. You can use an Origin CA Key as your User Service Key or an API token when calling this endpoint ([see above](#requests)).","operationId":"origin-ca-get-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single"}}},"description":"Get Certificate response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Get Certificate response failure"}},"security":[{"user_service_key":[]},{"api_token":[]}],"summary":"Get Certificate","tags":["Origin CA"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/internal/submit":{"post":{"responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Internal route for testing URL submissions","tags":["brand_protection"]}},"/ips":{"get":{"description":"Get IPs used on the Cloudflare/JD Cloud network, see https://www.cloudflare.com/ips for Cloudflare IPs or https://developers.cloudflare.com/china-network/reference/infrastructure/ for JD Cloud IPs.","operationId":"cloudflare-ips-cloudflare-ip-details","parameters":[{"description":"Specified as `jdcloud` to list IPs used by JD Cloud data centers.","in":"query","name":"networks","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/public-ip_api-response-single"},{"properties":{"result":{"oneOf":[{"$ref":"#/components/schemas/public-ip_ips"},{"$ref":"#/components/schemas/public-ip_ips_jdcloud"}]}}}]}}},"description":"Cloudflare IP Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/public-ip_api-response-single"},{"properties":{"result":{"oneOf":[{"$ref":"#/components/schemas/public-ip_ips"},{"$ref":"#/components/schemas/public-ip_ips_jdcloud"}]}}}]},{"$ref":"#/components/schemas/public-ip_api-response-common-failure"}]}}},"description":"Cloudflare IP Details response failure"}},"security":[{}],"summary":"Cloudflare/JD Cloud IP Details","tags":["Cloudflare IPs"]}},"/live":{"get":{"description":"Return a success message after running liveness checks","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Run liveness checks","tags":["brand_protection"]}},"/memberships":{"get":{"description":"List memberships of accounts the user can access.","operationId":"user'-s-account-memberships-list-memberships","parameters":[{"in":"query","name":"account.name","schema":{"$ref":"#/components/schemas/iam_properties-name"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of memberships per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Field to order memberships by.","enum":["id","account.name","status"],"example":"status","type":"string"}},{"in":"query","name":"direction","schema":{"description":"Direction to order memberships.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"name","schema":{"$ref":"#/components/schemas/iam_properties-name"}},{"in":"query","name":"status","schema":{"description":"Status of this membership.","enum":["accepted","pending","rejected"],"example":"accepted","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/iam_collection_membership_response"},{"$ref":"#/components/schemas/iam_collection_membership_response_with_policies"}]}}},"description":"List Memberships response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"List Memberships response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Memberships","tags":["User's Account Memberships"],"x-api-token-group":["Memberships Write","Memberships Read"]}},"/memberships/{membership_id}":{"delete":{"description":"Remove the associated member from an account.","operationId":"user'-s-account-memberships-delete-membership","parameters":[{"in":"path","name":"membership_id","required":true,"schema":{"$ref":"#/components/schemas/iam_membership_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/iam_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/iam_membership_components-schemas-identifier"}}}},"type":"object"}]}}},"description":"Delete Membership response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Delete Membership response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete Membership","tags":["User's Account Memberships"],"x-api-token-group":["Memberships Write"]},"get":{"description":"Get a specific membership.","operationId":"user'-s-account-memberships-membership-details","parameters":[{"in":"path","name":"membership_id","required":true,"schema":{"$ref":"#/components/schemas/iam_membership_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_membership_response_with_policies"}}},"description":"Membership Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Membership Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Membership Details","tags":["User's Account Memberships"],"x-api-token-group":["Memberships Write","Memberships Read"]},"put":{"description":"Accept or reject this account invitation.","operationId":"user'-s-account-memberships-update-membership","parameters":[{"in":"path","name":"membership_id","required":true,"schema":{"$ref":"#/components/schemas/iam_membership_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"status":{"description":"Whether to accept or reject this account invitation.","enum":["accepted","rejected"],"example":"accepted"}},"required":["status"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_membership_response_with_policies"}}},"description":"Update Membership response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Update Membership response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update Membership","tags":["User's Account Memberships"],"x-api-token-group":["Memberships Write"]}},"/organizations":{"get":{"description":"Retrieve a list of organizations a particular user has access to. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)","operationId":"Organization_listOrganizations","parameters":[{"$ref":"#/components/parameters/organizations-api_OrganizationListFiltersId"},{"$ref":"#/components/parameters/organizations-api_OrganizationListFiltersName"},{"$ref":"#/components/parameters/organizations-api_OrganizationListFiltersNameStartsWith"},{"$ref":"#/components/parameters/organizations-api_OrganizationListFiltersNameEndsWith"},{"$ref":"#/components/parameters/organizations-api_OrganizationListFiltersNameContains"},{"$ref":"#/components/parameters/organizations-api_OrganizationListFiltersContainingAccount"},{"$ref":"#/components/parameters/organizations-api_OrganizationListFiltersContainingUser"},{"$ref":"#/components/parameters/organizations-api_OrganizationListFiltersContainingOrganization"},{"$ref":"#/components/parameters/organizations-api_OrganizationListFiltersParentId"},{"$ref":"#/components/parameters/organizations-api_PageTokenParamsPageToken"},{"$ref":"#/components/parameters/organizations-api_PageTokenParamsPageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"items":{"$ref":"#/components/schemas/organizations-api_Organization"},"type":"array"},"result_info":{"$ref":"#/components/schemas/organizations-api_PageTokenResultInfo"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result","result_info"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List organizations the user has access to","tags":["Organizations"],"x-api-token-group":["User Details Write","User Details Read"]},"post":{"description":"Create a new organization for a user. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)","operationId":"Organizations_createUserOrganization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_Organization"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"$ref":"#/components/schemas/organizations-api_Organization"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create organization","tags":["Organizations"],"x-api-token-group":["User Details Write"]}},"/organizations/{organization_id}":{"delete":{"description":"Delete an organization. The organization MUST be empty before deleting.\nIt must not contain any sub-organizations, accounts, members or users. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)","operationId":"Organizations_delete","parameters":[{"description":"The ID of the organization to delete.","in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/organizations-api_OrganizationID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"$ref":"#/components/schemas/organizations-api_DeleteOrganizationResponse"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete organization.","tags":["Organizations"]},"get":{"description":"Retrieve the details of a certain organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)","operationId":"Organizations_retrieve","parameters":[{"description":"The ID of the organization to retrieve.","in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/organizations-api_OrganizationID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"$ref":"#/components/schemas/organizations-api_Organization"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get organization","tags":["Organizations"]},"put":{"description":"Modify organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)","operationId":"Organizations_modify","parameters":[{"description":"The ID of the organization to modify.","in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/organizations-api_OrganizationID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_Organization"}}},"description":"The new details of the organization. Only accepts updates\nto \"name\" currently.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"$ref":"#/components/schemas/organizations-api_Organization"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Modify organization.","tags":["Organizations"]}},"/organizations/{organization_id}/accounts":{"get":{"description":"Retrieve a list of accounts that belong to a specific organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)","operationId":"Organizations_getAccounts","parameters":[{"description":"The ID of the organization to retrieve a list of accounts for.","in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/organizations-api_OrganizationID"}},{"deprecated":true,"description":"(case-insensitive) Filter the list of accounts to where the account_pubname is equal to\na particular string.","explode":false,"in":"query","name":"account_pubname","schema":{"type":"string"}},{"deprecated":true,"description":"(case-insensitive) Filter the list of accounts to where the account_pubname starts with\na particular string.","explode":false,"in":"query","name":"account_pubname.startsWith","schema":{"type":"string"}},{"deprecated":true,"description":"(case-insensitive) Filter the list of accounts to where the account_pubname ends with\na particular string.","explode":false,"in":"query","name":"account_pubname.endsWith","schema":{"type":"string"}},{"deprecated":true,"description":"(case-insensitive) Filter the list of accounts to where the account_pubname contains\na particular string.","explode":false,"in":"query","name":"account_pubname.contains","schema":{"type":"string"}},{"description":"(case-insensitive) Filter the list of accounts to where the name is equal to a\nparticular string.","explode":false,"in":"query","name":"name","schema":{"type":"string"}},{"description":"(case-insensitive) Filter the list of accounts to where the name starts with a\nparticular string.","explode":false,"in":"query","name":"name.startsWith","schema":{"type":"string"}},{"description":"(case-insensitive) Filter the list of accounts to where the name ends with a particular\nstring.","explode":false,"in":"query","name":"name.endsWith","schema":{"type":"string"}},{"description":"(case-insensitive) Filter the list of accounts to where the name contains a particular\nstring.","explode":false,"in":"query","name":"name.contains","schema":{"type":"string"}},{"$ref":"#/components/parameters/organizations-api_PageTokenParamsPageToken"},{"$ref":"#/components/parameters/organizations-api_PageTokenParamsPageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"items":{"$ref":"#/components/schemas/organizations-api_Account"},"type":"array"},"result_info":{"$ref":"#/components/schemas/organizations-api_PageTokenResultInfo"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result","result_info"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get organization accounts","tags":["Organizations"]}},"/organizations/{organization_id}/members":{"get":{"description":"List memberships for an Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)","operationId":"Members_list","parameters":[{"in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/organizations-api_OrganizationID"}},{"description":"Filter the list of memberships by membership status.","in":"query","name":"status","schema":{"items":{"enum":["active","canceled"],"type":"string"},"type":"array"}},{"description":"Filter the list of memberships for a specific email.","explode":false,"in":"query","name":"user.email","schema":{"type":"string"}},{"description":"Filter the list of memberships for a specific email that contains a substring.","explode":false,"in":"query","name":"user.email.contains","schema":{"type":"string"}},{"description":"Filter the list of memberships for a specific email that starts with a substring.","explode":false,"in":"query","name":"user.email.startsWith","schema":{"type":"string"}},{"description":"Filter the list of memberships for a specific email that ends with a substring.","explode":false,"in":"query","name":"user.email.endsWith","schema":{"type":"string"}},{"$ref":"#/components/parameters/organizations-api_PageTokenParamsPageToken"},{"$ref":"#/components/parameters/organizations-api_PageTokenParamsPageSize"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"items":{"$ref":"#/components/schemas/organizations-api_Member"},"type":"array"},"result_info":{"$ref":"#/components/schemas/organizations-api_PageTokenResultInfo"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result","result_info"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List organization members","tags":["OrganizationMembers"]},"post":{"description":"Create a membership that grants access to a specific Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)","operationId":"Members_create","parameters":[{"in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/organizations-api_OrganizationID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_CreateMemberRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"$ref":"#/components/schemas/organizations-api_Member"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create organization member","tags":["OrganizationMembers"]}},"/organizations/{organization_id}/members/{member_id}":{"delete":{"description":"Delete a membership to a particular Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)","operationId":"Members_delete","parameters":[{"in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/organizations-api_OrganizationID"}},{"in":"path","name":"member_id","required":true,"schema":{"$ref":"#/components/schemas/organizations-api_MemberID"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"member_id":{"$ref":"#/components/schemas/organizations-api_MemberID"}},"required":["member_id"],"type":"object"}}},"required":true},"responses":{"204":{"description":"There is no content to send for this request, but the headers may be useful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete organization member","tags":["OrganizationMembers"]},"get":{"description":"Retrieve a single membership from an Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)","operationId":"Members_retrieve","parameters":[{"in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/organizations-api_OrganizationID"}},{"in":"path","name":"member_id","required":true,"schema":{"$ref":"#/components/schemas/organizations-api_MemberID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"$ref":"#/components/schemas/organizations-api_Member"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get organization member","tags":["OrganizationMembers"]}},"/organizations/{organization_id}/members:batchCreate":{"post":{"description":"Batch create multiple memberships that grant access to a specific Organization.","operationId":"Members_batchCreate","parameters":[{"in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/organizations-api_OrganizationID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_BatchCreateMembersRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"items":{"$ref":"#/components/schemas/organizations-api_Member"},"type":"array"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Batch create organization members","tags":["OrganizationMembers"]}},"/organizations/{organization_id}/profile":{"get":{"description":"Get an organizations profile if it exists. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)","operationId":"Organizations_getProfile","parameters":[{"description":"The ID of the organization to retrieve a profile for.","in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/organizations-api_OrganizationID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"$ref":"#/components/schemas/organizations-api_Profile"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get organization profile","tags":["Organizations"]},"put":{"description":"Modify organization profile. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)","operationId":"Organizations_modifyProfile","parameters":[{"in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/organizations-api_OrganizationID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_Profile"}}},"required":true},"responses":{"204":{"description":"There is no content to send for this request, but the headers may be useful."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Modify organization profile.","tags":["Organizations"]}},"/organizations/{organization_id}/shares":{"get":{"description":"Lists all organization shares.","operationId":"organization-shares-list","parameters":[{"in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/resource-sharing_organization_id"}},{"$ref":"#/components/parameters/resource-sharing_status"},{"$ref":"#/components/parameters/resource-sharing_kind"},{"$ref":"#/components/parameters/resource-sharing_target_type"},{"$ref":"#/components/parameters/resource-sharing_resource_types"},{"$ref":"#/components/parameters/resource-sharing_order"},{"$ref":"#/components/parameters/resource-sharing_direction"},{"$ref":"#/components/parameters/resource-sharing_page"},{"$ref":"#/components/parameters/resource-sharing_per_page"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resource-sharing_share_response_collection"}}},"description":"List organization shares response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"List organization shares response failure."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resource-sharing_api-response-common-failure"}]}}},"description":"List organization shares response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List organization shares","tags":["Resource Sharing"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/radar/ai/bots/summary/user_agent":{"get":{"deprecated":true,"description":"Retrieves the distribution of traffic by AI user agent.","operationId":"radar-get-ai-bots-summary-by-user-agent","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"Amazonbot":"10.274394","Bytespider":"8.381743","facebookexternalhit":"63.40249"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AI user agents summary","tags":["Radar AI Bots"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AI Bots Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/bots/methods/summary_v2/) instead."}},"/radar/ai/bots/summary/{dimension}":{"get":{"description":"Retrieves an aggregated summary of AI bots HTTP requests grouped by the specified dimension.","operationId":"radar-get-ai-bots-summary","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["USER_AGENT","CRAWL_PURPOSE","INDUSTRY","VERTICAL"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot crawl purpose.","in":"query","name":"crawlPurpose","schema":{"description":"Filters results by bot crawl purpose.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by vertical.","in":"query","name":"vertical","schema":{"description":"Filters results by vertical.","items":{"maxLength":2000,"type":"string"},"type":"array"}},{"description":"Filters results by industry.","in":"query","name":"industry","schema":{"description":"Filters results by industry.","items":{"maxLength":2000,"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"Amazonbot":"10.274394","Bytespider":"8.381743","facebookexternalhit":"63.40249"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AI bots HTTP requests distribution by dimension","tags":["Radar AI Bots"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ai/bots/timeseries":{"get":{"description":"Retrieves AI bots HTTP request volume over time.","operationId":"radar-get-ai-bots-timeseries","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot crawl purpose.","in":"query","name":"crawlPurpose","schema":{"description":"Filters results by bot crawl purpose.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by user agent.","in":"query","name":"userAgent","schema":{"description":"Filters results by user agent.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by industry.","in":"query","name":"industry","schema":{"description":"Filters results by industry.","items":{"maxLength":2000,"type":"string"},"type":"array"}},{"description":"Filters results by vertical.","in":"query","name":"vertical","schema":{"description":"Filters results by vertical.","items":{"maxLength":2000,"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"additionalProperties":{"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"},"values":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"},"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"}},"required":["meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AI bots HTTP requests time series","tags":["Radar AI Bots"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ai/bots/timeseries_groups/user_agent":{"get":{"deprecated":true,"description":"Retrieves the distribution of traffic by AI user agent over time.","operationId":"radar-get-ai-bots-timeseries-group-by-user-agent","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"facebookexternalhit":["0.862022"],"timestamps":["2024-07-30T03:00:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AI user agents time series","tags":["Radar AI Bots"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AI Bots Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/bots/methods/timeseries_groups/) instead."}},"/radar/ai/bots/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of HTTP requests from AI bots, grouped by chosen the specified dimension over time.","operationId":"radar-get-ai-bots-timeseries-group","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["USER_AGENT","CRAWL_PURPOSE","INDUSTRY","VERTICAL"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot crawl purpose.","in":"query","name":"crawlPurpose","schema":{"description":"Filters results by bot crawl purpose.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by industry.","in":"query","name":"industry","schema":{"description":"Filters results by industry.","items":{"maxLength":2000,"type":"string"},"type":"array"}},{"description":"Filters results by vertical.","in":"query","name":"vertical","schema":{"description":"Filters results by vertical.","items":{"maxLength":2000,"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE_CHANGE","MIN0_MAX"],"example":"MIN0_MAX","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"facebookexternalhit":["0.862022"],"timestamps":["2024-07-30T03:00:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get time series distribution of AI bots HTTP requests by dimension.","tags":["Radar AI Bots"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ai/inference/summary/model":{"get":{"deprecated":true,"description":"Retrieves the distribution of unique accounts by model.","operationId":"radar-get-ai-inference-summary-by-model","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"@cf/meta/llama-3-8b-instruct":"8.381743","@cf/meta/m2m100-1.2b":"22.904","@cf/stabilityai/stable-diffusion-xl-base-1.0":"10.274394"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Workers AI models summary","tags":["Radar AI Inference"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AI Inference Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/inference/methods/summary_v2/) instead."}},"/radar/ai/inference/summary/task":{"get":{"deprecated":true,"description":"Retrieves the distribution of unique accounts by task.","operationId":"radar-get-ai-inference-summary-by-task","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"text generation":"10.274394","text-to-image":"22.904"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Workers AI tasks summary","tags":["Radar AI Inference"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AI Inference Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/inference/methods/summary_v2/) instead."}},"/radar/ai/inference/summary/{dimension}":{"get":{"description":"Retrieves an aggregated summary of unique accounts using Workers AI inference grouped by the specified dimension.","operationId":"radar-get-ai-inference-summary","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["MODEL","TASK"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"@cf/meta/llama-3-8b-instruct":"8.381743","@cf/meta/m2m100-1.2b":"22.904","@cf/stabilityai/stable-diffusion-xl-base-1.0":"10.274394"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Workers AI inference distribution by dimension","tags":["Radar AI Inference"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ai/inference/timeseries_groups/model":{"get":{"deprecated":true,"description":"Retrieves the distribution of unique accounts by model over time.","operationId":"radar-get-ai-inference-timeseries-group-by-model","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"@cf/meta/m2m100-1.2b":["67.701863"],"timestamps":["2024-07-30T03:00:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Workers AI models time series","tags":["Radar AI Inference"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AI Inference Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/inference/methods/timeseries_groups_v2/) instead."}},"/radar/ai/inference/timeseries_groups/task":{"get":{"deprecated":true,"description":"Retrieves the distribution of unique accounts by task over time.","operationId":"radar-get-ai-inference-timeseries-group-by-task","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"text-to-image":["67.701863"],"timestamps":["2024-07-30T03:00:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Workers AI tasks time series","tags":["Radar AI Inference"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AI Inference Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/ai/subresources/inference/methods/timeseries_groups_v2/) instead."}},"/radar/ai/inference/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of unique accounts using Workers AI inference, grouped by the specified dimension over time.","operationId":"radar-get-ai-inference-timeseries-group","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["MODEL","TASK"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE_CHANGE","MIN0_MAX"],"example":"MIN0_MAX","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"@cf/meta/m2m100-1.2b":["67.701863"],"text-to-image":["22.904"],"timestamps":["2024-07-30T03:00:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get time series distribution of Workers AI inference by dimension.","tags":["Radar AI Inference"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/annotations":{"get":{"description":"Retrieves the latest annotations.","operationId":"radar-get-annotations","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Skips the specified number of objects before fetching the results.","in":"query","name":"offset","schema":{"description":"Skips the specified number of objects before fetching the results.","minimum":0,"type":"integer"}},{"description":"Filters results by date range.","in":"query","name":"dateRange","schema":{"description":"Filters results by date range.","example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"}},{"description":"Start of the date range (inclusive).","in":"query","name":"dateStart","schema":{"description":"Start of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"description":"Filters results by data source.","in":"query","name":"dataSource","schema":{"description":"Filters results by data source.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"example":"ALL","type":"string"}},{"description":"Filters results by event type.","in":"query","name":"eventType","schema":{"description":"Filters results by event type.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"example":"OUTAGE","type":"string"}},{"description":"Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.","example":174,"type":"integer"}},{"description":"Filters results by location. Specify an alpha-2 location code.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify an alpha-2 location code.","example":"US","maxLength":2,"minLength":2,"type":"string"}},{"description":"Filters results by origin.","in":"query","name":"origin","schema":{"description":"Filters results by origin.","example":"amazon-us-east-1","maxLength":100,"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"annotations":{"items":{"properties":{"asns":{"items":{"example":189,"type":"integer"},"type":"array"},"asnsDetails":{"items":{"properties":{"asn":{"example":"189","type":"string"},"locations":{"properties":{"code":{"example":"US","type":"string"},"name":{"example":"United States","type":"string"}},"required":["code","name"],"type":"object"},"name":{"example":"LUMEN-LEGACY-L3-PARTITION","type":"string"}},"required":["asn","name"],"type":"object"},"type":"array"},"dataSource":{"example":"ALL","type":"string"},"description":{"example":"example","type":"string"},"endDate":{"example":"2022-09-08T10:00:28Z","type":"string"},"eventType":{"example":"OUTAGE","type":"string"},"id":{"example":"550","type":"string"},"linkedUrl":{"example":"http://example.com","type":"string"},"locations":{"items":{"example":"US","type":"string"},"type":"array"},"locationsDetails":{"items":{"properties":{"code":{"example":"US","type":"string"},"name":{"example":"United States","type":"string"}},"required":["code","name"],"type":"object"},"type":"array"},"origins":{"items":{"example":"amazon-us-east-1","type":"string"},"type":"array"},"originsDetails":{"items":{"properties":{"name":{"example":"us-east-1 Amazon Web Services","type":"string"},"origin":{"example":"amazon-us-east-1","type":"string"}},"required":["origin","name"],"type":"object"},"type":"array"},"outage":{"properties":{"outageCause":{"example":"CABLE_CUT","type":"string"},"outageType":{"example":"NATIONWIDE","type":"string"}},"required":["outageCause","outageType"],"type":"object"},"scope":{"example":"Colima, Michoacán, México","type":"string"},"startDate":{"example":"2022-09-06T10:00:28Z","type":"string"}},"required":["id","dataSource","startDate","asns","asnsDetails","locations","locationsDetails","origins","originsDetails","eventType","outage"],"type":"object"},"type":"array"}},"required":["annotations"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get latest annotations","tags":["Radar Annotations"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/annotations/outages":{"get":{"description":"Retrieves the latest Internet outages and anomalies.","operationId":"radar-get-annotations-outages","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Skips the specified number of objects before fetching the results.","in":"query","name":"offset","schema":{"description":"Skips the specified number of objects before fetching the results.","minimum":0,"type":"integer"}},{"description":"Filters results by date range.","in":"query","name":"dateRange","schema":{"description":"Filters results by date range.","example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"}},{"description":"Start of the date range (inclusive).","in":"query","name":"dateStart","schema":{"description":"Start of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"description":"Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.","example":174,"type":"integer"}},{"description":"Filters results by location. Specify an alpha-2 location code.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify an alpha-2 location code.","example":"US","maxLength":2,"minLength":2,"type":"string"}},{"description":"Filters results by origin.","in":"query","name":"origin","schema":{"description":"Filters results by origin.","example":"amazon-us-east-1","maxLength":100,"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"annotations":{"items":{"properties":{"asns":{"items":{"example":189,"type":"integer"},"type":"array"},"asnsDetails":{"items":{"properties":{"asn":{"example":"189","type":"string"},"locations":{"properties":{"code":{"example":"US","type":"string"},"name":{"example":"United States","type":"string"}},"required":["code","name"],"type":"object"},"name":{"example":"LUMEN-LEGACY-L3-PARTITION","type":"string"}},"required":["asn","name"],"type":"object"},"type":"array"},"dataSource":{"example":"ALL","type":"string"},"description":{"example":"example","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"example":"OUTAGE","type":"string"},"id":{"example":"550","type":"string"},"linkedUrl":{"example":"http://example.com","type":"string"},"locations":{"items":{"example":"US","type":"string"},"type":"array"},"locationsDetails":{"items":{"properties":{"code":{"example":"US","type":"string"},"name":{"example":"United States","type":"string"}},"required":["code","name"],"type":"object"},"type":"array"},"origins":{"items":{"example":"amazon-us-east-1","type":"string"},"type":"array"},"originsDetails":{"items":{"properties":{"name":{"example":"us-east-1 Amazon Web Services","type":"string"},"origin":{"example":"amazon-us-east-1","type":"string"}},"required":["origin","name"],"type":"object"},"type":"array"},"outage":{"properties":{"outageCause":{"example":"CABLE_CUT","type":"string"},"outageType":{"example":"NATIONWIDE","type":"string"}},"required":["outageCause","outageType"],"type":"object"},"scope":{"example":"Colima, Michoacán, México","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["id","dataSource","startDate","asns","asnsDetails","locations","locationsDetails","origins","originsDetails","eventType","outage"],"type":"object"},"type":"array"}},"required":["annotations"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get latest Internet outages and anomalies","tags":["Radar Annotations"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/annotations/outages/locations":{"get":{"description":"Retrieves the number of outages by location.","operationId":"radar-get-annotations-outages-top","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Filters results by date range.","in":"query","name":"dateRange","schema":{"description":"Filters results by date range.","example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"}},{"description":"Start of the date range (inclusive).","in":"query","name":"dateStart","schema":{"description":"Start of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"annotations":{"items":{"properties":{"clientCountryAlpha2":{"example":"PT","type":"string"},"clientCountryName":{"example":"Portugal","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["annotations"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get the number of outages by location","tags":["Radar Annotations"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/summary/dnssec":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries to AS112 by DNSSEC (DNS Security Extensions) support.","operationId":"radar-get-dns-as112-timeseries-by-dnssec","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"NOT_SUPPORTED":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"SUPPORTED":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["SUPPORTED","NOT_SUPPORTED"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 DNS queries by DNSSEC summary","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AS112 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/summary_v2/) instead."}},"/radar/as112/summary/edns":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries to AS112 by EDNS (Extension Mechanisms for DNS) support.","operationId":"radar-get-dns-as112-timeseries-by-edns","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"NOT_SUPPORTED":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"SUPPORTED":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["SUPPORTED","NOT_SUPPORTED"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 DNS queries by EDNS summary","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AS112 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/summary_v2/) instead."}},"/radar/as112/summary/ip_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries to AS112 by IP version.","operationId":"radar-get-dns-as112-timeseries-by-ip-version","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"IPv4":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"IPv6":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["IPv4","IPv6"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 DNS queries by IP version summary","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AS112 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/summary_v2/) instead."}},"/radar/as112/summary/protocol":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries to AS112 by protocol.","operationId":"radar-get-dns-as112-timeseries-by-protocol","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"HTTPS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"TCP":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"TLS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"UDP":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["UDP","TLS","HTTPS","TCP"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 DNS queries by DNS protocol summary","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AS112 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/summary_v2/) instead."}},"/radar/as112/summary/query_type":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries to AS112 by type.","operationId":"radar-get-dns-as112-timeseries-by-query-type","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"A":"19","AAAA":"1","PTR":"74","SOA":"5","SRV":"1"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 DNS queries by type summary","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AS112 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/summary_v2/) instead."}},"/radar/as112/summary/response_codes":{"get":{"deprecated":true,"description":"Retrieves the distribution of AS112 DNS requests classified by response code.","operationId":"radar-get-dns-as112-timeseries-by-response-codes","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"NOERROR":"70","NOTIMP":"5","NXDOMAIN":"10","REFUSED":"5","SERVFAIL":"5"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 DNS queries by response code summary","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AS112 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/summary_v2/) instead."}},"/radar/as112/summary/{dimension}":{"get":{"description":"Retrieves the distribution of AS112 queries by the specified dimension.","operationId":"radar-get-dns-as112-summary","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["DNSSEC","EDNS","IP_VERSION","PROTOCOL","QUERY_TYPE","RESPONSE_CODE"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"type":"string"},"example":{"IPv4":"50.168733","IPv6":"25.084366"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 summary by dimension","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/timeseries":{"get":{"description":"Retrieves the AS112 DNS queries over time.","operationId":"radar-get-dns-as112-timeseries","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"additionalProperties":{"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"},"values":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"},"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"}},"required":["meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 DNS queries time series","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/timeseries_groups/dnssec":{"get":{"deprecated":true,"description":"Retrieves the distribution of AS112 DNS queries by DNSSEC (DNS Security Extensions) support over time.","operationId":"radar-get-dns-as112-timeseries-group-by-dnssec","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"NOT_SUPPORTED":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"SUPPORTED":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["SUPPORTED","NOT_SUPPORTED"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 DNS queries by DNSSEC support time series","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AS112 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/timeseries_groups_v2/) instead."}},"/radar/as112/timeseries_groups/edns":{"get":{"deprecated":true,"description":"Retrieves the distribution of AS112 DNS queries by EDNS (Extension Mechanisms for DNS) support over time.","operationId":"radar-get-dns-as112-timeseries-group-by-edns","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"NOT_SUPPORTED":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"SUPPORTED":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["SUPPORTED","NOT_SUPPORTED"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 DNS queries by EDNS support summary","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AS112 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/timeseries_groups_v2/) instead."}},"/radar/as112/timeseries_groups/ip_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of AS112 DNS queries by IP version over time.","operationId":"radar-get-dns-as112-timeseries-group-by-ip-version","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"IPv4":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"IPv6":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["IPv4","IPv6"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 DNS queries by IP version time series","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AS112 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/timeseries_groups_v2/) instead."}},"/radar/as112/timeseries_groups/protocol":{"get":{"deprecated":true,"description":"Retrieves the distribution of AS112 DNS requests classified by protocol over time.","operationId":"radar-get-dns-as112-timeseries-group-by-protocol","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"HTTPS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"TCP":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"TLS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"UDP":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["UDP","TLS","HTTPS","TCP"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 DNS queries by DNS protocol time series","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AS112 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/timeseries_groups_v2/) instead."}},"/radar/as112/timeseries_groups/query_type":{"get":{"deprecated":true,"description":"Retrieves the distribution of AS112 DNS queries by type over time.","operationId":"radar-get-dns-as112-timeseries-group-by-query-type","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"A":["20"],"AAAA":["20"],"HTTPS":["20"],"NS":["20"],"PTR":["20"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 DNS queries by type time series","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AS112 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/timeseries_groups_v2/) instead."}},"/radar/as112/timeseries_groups/response_codes":{"get":{"deprecated":true,"description":"Retrieves the distribution of AS112 DNS requests classified by response code over time.","operationId":"radar-get-dns-as112-timeseries-group-by-response-codes","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"NOERROR":["70"],"NOTIMP":["5"],"NXDOMAIN":["10"],"REFUSED":["5"],"SERVFAIL":["5"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 DNS queries by response code time series","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar AS112 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/as112/methods/timeseries_groups_v2/) instead."}},"/radar/as112/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of AS112 queries grouped by dimension over time.","operationId":"radar-get-dns-as112-timeseries-group","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["DNSSEC","EDNS","IP_VERSION","PROTOCOL","QUERY_TYPE","RESPONSE_CODE"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"IPv4":["50.168733"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS112 time series grouped by dimension","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/top/locations":{"get":{"description":"Retrieves the top locations by AS112 DNS queries.","operationId":"radar-get-dns-as112-top-locations","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by AS112 DNS queries","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/top/locations/dnssec/{dnssec}":{"get":{"description":"Retrieves the top locations of DNS queries to AS112 with DNSSEC (DNS Security Extensions) support.","operationId":"radar-get-dns-as112-top-locations-by-dnssec","parameters":[{"description":"DNSSEC (DNS Security Extensions) status.","in":"path","name":"dnssec","required":true,"schema":{"description":"DNSSEC (DNS Security Extensions) status.","enum":["SUPPORTED","NOT_SUPPORTED"],"example":"SUPPORTED","type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by AS112 DNS queries with DNSSEC support","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/top/locations/edns/{edns}":{"get":{"description":"Retrieves the top locations of DNS queries to AS112 with EDNS (Extension Mechanisms for DNS) support.","operationId":"radar-get-dns-as112-top-locations-by-edns","parameters":[{"description":"EDNS (Extension Mechanisms for DNS) status.","in":"path","name":"edns","required":true,"schema":{"description":"EDNS (Extension Mechanisms for DNS) status.","enum":["SUPPORTED","NOT_SUPPORTED"],"example":"SUPPORTED","type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by AS112 DNS queries with EDNS support","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/top/locations/ip_version/{ip_version}":{"get":{"description":"Retrieves the top locations of DNS queries to AS112 for an IP version.","operationId":"radar-get-dns-as112-top-locations-by-ip-version","parameters":[{"description":"IP version.","in":"path","name":"ip_version","required":true,"schema":{"description":"IP version.","enum":["IPv4","IPv6"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by AS112 DNS queries for an IP version","tags":["Radar AS112"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer3/summary/bitrate":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by bitrate.","operationId":"radar-get-attacks-layer3-summary-by-bitrate","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"OVER_100_GBPS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"UNDER_500_MBPS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"_10_GBPS_TO_100_GBPS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"_1_GBPS_TO_10_GBPS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"_500_MBPS_TO_1_GBPS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["UNDER_500_MBPS","OVER_100_GBPS","_1_GBPS_TO_10_GBPS","_500_MBPS_TO_1_GBPS","_10_GBPS_TO_100_GBPS"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by bitrate summary","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead."}},"/radar/attacks/layer3/summary/duration":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by duration.","operationId":"radar-get-attacks-layer3-summary-by-duration","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"OVER_3_HOURS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"UNDER_10_MINS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"_10_MINS_TO_20_MINS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"_1_HOUR_TO_3_HOURS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"_20_MINS_TO_40_MINS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"_40_MINS_TO_1_HOUR":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["UNDER_10_MINS","_10_MINS_TO_20_MINS","OVER_3_HOURS","_1_HOUR_TO_3_HOURS","_20_MINS_TO_40_MINS","_40_MINS_TO_1_HOUR"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by duration summary","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead."}},"/radar/attacks/layer3/summary/industry":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by targeted industry.","operationId":"radar-get-attacks-layer3-summary-by-industry","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"Computer Software":"65"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by targeted industry summary","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead."}},"/radar/attacks/layer3/summary/ip_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by IP version.","operationId":"radar-get-attacks-layer3-summary-by-ip-version","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"IPv4":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"IPv6":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["IPv4","IPv6"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by IP version summary","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead."}},"/radar/attacks/layer3/summary/protocol":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by protocol.","operationId":"radar-get-attacks-layer3-summary-by-protocol","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"GRE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"ICMP":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"TCP":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"UDP":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["TCP","UDP","GRE","ICMP"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by protocol summary","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead."}},"/radar/attacks/layer3/summary/vector":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by vector.","operationId":"radar-get-attacks-layer3-summary-by-vector","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"ACK Flood":"65.662148","SYN Flood":"16.86401"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by vector summary","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead."}},"/radar/attacks/layer3/summary/vertical":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by targeted vertical.","operationId":"radar-get-attacks-layer3-summary-by-vertical","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"Internet and Telecom":"5.519081"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by targeted vertical summary","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead."}},"/radar/attacks/layer3/summary/{dimension}":{"get":{"description":"Retrieves the distribution of layer 3 attacks by the specified dimension.","operationId":"radar-get-attacks-layer3-summary","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["PROTOCOL","IP_VERSION","VECTOR","DURATION","BITRATE","VERTICAL","INDUSTRY"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"type":"string"},"example":{"TCP":"50.168733","UDP":"25.084366"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks summary by dimension","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer3/timeseries":{"get":{"description":"Retrieves layer 3 attacks over time.","operationId":"radar-get-attacks-layer3-timeseries-by-bytes","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE_CHANGE","MIN0_MAX"],"example":"MIN0_MAX","type":"string"}},{"description":"Measurement units, eg. bytes.","in":"query","name":"metric","schema":{"default":"bytes","description":"Measurement units, eg. bytes.","enum":["BYTES","BYTES_OLD"],"type":"string"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"additionalProperties":{"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"},"values":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"},"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"}},"required":["meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by bytes time series","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer3/timeseries_groups/bitrate":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by bitrate over time.","operationId":"radar-get-attacks-layer3-timeseries-group-by-bitrate","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"OVER_100_GBPS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"UNDER_500_MBPS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"_10_GBPS_TO_100_GBPS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"_1_GBPS_TO_10_GBPS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"_500_MBPS_TO_1_GBPS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","UNDER_500_MBPS","OVER_100_GBPS","_1_GBPS_TO_10_GBPS","_500_MBPS_TO_1_GBPS","_10_GBPS_TO_100_GBPS"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by bitrate time series","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer3/timeseries_groups/duration":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by duration over time.","operationId":"radar-get-attacks-layer3-timeseries-group-by-duration","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"OVER_3_HOURS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"UNDER_10_MINS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"_10_MINS_TO_20_MINS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"_1_HOUR_TO_3_HOURS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"_20_MINS_TO_40_MINS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"_40_MINS_TO_1_HOUR":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","UNDER_10_MINS","_10_MINS_TO_20_MINS","OVER_3_HOURS","_1_HOUR_TO_3_HOURS","_20_MINS_TO_40_MINS","_40_MINS_TO_1_HOUR"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by duration time series","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer3/timeseries_groups/industry":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by targeted industry over time.","operationId":"radar-get-attacks-layer3-timeseries-group-by-industry","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"Internet":["5.519081"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by target industries time series","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer3/timeseries_groups/ip_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by IP version over time.","operationId":"radar-get-attacks-layer3-timeseries-group-by-ip-version","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"IPv4":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"IPv6":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","IPv4","IPv6"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by IP version time series","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer3/timeseries_groups/protocol":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by protocol over time.","operationId":"radar-get-attacks-layer3-timeseries-group-by-protocol","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"GRE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"ICMP":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"TCP":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"UDP":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","TCP","UDP","GRE","ICMP"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by protocol time series","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer3/timeseries_groups/vector":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by vector over time.","operationId":"radar-get-attacks-layer3-timeseries-group-by-vector","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"ACK Flood":["97.28898"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by vector time series","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer3/timeseries_groups/vertical":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 3 attacks by targeted vertical over time.","operationId":"radar-get-attacks-layer3-timeseries-group-by-vertical","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"Internet and Telecom":["5.519081"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks by vertical time series","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer3/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of layer 3 attacks grouped by dimension over time.","operationId":"radar-get-attacks-layer3-timeseries-group","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["PROTOCOL","IP_VERSION","VECTOR","DURATION","BITRATE","VERTICAL","INDUSTRY"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Specifies whether the `location` filter applies to the source or target location.","in":"query","name":"direction","schema":{"default":"ORIGIN","description":"Specifies whether the `location` filter applies to the source or target location.","enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"TCP":["50.168733"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 3 attacks time series grouped by dimension","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer3/top/attacks":{"get":{"description":"Retrieves the top layer 3 attacks from origin to target location. Values are a percentage out of the total layer 3 attacks (with billing country). You can optionally limit the number of attacks by origin/target location (useful if all the top attacks are from or to the same location).","operationId":"radar-get-attacks-layer3-top-attacks","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the `limitPerLocation` applies to the source or target location.","in":"query","name":"limitDirection","schema":{"default":"ORIGIN","description":"Specifies whether the `limitPerLocation` applies to the source or target location.","enum":["ORIGIN","TARGET"],"example":"ORIGIN","type":"string"}},{"description":"Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location.","in":"query","name":"limitPerLocation","schema":{"default":10,"description":"Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location.","example":10,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Orders results based on attack magnitude, defined by total mitigated bytes or total mitigated attacks.","in":"query","name":"magnitude","schema":{"description":"Orders results based on attack magnitude, defined by total mitigated bytes or total mitigated attacks.","enum":["MITIGATED_BYTES","MITIGATED_ATTACKS"],"example":"MITIGATED_BYTES","type":"string"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"originCountryAlpha2":{"example":"FR","type":"string"},"originCountryName":{"example":"France","type":"string"},"value":{"example":"4.323214","type":"string"}},"required":["originCountryAlpha2","originCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top layer 3 attack pairs (origin and target locations)","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer3/top/industry":{"get":{"deprecated":true,"description":"This endpoint is deprecated. To continue getting this data, switch to the summary by industry endpoint.","operationId":"radar-get-attacks-layer3-top-industries","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"name":{"example":"Computer Software","type":"string"},"value":{"example":"65","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top industries targeted by layer 3 attacks","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead."}},"/radar/attacks/layer3/top/locations/origin":{"get":{"description":"Retrieves the origin locations of layer 3 attacks.","operationId":"radar-get-attacks-layer3-top-origin-locations","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"originCountryAlpha2":{"example":"FR","type":"string"},"originCountryName":{"example":"France","type":"string"},"rank":{"example":1,"type":"number"},"value":{"example":"4.323214","type":"string"}},"required":["originCountryAlpha2","originCountryName","value","rank"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top origin locations of layer 3 attacks","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer3/top/locations/target":{"get":{"description":"Retrieves the target locations of layer 3 attacks.","operationId":"radar-get-attacks-layer3-top-target-locations","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"rank":{"example":1,"type":"number"},"targetCountryAlpha2":{"example":"FR","type":"string"},"targetCountryName":{"example":"France","type":"string"},"value":{"example":"4.323214","type":"string"}},"required":["targetCountryAlpha2","targetCountryName","value","rank"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top target locations of layer 3 attacks","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer3/top/vertical":{"get":{"deprecated":true,"description":"This endpoint is deprecated. To continue getting this data, switch to the summary by vertical endpoint.","operationId":"radar-get-attacks-layer3-top-verticals","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 3/4 protocol.","in":"query","name":"protocol","schema":{"description":"Filters the results by layer 3/4 protocol.","items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"name":{"example":"Internet and Telecom","type":"string"},"value":{"example":"65","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top verticals targeted by layer 3 attacks","tags":["Radar Layer 3 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 3 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer3/methods/summary_v2/) instead."}},"/radar/attacks/layer7/summary/http_method":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by HTTP method.","operationId":"radar-get-attacks-layer7-summary-by-http-method","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"GET":"99.100257","POST":"0.899743"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by HTTP method summary","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead."}},"/radar/attacks/layer7/summary/http_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by HTTP version.","operationId":"radar-get-attacks-layer7-summary-by-http-version","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"example":{"HTTP/1.x":"21.722365","HTTP/2":"77.056555","HTTP/3":"1.22108"},"properties":{"HTTP/1.x":{"type":"string"},"HTTP/2":{"type":"string"},"HTTP/3":{"type":"string"}},"required":["HTTP/2","HTTP/1.x","HTTP/3"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by HTTP version summary","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead."}},"/radar/attacks/layer7/summary/industry":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by targeted industry.","operationId":"radar-get-attacks-layer7-summary-by-industry","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"Computer Software":"65"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by targeted industry summary","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead."}},"/radar/attacks/layer7/summary/ip_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by IP version.","operationId":"radar-get-attacks-layer7-summary-by-ip-version","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"example":{"IPv4":"99.935733","IPv6":"0.064267"},"properties":{"IPv4":{"type":"string"},"IPv6":{"type":"string"}},"required":["IPv4","IPv6"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by IP version summary","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead."}},"/radar/attacks/layer7/summary/managed_rules":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by managed rules.","operationId":"radar-get-attacks-layer7-summary-by-managed-rules","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"HTTP Anomaly":"85.714286","XSS":"10.274394"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by managed rules summary","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead."}},"/radar/attacks/layer7/summary/mitigation_product":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by mitigation product.","operationId":"radar-get-attacks-layer7-summary-by-mitigation-product","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"DDOS":"24.421594","WAF":"53.213368"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by mitigation product summary","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead."}},"/radar/attacks/layer7/summary/vertical":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by targeted vertical.","operationId":"radar-get-attacks-layer7-summary-by-vertical","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"Internet and Telecom":"5.519081"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by targeted vertical summary","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead."}},"/radar/attacks/layer7/summary/{dimension}":{"get":{"description":"Retrieves the distribution of layer 7 attacks by the specified dimension.","operationId":"radar-get-attacks-layer7-summary","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["HTTP_METHOD","HTTP_VERSION","IP_VERSION","MANAGED_RULES","MITIGATION_PRODUCT","VERTICAL","INDUSTRY"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"type":"string"},"example":{"GET":"50.168733","POST":"25.084366"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks summary by dimension","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/timeseries":{"get":{"description":"Retrieves layer 7 attacks over time.","operationId":"radar-get-attacks-layer7-timeseries","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE_CHANGE","MIN0_MAX"],"example":"MIN0_MAX","type":"string"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"},"values":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks time series","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/timeseries_groups/http_method":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by HTTP method over time.","operationId":"radar-get-attacks-layer7-timeseries-group-by-http-method","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"GET":["70.970199"],"timestamps":["2023-10-01T00:00:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by HTTP method time series","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer7/timeseries_groups/http_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by HTTP version over time.","operationId":"radar-get-attacks-layer7-timeseries-group-by-http-version","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"example":{"HTTP/1.x":["50.338734"],"HTTP/2":["48.661266"],"HTTP/3":["1.22108"],"timestamps":["2023-10-01T00:00:00Z"]},"properties":{"HTTP/1.x":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"HTTP/2":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"HTTP/3":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","HTTP/1.x","HTTP/2","HTTP/3"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by HTTP version time series","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer7/timeseries_groups/industry":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by targeted industry over time.","operationId":"radar-get-attacks-layer7-timeseries-group-by-industry","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"Internet":["5.519081"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by target industries time series","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer7/timeseries_groups/ip_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by IP version used over time.","operationId":"radar-get-attacks-layer7-timeseries-group-by-ip-version","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"example":{"IPv4":["99.935733"],"IPv6":["0.064267"],"timestamps":["2023-10-01T00:00:00Z"]},"properties":{"IPv4":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"IPv6":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","IPv4","IPv6"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by IP version time series","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer7/timeseries_groups/managed_rules":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by managed rules over time.","operationId":"radar-get-attacks-layer7-timeseries-group-by-managed-rules","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"XSS":["0.324198"],"timestamps":["2023-10-01T00:00:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by managed rules time series","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer7/timeseries_groups/mitigation_product":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by mitigation product over time.","operationId":"radar-get-attacks-layer7-timeseries-group-by-mitigation-product","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"DDOS":["48.926354"],"timestamps":["2023-10-01T00:00:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by mitigation product time series","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer7/timeseries_groups/vertical":{"get":{"deprecated":true,"description":"Retrieves the distribution of layer 7 attacks by targeted vertical over time.","operationId":"radar-get-attacks-layer7-timeseries-group-by-vertical","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"Internet and Telecom":["5.519081"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks by vertical time series","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries_groups_v2/) instead."}},"/radar/attacks/layer7/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of layer 7 attacks grouped by dimension over time.","operationId":"radar-get-attacks-layer7-timeseries-group","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["HTTP_METHOD","HTTP_VERSION","IP_VERSION","MANAGED_RULES","MITIGATION_PRODUCT","VERTICAL","INDUSTRY"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"GET":["50.168733"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get layer 7 attacks time series grouped by dimension","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/top/ases/origin":{"get":{"description":"Retrieves the top origin autonomous systems of layer 7 attacks. Values are percentages of the total layer 7 attacks, with the origin autonomous systems determined by the client IP address.","operationId":"radar-get-attacks-layer7-top-origin-as","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"originAsn":{"example":"55836","type":"string"},"originAsnName":{"example":"RELIANCEJIO-IN Reliance Jio Infocomm Limited","type":"string"},"rank":{"example":1,"type":"number"},"value":{"example":"4.323214","type":"string"}},"required":["originAsnName","originAsn","value","rank"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top origin ASes of layer 7 attacks","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/top/attacks":{"get":{"description":"Retrieves the top attacks from origin to target location. Values are percentages of the total layer 7 attacks (with billing country). The attack magnitude can be defined by the number of mitigated requests or by the number of zones affected. You can optionally limit the number of attacks by origin/target location (useful if all the top attacks are from or to the same location).","operationId":"radar-get-attacks-layer7-top-attacks","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Specifies whether the `limitPerLocation` applies to the source or target location.","in":"query","name":"limitDirection","schema":{"default":"ORIGIN","description":"Specifies whether the `limitPerLocation` applies to the source or target location.","enum":["ORIGIN","TARGET"],"example":"ORIGIN","type":"string"}},{"description":"Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location.","in":"query","name":"limitPerLocation","schema":{"default":10,"description":"Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location.","example":10,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"originCountryAlpha2":{"example":"US","type":"string"},"originCountryName":{"example":"United States","type":"string"},"targetCountryAlpha2":{"example":"FR","type":"string"},"targetCountryName":{"example":"France","type":"string"},"value":{"example":"4.323214","type":"string"}},"required":["originCountryAlpha2","originCountryName","targetCountryAlpha2","targetCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top layer 7 attack pairs (origin and target locations)","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/top/industry":{"get":{"deprecated":true,"description":"This endpoint is deprecated. To continue getting this data, switch to the summary by industry endpoint.","operationId":"radar-get-attacks-layer7-top-industries","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"name":{"example":"Computer Software","type":"string"},"value":{"example":"65","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top industries targeted by layer 7 attacks","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead."}},"/radar/attacks/layer7/top/locations/origin":{"get":{"description":"Retrieves the top origin locations of layer 7 attacks. Values are percentages of the total layer 7 attacks, with the origin location determined by the client IP address.","operationId":"radar-get-attacks-layer7-top-origin-location","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"originCountryAlpha2":{"example":"FR","type":"string"},"originCountryName":{"example":"France","type":"string"},"rank":{"example":1,"type":"number"},"value":{"example":"4.323214","type":"string"}},"required":["originCountryAlpha2","originCountryName","value","rank"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top origin locations of layer 7 attacks","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/top/locations/target":{"get":{"description":"Retrieves the top target locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The target location is determined by the attacked zone's billing country, when available.","operationId":"radar-get-attacks-layer7-top-target-location","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"rank":{"example":1,"type":"number"},"targetCountryAlpha2":{"example":"FR","type":"string"},"targetCountryName":{"example":"France","type":"string"},"value":{"example":"4.323214","type":"string"}},"required":["targetCountryAlpha2","targetCountryName","value","rank"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top target locations of layer 7 attacks","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/top/vertical":{"get":{"deprecated":true,"description":"This endpoint is deprecated. To continue getting this data, switch to the summary by vertical endpoint.","operationId":"radar-get-attacks-layer7-top-verticals","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP method.","in":"query","name":"httpMethod","schema":{"description":"Filters results by HTTP method.","example":"GET","items":{"enum":["GET","POST","DELETE","PUT","HEAD","PURGE","OPTIONS","PROPFIND","MKCOL","PATCH","ACL","BCOPY","BDELETE","BMOVE","BPROPFIND","BPROPPATCH","CHECKIN","CHECKOUT","CONNECT","COPY","LABEL","LOCK","MERGE","MKACTIVITY","MKWORKSPACE","MOVE","NOTIFY","ORDERPATCH","POLL","PROPPATCH","REPORT","SEARCH","SUBSCRIBE","TRACE","UNCHECKOUT","UNLOCK","UNSUBSCRIBE","UPDATE","VERSIONCONTROL","BASELINECONTROL","XMSENUMATTS","RPC_OUT_DATA","RPC_IN_DATA","JSON","COOK","TRACK"],"type":"string"},"type":"array"}},{"description":"Filters the results by layer 7 mitigation product.","in":"query","name":"mitigationProduct","schema":{"description":"Filters the results by layer 7 mitigation product.","items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"name":{"example":"Internet and Telecom","type":"string"},"value":{"example":"65","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top verticals targeted by layer 7 attacks","tags":["Radar Layer 7 Attacks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Attacks Layer 7 Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/attacks/subresources/layer7/methods/summary_v2/) instead."}},"/radar/bgp/hijacks/events":{"get":{"description":"Retrieves the BGP hijack events.","operationId":"radar-get-bgp-hijacks-events","parameters":[{"description":"Current page number, starting from 1.","in":"query","name":"page","schema":{"default":1,"description":"Current page number, starting from 1.","exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Number of entries per page.","in":"query","name":"per_page","schema":{"default":50,"description":"Number of entries per page.","exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"The unique identifier of a event.","in":"query","name":"eventId","schema":{"description":"The unique identifier of a event.","type":"integer"}},{"description":"The potential hijacker AS of a BGP hijack event.","in":"query","name":"hijackerAsn","schema":{"description":"The potential hijacker AS of a BGP hijack event.","type":"integer"}},{"description":"The potential victim AS of a BGP hijack event.","in":"query","name":"victimAsn","schema":{"description":"The potential victim AS of a BGP hijack event.","type":"integer"}},{"description":"The potential hijacker or victim AS of a BGP hijack event.","in":"query","name":"involvedAsn","schema":{"description":"The potential hijacker or victim AS of a BGP hijack event.","type":"integer"}},{"description":"The country code of the potential hijacker or victim AS of a BGP hijack event.","in":"query","name":"involvedCountry","schema":{"description":"The country code of the potential hijacker or victim AS of a BGP hijack event.","type":"string"}},{"in":"query","name":"prefix","schema":{"example":"1.1.1.0/24","type":"string"}},{"description":"Filters events by minimum confidence score (1-4 low, 5-7 mid, 8+ high).","in":"query","name":"minConfidence","schema":{"description":"Filters events by minimum confidence score (1-4 low, 5-7 mid, 8+ high).","type":"integer"}},{"description":"Filters events by maximum confidence score (1-4 low, 5-7 mid, 8+ high).","in":"query","name":"maxConfidence","schema":{"description":"Filters events by maximum confidence score (1-4 low, 5-7 mid, 8+ high).","type":"integer"}},{"description":"Filters results by date range.","in":"query","name":"dateRange","schema":{"description":"Filters results by date range.","example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"}},{"description":"Start of the date range (inclusive).","in":"query","name":"dateStart","schema":{"description":"Start of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"description":"Sorts results by the specified field.","in":"query","name":"sortBy","schema":{"description":"Sorts results by the specified field.","enum":["ID","TIME","CONFIDENCE"],"example":"TIME","type":"string"}},{"description":"Sort order.","in":"query","name":"sortOrder","schema":{"description":"Sort order.","enum":["ASC","DESC"],"example":"desc","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"asn_info":{"items":{"properties":{"asn":{"type":"integer"},"country_code":{"type":"string"},"org_name":{"type":"string"}},"required":["asn","org_name","country_code"],"type":"object"},"type":"array"},"events":{"items":{"properties":{"confidence_score":{"type":"integer"},"duration":{"type":"integer"},"event_type":{"type":"integer"},"hijack_msgs_count":{"type":"integer"},"hijacker_asn":{"type":"integer"},"hijacker_country":{"type":"string"},"id":{"type":"integer"},"is_stale":{"type":"boolean"},"max_hijack_ts":{"type":"string"},"max_msg_ts":{"type":"string"},"min_hijack_ts":{"type":"string"},"on_going_count":{"type":"integer"},"peer_asns":{"items":{"type":"integer"},"type":"array"},"peer_ip_count":{"type":"integer"},"prefixes":{"items":{"type":"string"},"type":"array"},"tags":{"items":{"properties":{"name":{"type":"string"},"score":{"type":"integer"}},"required":["name","score"],"type":"object"},"type":"array"},"victim_asns":{"items":{"type":"integer"},"type":"array"},"victim_countries":{"items":{"type":"string"},"type":"array"}},"required":["duration","event_type","hijack_msgs_count","hijacker_asn","hijacker_country","victim_asns","victim_countries","id","is_stale","max_hijack_ts","min_hijack_ts","max_msg_ts","on_going_count","peer_asns","peer_ip_count","prefixes","confidence_score","tags"],"type":"object"},"type":"array"},"total_monitors":{"type":"integer"}},"required":["asn_info","events","total_monitors"],"type":"object"},"result_info":{"properties":{"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_count":{"type":"integer"}},"required":["count","total_count","page","per_page"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","result_info","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get BGP hijack events","tags":["Radar BGP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/ips/timeseries":{"get":{"description":"Retrieves time series data for the announced IP space count, represented as the number of IPv4 /24s and IPv6 /48s, for a given ASN.","operationId":"radar-get-bgp-ips-timeseries","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 location codes.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 location codes.","example":"US","items":{"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Includes data delay meta information.","in":"query","name":"includeDelay","schema":{"description":"Includes data delay meta information.","type":"boolean"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"delay":{"properties":{"asn_data":{"properties":{"delaySecs":{"type":"number"},"delayStr":{"type":"string"},"healthy":{"type":"boolean"},"latest":{"properties":{"entries_count":{"type":"number"},"path":{"type":"string"},"timestamp":{"type":"number"}},"required":["timestamp","path","entries_count"],"type":"object"}},"required":["delaySecs","delayStr","healthy","latest"],"type":"object"},"country_data":{"properties":{"delaySecs":{"type":"number"},"delayStr":{"type":"string"},"healthy":{"type":"boolean"},"latest":{"properties":{"count":{"type":"number"},"timestamp":{"type":"number"}},"required":["timestamp","count"],"type":"object"}},"required":["delaySecs","delayStr","healthy","latest"],"type":"object"},"healthy":{"type":"boolean"},"nowTs":{"type":"number"}},"required":["nowTs","healthy","asn_data","country_data"],"type":"object"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"ipv4":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"ipv6":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","ipv4","ipv6"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get announced IP address space time series","tags":["Radar BGP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/leaks/events":{"get":{"description":"Retrieves the BGP route leak events.","operationId":"radar-get-bgp-route-leak-events","parameters":[{"description":"Current page number, starting from 1.","in":"query","name":"page","schema":{"default":1,"description":"Current page number, starting from 1.","exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Number of entries per page.","in":"query","name":"per_page","schema":{"default":50,"description":"Number of entries per page.","exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"The unique identifier of a event.","in":"query","name":"eventId","schema":{"description":"The unique identifier of a event.","type":"integer"}},{"description":"The leaking AS of a route leak event.","in":"query","name":"leakAsn","schema":{"description":"The leaking AS of a route leak event.","type":"integer"}},{"description":"ASN that is causing or affected by a route leak event.","in":"query","name":"involvedAsn","schema":{"description":"ASN that is causing or affected by a route leak event.","type":"integer"}},{"description":"Country code of a involved ASN in a route leak event.","in":"query","name":"involvedCountry","schema":{"description":"Country code of a involved ASN in a route leak event.","type":"string"}},{"description":"Filters results by date range.","in":"query","name":"dateRange","schema":{"description":"Filters results by date range.","example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"}},{"description":"Start of the date range (inclusive).","in":"query","name":"dateStart","schema":{"description":"Start of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"description":"Sorts results by the specified field.","in":"query","name":"sortBy","schema":{"description":"Sorts results by the specified field.","enum":["ID","LEAKS","PEERS","PREFIXES","ORIGINS","TIME"],"example":"TIME","type":"string"}},{"description":"Sort order.","in":"query","name":"sortOrder","schema":{"description":"Sort order.","enum":["ASC","DESC"],"example":"desc","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"asn_info":{"items":{"properties":{"asn":{"type":"integer"},"country_code":{"type":"string"},"org_name":{"type":"string"}},"required":["asn","org_name","country_code"],"type":"object"},"type":"array"},"events":{"items":{"properties":{"countries":{"items":{"type":"string"},"type":"array"},"detected_ts":{"type":"string"},"finished":{"type":"boolean"},"id":{"type":"integer"},"leak_asn":{"type":"integer"},"leak_count":{"type":"integer"},"leak_seg":{"items":{"type":"integer"},"type":"array"},"leak_type":{"type":"integer"},"max_ts":{"type":"string"},"min_ts":{"type":"string"},"origin_count":{"type":"integer"},"peer_count":{"type":"integer"},"prefix_count":{"type":"integer"}},"required":["detected_ts","finished","id","leak_asn","leak_count","leak_seg","leak_type","max_ts","min_ts","origin_count","peer_count","prefix_count","countries"],"type":"object"},"type":"array"}},"required":["asn_info","events"],"type":"object"},"result_info":{"properties":{"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_count":{"type":"integer"}},"required":["count","total_count","page","per_page"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","result_info","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get BGP route leak events","tags":["Radar BGP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/routes/ases":{"get":{"description":"Retrieves all ASes in the current global routing tables with routing statistics.","operationId":"radar-get-bgp-routes-asns","parameters":[{"description":"Filters results by location. Specify an alpha-2 location code.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify an alpha-2 location code.","example":"US","maxLength":2,"minLength":2,"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Sorts results by the specified field.","in":"query","name":"sortBy","schema":{"description":"Sorts results by the specified field.","enum":["cone","pfxs","ipv4","ipv6","rpki_valid","rpki_invalid","rpki_unknown"],"example":"ipv4","type":"string"}},{"description":"Sort order.","in":"query","name":"sortOrder","schema":{"description":"Sort order.","enum":["ASC","DESC"],"example":"desc","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"asns":{"items":{"properties":{"asn":{"type":"integer"},"coneSize":{"description":"AS's customer cone size.","type":"integer"},"country":{"description":"Alpha-2 code for the AS's registration country.","example":"US","type":"string"},"ipv4Count":{"description":"Number of IPv4 addresses originated by the AS.","type":"integer"},"ipv6Count":{"description":"Number of IPv6 addresses originated by the AS.","example":"1.21e24","type":"string"},"name":{"description":"Name of the AS.","type":"string"},"pfxsCount":{"description":"Number of total IP prefixes originated by the AS.","type":"integer"},"rpkiInvalid":{"description":"Number of RPKI invalid prefixes originated by the AS.","type":"integer"},"rpkiUnknown":{"description":"Number of RPKI unknown prefixes originated by the AS.","type":"integer"},"rpkiValid":{"description":"Number of RPKI valid prefixes originated by the AS.","type":"integer"}},"required":["asn","name","coneSize","country","ipv4Count","ipv6Count","pfxsCount","rpkiValid","rpkiInvalid","rpkiUnknown"],"type":"object"},"type":"array"},"meta":{"properties":{"dataTime":{"description":"The timestamp of when the data is generated.","example":"2024-06-03T14:00:00","type":"string"},"queryTime":{"description":"The timestamp of the query.","example":"2024-06-03T14:00:00","type":"string"},"totalPeers":{"description":"Total number of route collector peers used to generate this data.","type":"integer"}},"required":["dataTime","queryTime","totalPeers"],"type":"object"}},"required":["asns","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List ASes from global routing tables","tags":["Radar BGP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/routes/moas":{"get":{"description":"Retrieves all Multi-Origin AS (MOAS) prefixes in the global routing tables.","operationId":"radar-get-bgp-pfx2as-moas","parameters":[{"description":"Lookup MOASes originated by the given ASN.","in":"query","name":"origin","schema":{"description":"Lookup MOASes originated by the given ASN.","type":"integer"}},{"in":"query","name":"prefix","schema":{"example":"1.1.1.0/24","type":"string"}},{"description":"Lookup only RPKI invalid MOASes.","in":"query","name":"invalid_only","schema":{"description":"Lookup only RPKI invalid MOASes.","type":"boolean"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"data_time":{"type":"string"},"query_time":{"type":"string"},"total_peers":{"type":"integer"}},"required":["data_time","query_time","total_peers"],"type":"object"},"moas":{"items":{"properties":{"origins":{"items":{"properties":{"origin":{"type":"integer"},"peer_count":{"type":"integer"},"rpki_validation":{"type":"string"}},"required":["origin","peer_count","rpki_validation"],"type":"object"},"type":"array"},"prefix":{"type":"string"}},"required":["prefix","origins"],"type":"object"},"type":"array"}},"required":["moas","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Multi-Origin AS (MOAS) prefixes","tags":["Radar BGP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/routes/pfx2as":{"get":{"description":"Retrieves the prefix-to-ASN mapping from global routing tables.","operationId":"radar-get-bgp-pfx2as","parameters":[{"in":"query","name":"prefix","schema":{"example":"1.1.1.0/24","type":"string"}},{"description":"Lookup prefixes originated by the given ASN.","in":"query","name":"origin","schema":{"description":"Lookup prefixes originated by the given ASN.","type":"integer"}},{"description":"Return only results with matching rpki status: valid, invalid or unknown.","in":"query","name":"rpkiStatus","schema":{"description":"Return only results with matching rpki status: valid, invalid or unknown.","enum":["VALID","INVALID","UNKNOWN"],"example":"INVALID","type":"string"}},{"description":"Return only results with the longest prefix match for the given prefix. For example, specify a /32 prefix to lookup the origin ASN for an IPv4 address.","in":"query","name":"longestPrefixMatch","schema":{"description":"Return only results with the longest prefix match for the given prefix. For example, specify a /32 prefix to lookup the origin ASN for an IPv4 address.","example":"true","type":"boolean"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"data_time":{"type":"string"},"query_time":{"type":"string"},"total_peers":{"type":"integer"}},"required":["data_time","query_time","total_peers"],"type":"object"},"prefix_origins":{"items":{"properties":{"origin":{"type":"integer"},"peer_count":{"type":"integer"},"prefix":{"type":"string"},"rpki_validation":{"type":"string"}},"required":["origin","peer_count","prefix","rpki_validation"],"type":"object"},"type":"array"}},"required":["prefix_origins","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get prefix-to-ASN mapping","tags":["Radar BGP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/routes/realtime":{"get":{"description":"Retrieves real-time BGP routes for a prefix, using public real-time data collectors (RouteViews and RIPE RIS).","operationId":"radar-get-bgp-routes-realtime","parameters":[{"in":"query","name":"prefix","schema":{"example":"1.1.1.0/24","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"asn_info":{"items":{"properties":{"as_name":{"description":"Name of the autonomous system.","type":"string"},"asn":{"description":"AS number.","type":"integer"},"country_code":{"description":"Alpha-2 code for the AS's registration country.","type":"string"},"org_id":{"description":"Organization ID.","type":"string"},"org_name":{"description":"Organization name.","type":"string"}},"required":["asn","as_name","country_code","org_id","org_name"],"type":"object"},"type":"array"},"collectors":{"items":{"properties":{"collector":{"description":"Public route collector ID.","type":"string"},"latest_realtime_ts":{"description":"Latest real-time stream timestamp for this collector.","type":"string"},"latest_rib_ts":{"description":"Latest RIB dump MRT file timestamp for this collector.","type":"string"},"latest_updates_ts":{"description":"Latest BGP updates MRT file timestamp for this collector.","type":"string"},"peers_count":{"description":"Total number of collector peers used from this collector.","type":"integer"},"peers_v4_count":{"description":"Total number of collector peers used from this collector for IPv4 prefixes.","type":"integer"},"peers_v6_count":{"description":"Total number of collector peers used from this collector for IPv6 prefixes.","type":"integer"}},"required":["collector","latest_realtime_ts","latest_updates_ts","latest_rib_ts","peers_count","peers_v4_count","peers_v6_count"],"type":"object"},"type":"array"},"data_time":{"description":"The most recent data timestamp for from the real-time sources.","type":"string"},"prefix_origins":{"items":{"properties":{"origin":{"description":"Origin ASN.","type":"integer"},"prefix":{"description":"IP prefix of this query.","type":"string"},"rpki_validation":{"description":"Prefix-origin RPKI validation: valid, invalid, unknown.","type":"string"},"total_peers":{"description":"Total number of peers.","type":"integer"},"total_visible":{"description":"Total number of peers seeing this prefix.","type":"integer"},"visibility":{"description":"Ratio of peers seeing this prefix to total number of peers.","type":"number"}},"required":["origin","prefix","rpki_validation","total_peers","total_visible","visibility"],"type":"object"},"type":"array"},"query_time":{"description":"The timestamp of this query.","type":"string"}},"required":["collectors","asn_info","prefix_origins","data_time","query_time"],"type":"object"},"routes":{"items":{"properties":{"as_path":{"description":"AS-level path for this route, from collector to origin.","items":{"type":"integer"},"type":"array"},"collector":{"description":"Public collector ID for this route.","type":"string"},"communities":{"description":"BGP community values.","items":{"type":"string"},"type":"array"},"prefix":{"description":"IP prefix of this query.","type":"string"},"timestamp":{"description":"Latest timestamp of change for this route.","type":"string"}},"required":["timestamp","collector","prefix","as_path","communities"],"type":"object"},"type":"array"}},"required":["routes","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get real-time BGP routes for a prefix","tags":["Radar BGP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/routes/stats":{"get":{"description":"Retrieves the BGP routing table stats.","operationId":"radar-get-bgp-routes-stats","parameters":[{"description":"Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.","example":174,"type":"integer"}},{"description":"Filters results by location. Specify an alpha-2 location code.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify an alpha-2 location code.","example":"US","maxLength":2,"minLength":2,"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"data_time":{"type":"string"},"query_time":{"type":"string"},"total_peers":{"type":"integer"}},"required":["data_time","query_time","total_peers"],"type":"object"},"stats":{"properties":{"distinct_origins":{"type":"integer"},"distinct_origins_ipv4":{"type":"integer"},"distinct_origins_ipv6":{"type":"integer"},"distinct_prefixes":{"type":"integer"},"distinct_prefixes_ipv4":{"type":"integer"},"distinct_prefixes_ipv6":{"type":"integer"},"routes_invalid":{"type":"integer"},"routes_invalid_ipv4":{"type":"integer"},"routes_invalid_ipv6":{"type":"integer"},"routes_total":{"type":"integer"},"routes_total_ipv4":{"type":"integer"},"routes_total_ipv6":{"type":"integer"},"routes_unknown":{"type":"integer"},"routes_unknown_ipv4":{"type":"integer"},"routes_unknown_ipv6":{"type":"integer"},"routes_valid":{"type":"integer"},"routes_valid_ipv4":{"type":"integer"},"routes_valid_ipv6":{"type":"integer"}},"required":["distinct_origins","distinct_origins_ipv4","distinct_origins_ipv6","distinct_prefixes","distinct_prefixes_ipv4","distinct_prefixes_ipv6","routes_invalid","routes_invalid_ipv4","routes_invalid_ipv6","routes_total","routes_total_ipv4","routes_total_ipv6","routes_unknown","routes_unknown_ipv4","routes_unknown_ipv6","routes_valid","routes_valid_ipv4","routes_valid_ipv6"],"type":"object"}},"required":["stats","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get BGP routing table stats ","tags":["Radar BGP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/timeseries":{"get":{"description":"Retrieves BGP updates over time. When requesting updates for an autonomous system, only BGP updates of type announcement are returned.","operationId":"radar-get-bgp-timeseries","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by BGP network prefix.","in":"query","name":"prefix","schema":{"description":"Filters results by BGP network prefix.","example":"1.1.1.0/24","items":{"type":"string"},"type":"array"}},{"description":"Filters results by BGP update type.","in":"query","name":"updateType","schema":{"description":"Filters results by BGP update type.","example":"ANNOUNCEMENT","items":{"enum":["ANNOUNCEMENT","WITHDRAWAL"],"type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"aggInterval":{"enum":["15m","1h","1d","1w"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"format":"date-time","type":"string"}},"required":["confidenceInfo","dateRange","aggInterval","lastUpdated"],"type":"object"},"serie_0":{"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"},"values":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get BGP time series","tags":["Radar BGP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/top/ases":{"get":{"description":"Retrieves the top autonomous systems by BGP updates (announcements only).","operationId":"radar-get-bgp-top-ases","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by BGP network prefix.","in":"query","name":"prefix","schema":{"description":"Filters results by BGP network prefix.","example":"1.1.1.0/24","items":{"type":"string"},"type":"array"}},{"description":"Filters results by BGP update type.","in":"query","name":"updateType","schema":{"description":"Filters results by BGP update type.","example":"ANNOUNCEMENT","items":{"enum":["ANNOUNCEMENT","WITHDRAWAL"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"}},"required":["dateRange"],"type":"object"},"top_0":{"items":{"properties":{"ASName":{"example":"Apple-Engineering","type":"string"},"asn":{"example":714,"type":"integer"},"value":{"description":"Percentage of updates by this AS out of the total updates by all autonomous systems.","example":"0.73996","type":"string"}},"required":["asn","ASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by BGP updates","tags":["Radar BGP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/top/ases/prefixes":{"get":{"description":"Retrieves the full list of autonomous systems on the global routing table ordered by announced prefixes count. The data comes from public BGP MRT data archives and updates every 2 hours.","operationId":"radar-get-bgp-top-asns-by-prefixes","parameters":[{"description":"Alpha-2 country code.","in":"query","name":"country","schema":{"description":"Alpha-2 country code.","example":"NZ","type":"string"}},{"description":"Maximum number of ASes to return.","in":"query","name":"limit","schema":{"description":"Maximum number of ASes to return.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"asns":{"items":{"properties":{"asn":{"type":"integer"},"country":{"type":"string"},"name":{"type":"string"},"pfxs_count":{"type":"integer"}},"required":["asn","country","name","pfxs_count"],"type":"object"},"type":"array"},"meta":{"properties":{"data_time":{"type":"string"},"query_time":{"type":"string"},"total_peers":{"type":"integer"}},"required":["data_time","query_time","total_peers"],"type":"object"}},"required":["asns","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by prefix count","tags":["Radar BGP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/top/prefixes":{"get":{"description":"Retrieves the top network prefixes by BGP updates.","operationId":"radar-get-bgp-top-prefixes","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by BGP update type.","in":"query","name":"updateType","schema":{"description":"Filters results by BGP update type.","example":"ANNOUNCEMENT","items":{"enum":["ANNOUNCEMENT","WITHDRAWAL"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"}},"required":["dateRange"],"type":"object"},"top_0":{"items":{"properties":{"prefix":{"example":"2804:77cc:8000::/33","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["prefix","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top prefixes by BGP updates","tags":["Radar BGP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bots":{"get":{"description":"Retrieves a list of bots.","operationId":"radar-get-bots","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Skips the specified number of objects before fetching the results.","in":"query","name":"offset","schema":{"description":"Skips the specified number of objects before fetching the results.","minimum":0,"type":"integer"}},{"description":"Filters results by bot category.","in":"query","name":"botCategory","schema":{"description":"Filters results by bot category.","enum":["SEARCH_ENGINE_CRAWLER","SEARCH_ENGINE_OPTIMIZATION","MONITORING_AND_ANALYTICS","ADVERTISING_AND_MARKETING","SOCIAL_MEDIA_MARKETING","PAGE_PREVIEW","ACADEMIC_RESEARCH","SECURITY","ACCESSIBILITY","WEBHOOKS","FEED_FETCHER","AI_CRAWLER","AGGREGATOR","AI_ASSISTANT","AI_SEARCH","ARCHIVER"],"type":"string"}},{"description":"Filters results by bot operator.","in":"query","name":"botOperator","schema":{"description":"Filters results by bot operator.","maxLength":100,"type":"string"}},{"description":"Filters results by bot kind.","in":"query","name":"kind","schema":{"description":"Filters results by bot kind.","enum":["AGENT","BOT"],"type":"string"}},{"description":"Filters results by bot verification status.","in":"query","name":"botVerificationStatus","schema":{"description":"Filters results by bot verification status.","enum":["VERIFIED"],"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"bots":{"items":{"properties":{"category":{"description":"The category of the bot.","example":"AI_CRAWLER","type":"string"},"description":{"description":"A summary for the bot (e.g., purpose).","example":"OpenAI/ChatGPT's web crawler","type":"string"},"kind":{"description":"The kind of the bot.","example":"AGENT","type":"string"},"name":{"description":"The name of the bot.","example":"GPTBot","type":"string"},"operator":{"description":"The organization that owns and operates the bot.","example":"OpenAI","type":"string"},"slug":{"description":"A kebab-case identifier derived from the bot name.","example":"gptbot","type":"string"},"userAgentPatterns":{"items":{"description":"User agent patterns that identify the bot in web traffic.","example":"GPTBot","type":"string"},"type":"array"}},"required":["slug","name","description","kind","operator","category","userAgentPatterns"],"type":"object"},"type":"array"}},"required":["bots"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List bots","tags":["Radar Bots"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bots/crawlers/summary/{dimension}":{"get":{"description":"Retrieves an aggregated summary of HTTP requests from crawlers, grouped by the specified dimension.","operationId":"radar-get-crawlers-summary","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["USER_AGENT","REFERER","CRAWL_REFER_RATIO","VERTICAL","INDUSTRY"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Filters results by bot operator.","in":"query","name":"botOperator","schema":{"description":"Filters results by bot operator.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by vertical.","in":"query","name":"vertical","schema":{"description":"Filters results by vertical.","items":{"maxLength":2000,"type":"string"},"type":"array"}},{"description":"Filters results by industry.","in":"query","name":"industry","schema":{"description":"Filters results by industry.","items":{"maxLength":2000,"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string that can include decimals and infinity values.","example":"10.5","pattern":"^-?(?:\\d+(?:\\.\\d+)?|inf)$","type":"string"},"example":{"Claude":"63.40249","DuckDuckGo":"10.274394","Google":"8.381743"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get crawler HTTP request distribution by dimension","tags":["Radar Web Crawlers"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bots/crawlers/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of HTTP requests from crawlers, grouped by chosen the specified dimension over time.","operationId":"radar-get-crawlers-timeseries-group","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["USER_AGENT","REFERER","CRAWL_REFER_RATIO","VERTICAL","INDUSTRY"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Filters results by bot operator.","in":"query","name":"botOperator","schema":{"description":"Filters results by bot operator.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by vertical.","in":"query","name":"vertical","schema":{"description":"Filters results by vertical.","items":{"maxLength":2000,"type":"string"},"type":"array"}},{"description":"Filters results by industry.","in":"query","name":"industry","schema":{"description":"Filters results by industry.","items":{"maxLength":2000,"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string that can include decimals and infinity values.","example":"10.5","pattern":"^-?(?:\\d+(?:\\.\\d+)?|inf)$","type":"string"},"type":"array"},"example":{"Claude":["63.40249"],"DuckDuckGo":["10.274394"],"Google":["8.381743"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get time series of crawler HTTP request distribution by dimension","tags":["Radar Web Crawlers"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bots/summary/{dimension}":{"get":{"description":"Retrieves an aggregated summary of bots HTTP requests grouped by the specified dimension.","operationId":"radar-get-bots-summary","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["BOT","BOT_KIND","BOT_OPERATOR","BOT_CATEGORY"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Filters results by bot name.","in":"query","name":"bot","schema":{"description":"Filters results by bot name.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by bot operator.","in":"query","name":"botOperator","schema":{"description":"Filters results by bot operator.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by bot category.","in":"query","name":"botCategory","schema":{"description":"Filters results by bot category.","items":{"description":"The category of the bot.","enum":["SEARCH_ENGINE_CRAWLER","SEARCH_ENGINE_OPTIMIZATION","MONITORING_AND_ANALYTICS","ADVERTISING_AND_MARKETING","SOCIAL_MEDIA_MARKETING","PAGE_PREVIEW","ACADEMIC_RESEARCH","SECURITY","ACCESSIBILITY","WEBHOOKS","FEED_FETCHER","AI_CRAWLER","AGGREGATOR","AI_ASSISTANT","AI_SEARCH","ARCHIVER"],"type":"string"},"type":"array"}},{"description":"Filters results by bot kind.","in":"query","name":"botKind","schema":{"description":"Filters results by bot kind.","items":{"enum":["AGENT","BOT"],"type":"string"},"type":"array"}},{"description":"Filters results by bot verification status (Verified vs. Unverified).","in":"query","name":"botVerificationStatus","schema":{"description":"Filters results by bot verification status (Verified vs. Unverified).","items":{"description":"The category of the bot.","enum":["VERIFIED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"Facebook":"10.274394","GPTBot":"63.40249","GoogleBot":"8.381743"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get bots HTTP requests distribution by dimension","tags":["Radar Bots"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bots/timeseries":{"get":{"description":"Retrieves bots HTTP request volume over time.","operationId":"radar-get-bots-timeseries","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot name.","in":"query","name":"bot","schema":{"description":"Filters results by bot name.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by bot operator.","in":"query","name":"botOperator","schema":{"description":"Filters results by bot operator.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by bot category.","in":"query","name":"botCategory","schema":{"description":"Filters results by bot category.","items":{"description":"The category of the bot.","enum":["SEARCH_ENGINE_CRAWLER","SEARCH_ENGINE_OPTIMIZATION","MONITORING_AND_ANALYTICS","ADVERTISING_AND_MARKETING","SOCIAL_MEDIA_MARKETING","PAGE_PREVIEW","ACADEMIC_RESEARCH","SECURITY","ACCESSIBILITY","WEBHOOKS","FEED_FETCHER","AI_CRAWLER","AGGREGATOR","AI_ASSISTANT","AI_SEARCH","ARCHIVER"],"type":"string"},"type":"array"}},{"description":"Filters results by bot kind.","in":"query","name":"botKind","schema":{"description":"Filters results by bot kind.","items":{"enum":["AGENT","BOT"],"type":"string"},"type":"array"}},{"description":"Filters results by bot verification status (Verified vs. Unverified).","in":"query","name":"botVerificationStatus","schema":{"description":"Filters results by bot verification status (Verified vs. Unverified).","items":{"description":"The category of the bot.","enum":["VERIFIED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"additionalProperties":{"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"},"values":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"},"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"}},"required":["meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get bots HTTP requests time series","tags":["Radar Bots"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bots/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of HTTP requests from bots, grouped by chosen the specified dimension over time.","operationId":"radar-get-bots-timeseries-group","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["BOT","BOT_KIND","BOT_OPERATOR","BOT_CATEGORY"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Filters results by bot name.","in":"query","name":"bot","schema":{"description":"Filters results by bot name.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by bot operator.","in":"query","name":"botOperator","schema":{"description":"Filters results by bot operator.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by bot category.","in":"query","name":"botCategory","schema":{"description":"Filters results by bot category.","items":{"description":"The category of the bot.","enum":["SEARCH_ENGINE_CRAWLER","SEARCH_ENGINE_OPTIMIZATION","MONITORING_AND_ANALYTICS","ADVERTISING_AND_MARKETING","SOCIAL_MEDIA_MARKETING","PAGE_PREVIEW","ACADEMIC_RESEARCH","SECURITY","ACCESSIBILITY","WEBHOOKS","FEED_FETCHER","AI_CRAWLER","AGGREGATOR","AI_ASSISTANT","AI_SEARCH","ARCHIVER"],"type":"string"},"type":"array"}},{"description":"Filters results by bot kind.","in":"query","name":"botKind","schema":{"description":"Filters results by bot kind.","items":{"enum":["AGENT","BOT"],"type":"string"},"type":"array"}},{"description":"Filters results by bot verification status (Verified vs. Unverified).","in":"query","name":"botVerificationStatus","schema":{"description":"Filters results by bot verification status (Verified vs. Unverified).","items":{"description":"The category of the bot.","enum":["VERIFIED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"Facebook":["10.274394"],"GPTBot":["63.40249"],"GoogleBot":["8.381743"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get time series distribution of bots HTTP requests by dimension.","tags":["Radar Bots"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bots/{bot_slug}":{"get":{"description":"Retrieves the requested bot information.","operationId":"radar-get-bot-details","parameters":[{"description":"Bot slug.","in":"path","name":"bot_slug","required":true,"schema":{"description":"Bot slug.","example":"gptbot","maxLength":100,"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"bot":{"properties":{"category":{"description":"The category of the bot.","example":"AI_CRAWLER","type":"string"},"description":{"description":"A summary for the bot (e.g., purpose).","example":"OpenAI/ChatGPT's web crawler","type":"string"},"kind":{"description":"The kind of the bot.","example":"AGENT","type":"string"},"name":{"description":"The name of the bot.","example":"GPTBot","type":"string"},"operator":{"description":"The organization that owns and operates the bot.","example":"OpenAI","type":"string"},"operatorUrl":{"description":"The link to the bot documentation.","example":"https://platform.openai.com/docs/bots","type":"string"},"slug":{"description":"A kebab-case identifier derived from the bot name.","example":"gptbot","type":"string"},"userAgentPatterns":{"items":{"description":"User agent patterns that identify the bot in web traffic.","example":"GPTBot","type":"string"},"type":"array"},"userAgents":{"items":{"description":"User agent strings used by this bot in HTTP requests.","example":"GPTBot","type":"string"},"type":"array"}},"required":["slug","name","description","kind","operator","operatorUrl","category","userAgents","userAgentPatterns"],"type":"object"}},"required":["bot"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get bot details","tags":["Radar Bots"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ct/authorities":{"get":{"description":"Retrieves a list of certificate authorities.","operationId":"radar-get-certificate-authorities","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Skips the specified number of objects before fetching the results.","in":"query","name":"offset","schema":{"description":"Skips the specified number of objects before fetching the results.","minimum":0,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"certificateAuthorities":{"items":{"properties":{"certificateRecordType":{"description":"Specifies the type of certificate in the trust chain.","enum":["ROOT_CERTIFICATE","INTERMEDIATE_CERTIFICATE"],"type":"string"},"country":{"description":"The two-letter ISO country code where the CA organization is based.","example":"PT","type":"string"},"countryName":{"description":"The full country name corresponding to the country code.","example":"Portugal","type":"string"},"name":{"description":"The full name of the certificate authority (CA).","example":"MULTICERT Advanced Certification Authority 005","type":"string"},"owner":{"description":"The organization that owns and operates the CA.","example":"MULTICERT","type":"string"},"parentName":{"description":"The name of the parent/root certificate authority that issued this intermediate certificate.","example":"MULTICERT Root Certification Authority 01","type":"string"},"parentSha256Fingerprint":{"description":"The SHA-256 fingerprint of the parent certificate.","example":"24EDD4E503A8D3FDB5FFB4AF66C887359901CBE687A5A0760D10A08EED99A7C3","type":"string"},"revocationStatus":{"description":"The current revocation status of a Certificate Authority (CA) certificate.","enum":["NOT_REVOKED","REVOKED","PARENT_CERT_REVOKED"],"type":"string"},"sha256Fingerprint":{"description":"The SHA-256 fingerprint of the intermediate certificate.","example":"24EDD4E503A8D3FDB5FFB4AF66C887359901CBE687A5A0760D10A08EED99A7C3","type":"string"}},"required":["sha256Fingerprint","name","owner","parentName","parentSha256Fingerprint","certificateRecordType","country","countryName","revocationStatus"],"type":"object"},"type":"array"}},"required":["certificateAuthorities"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List certificate authorities","tags":["Radar Certificate Transparency"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ct/authorities/{ca_slug}":{"get":{"description":"Retrieves the requested CA information.","operationId":"radar-get-certificate-authority-details","parameters":[{"description":"Certificate authority SHA256 fingerprint.","in":"path","name":"ca_slug","required":true,"schema":{"description":"Certificate authority SHA256 fingerprint.","example":"24EDD4E503A8D3FDB5FFB4AF66C887359901CBE687A5A0760D10A08EED99A7C3","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"certificateAuthority":{"properties":{"appleStatus":{"description":"The inclusion status of a Certificate Authority (CA) in the trust store.","enum":["INCLUDED","NOT_YET_INCLUDED","NOT_INCLUDED","NOT_BEFORE","REMOVED","DISABLED","BLOCKED"],"type":"string"},"authorityKeyIdentifier":{"description":"The authorityKeyIdentifier value extracted from the certificate PEM.","example":"1TkcnFtvBKqilUzvIN0pdKTFRXE","type":"string"},"certificateRecordType":{"description":"Specifies the type of certificate in the trust chain.","enum":["ROOT_CERTIFICATE","INTERMEDIATE_CERTIFICATE"],"type":"string"},"chromeStatus":{"description":"The inclusion status of a Certificate Authority (CA) in the trust store.","enum":["INCLUDED","NOT_YET_INCLUDED","NOT_INCLUDED","NOT_BEFORE","REMOVED","DISABLED","BLOCKED"],"type":"string"},"country":{"description":"The two-letter ISO country code where the CA organization is based.","example":"PT","type":"string"},"countryName":{"description":"The full country name corresponding to the country code.","example":"Portugal","type":"string"},"microsoftStatus":{"description":"The inclusion status of a Certificate Authority (CA) in the trust store.","enum":["INCLUDED","NOT_YET_INCLUDED","NOT_INCLUDED","NOT_BEFORE","REMOVED","DISABLED","BLOCKED"],"type":"string"},"mozillaStatus":{"description":"The inclusion status of a Certificate Authority (CA) in the trust store.","enum":["INCLUDED","NOT_YET_INCLUDED","NOT_INCLUDED","NOT_BEFORE","REMOVED","DISABLED","BLOCKED"],"type":"string"},"name":{"description":"The full name of the certificate authority (CA).","example":"MULTICERT Advanced Certification Authority 005","type":"string"},"owner":{"description":"The organization that owns and operates the CA.","example":"MULTICERT","type":"string"},"parentName":{"description":"The name of the parent/root certificate authority that issued this intermediate certificate.","example":"MULTICERT Root Certification Authority 01","type":"string"},"parentSha256Fingerprint":{"description":"The SHA-256 fingerprint of the parent certificate.","example":"604D32D036895AED3BFEFAEB727C009EC0F2B3CDFA42A1C71730E6A72C3BE9D4","type":"string"},"related":{"description":"CAs from the same owner.","items":{"properties":{"certificateRecordType":{"description":"Specifies the type of certificate in the trust chain.","enum":["ROOT_CERTIFICATE","INTERMEDIATE_CERTIFICATE"],"type":"string"},"name":{"description":"The full name of the certificate authority (CA).","example":"MULTICERT Advanced Certification Authority 005","type":"string"},"revocationStatus":{"description":"The current revocation status of a Certificate Authority (CA) certificate.","enum":["NOT_REVOKED","REVOKED","PARENT_CERT_REVOKED"],"type":"string"},"sha256Fingerprint":{"description":"The SHA-256 fingerprint of the intermediate certificate.","example":"24EDD4E503A8D3FDB5FFB4AF66C887359901CBE687A5A0760D10A08EED99A7C3","type":"string"}},"required":["sha256Fingerprint","name","revocationStatus","certificateRecordType"],"type":"object"},"type":"array"},"revocationStatus":{"description":"The current revocation status of a Certificate Authority (CA) certificate.","enum":["NOT_REVOKED","REVOKED","PARENT_CERT_REVOKED"],"type":"string"},"sha256Fingerprint":{"description":"The SHA-256 fingerprint of the intermediate certificate.","example":"24EDD4E503A8D3FDB5FFB4AF66C887359901CBE687A5A0760D10A08EED99A7C3","type":"string"},"subjectKeyIdentifier":{"description":"The subjectKeyIdentifier value extracted from the certificate PEM.","example":"VbqXmCURhMmiMtD7nFY6iCr4z","type":"string"},"validFrom":{"description":"The start date of the certificate’s validity period (ISO format).","example":"2019-12-09","type":"string"},"validTo":{"description":"The end date of the certificate’s validity period (ISO format).","example":"2032-06-08","type":"string"}},"required":["sha256Fingerprint","name","owner","parentName","parentSha256Fingerprint","certificateRecordType","country","countryName","chromeStatus","appleStatus","microsoftStatus","mozillaStatus","revocationStatus","validFrom","validTo","authorityKeyIdentifier","subjectKeyIdentifier","related"],"type":"object"}},"required":["certificateAuthority"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get certificate authority details","tags":["Radar Certificate Transparency"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ct/logs":{"get":{"description":"Retrieves a list of certificate logs.","operationId":"radar-get-certificate-logs","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Skips the specified number of objects before fetching the results.","in":"query","name":"offset","schema":{"description":"Skips the specified number of objects before fetching the results.","minimum":0,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"certificateLogs":{"items":{"properties":{"api":{"description":"The API standard that the certificate log follows.","enum":["RFC6962","STATIC"],"type":"string"},"description":{"description":"A brief description of the certificate log.","example":"Google 'Argon2024' log","type":"string"},"endExclusive":{"description":"The end date and time for when the log will stop accepting certificates.","example":"2025-01-01T00:00:00Z","format":"date-time","type":"string"},"operator":{"description":"The organization responsible for operating the certificate log.","example":"Google","type":"string"},"slug":{"description":"A URL-friendly, kebab-case identifier for the certificate log.","example":"argon2024","type":"string"},"startInclusive":{"description":"The start date and time for when the log starts accepting certificates.","example":"2024-01-01T00:00:00Z","format":"date-time","type":"string"},"state":{"description":"The current state of the certificate log. More details about log states can be found here: https://googlechrome.github.io/CertificateTransparency/log_states.html","enum":["USABLE","PENDING","QUALIFIED","READ_ONLY","RETIRED","REJECTED"],"type":"string"},"stateTimestamp":{"description":"Timestamp of when the log state was last updated.","example":"2025-02-01T08:53:20Z","format":"date-time","type":"string"},"url":{"description":"The URL for the certificate log.","example":"https://ct.googleapis.com/logs/us1/argon2024/","type":"string"}},"required":["slug","description","operator","api","state","stateTimestamp","startInclusive","endExclusive","url"],"type":"object"},"type":"array"}},"required":["certificateLogs"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List certificate logs","tags":["Radar Certificate Transparency"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ct/logs/{log_slug}":{"get":{"description":"Retrieves the requested certificate log information.","operationId":"radar-get-certificate-log-details","parameters":[{"description":"Certificate log slug.","in":"path","name":"log_slug","required":true,"schema":{"description":"Certificate log slug.","example":"argon2024","maxLength":100,"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"certificateLog":{"properties":{"api":{"description":"The API standard that the certificate log follows.","enum":["RFC6962","STATIC"],"type":"string"},"avgThroughput":{"description":"The average throughput of the CT log, measured in certificates per hour (certs/hour).","type":"number"},"description":{"description":"A brief description of the certificate log.","example":"Google 'Argon2024' log","type":"string"},"endExclusive":{"description":"The end date and time for when the log will stop accepting certificates.","example":"2025-01-01T00:00:00Z","format":"date-time","type":"string"},"lastUpdate":{"description":"Timestamp of the most recent update to the CT log.","example":"2025-01-01T00:00:00Z","format":"date-time","type":"string"},"operator":{"description":"The organization responsible for operating the certificate log.","example":"Google","type":"string"},"performance":{"description":"Log performance metrics, including averages and per-endpoint details.","nullable":true,"properties":{"endpoints":{"items":{"properties":{"endpoint":{"description":"The certificate log endpoint names used in performance metrics.","enum":["add-chain (new)","add-chain (old)","add-pre-chain (new)","add-pre-chain (old)","get-entries","get-roots","get-sth"],"type":"string"},"responseTime":{"type":"number"},"uptime":{"type":"number"}},"required":["endpoint","responseTime","uptime"],"type":"object"},"type":"array"},"responseTime":{"type":"number"},"uptime":{"type":"number"}},"required":["responseTime","uptime","endpoints"],"type":"object"},"related":{"description":"Logs from the same operator.","items":{"properties":{"description":{"description":"A brief description of the certificate log.","example":"Google 'Argon2024' log","type":"string"},"endExclusive":{"description":"The end date and time for when the log will stop accepting certificates.","example":"2025-01-01T00:00:00Z","format":"date-time","type":"string"},"slug":{"description":"A URL-friendly, kebab-case identifier for the certificate log.","example":"argon2024","type":"string"},"startInclusive":{"description":"The start date and time for when the log starts accepting certificates.","example":"2024-01-01T00:00:00Z","format":"date-time","type":"string"},"state":{"description":"The current state of the certificate log. More details about log states can be found here: https://googlechrome.github.io/CertificateTransparency/log_states.html","enum":["USABLE","PENDING","QUALIFIED","READ_ONLY","RETIRED","REJECTED"],"type":"string"}},"required":["slug","description","state","startInclusive","endExclusive"],"type":"object"},"type":"array"},"slug":{"description":"A URL-friendly, kebab-case identifier for the certificate log.","example":"argon2024","type":"string"},"startInclusive":{"description":"The start date and time for when the log starts accepting certificates.","example":"2024-01-01T00:00:00Z","format":"date-time","type":"string"},"state":{"description":"The current state of the certificate log. More details about log states can be found here: https://googlechrome.github.io/CertificateTransparency/log_states.html","enum":["USABLE","PENDING","QUALIFIED","READ_ONLY","RETIRED","REJECTED"],"type":"string"},"stateTimestamp":{"description":"Timestamp of when the log state was last updated.","example":"2025-02-01T08:53:20Z","format":"date-time","type":"string"},"submittableCertCount":{"description":"Number of certificates that are eligible for inclusion to this log but have not been included yet. Based on certificates signed by trusted root CAs within the log's accepted date range.","example":"10","nullable":true,"pattern":"^\\d+$","type":"string"},"submittedCertCount":{"description":"Number of certificates already included in this CT log.","example":"10","nullable":true,"pattern":"^\\d+$","type":"string"},"url":{"description":"The URL for the certificate log.","example":"https://ct.googleapis.com/logs/us1/argon2024/","type":"string"}},"required":["slug","description","operator","api","state","stateTimestamp","startInclusive","endExclusive","url","performance","avgThroughput","submittedCertCount","submittableCertCount","lastUpdate","related"],"type":"object"}},"required":["certificateLog"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get certificate log details","tags":["Radar Certificate Transparency"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ct/summary/{dimension}":{"get":{"description":"Retrieves an aggregated summary of certificates grouped by the specified dimension.","operationId":"radar-get-ct-summary","parameters":[{"description":"Specifies the certificate attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the certificate attribute by which to group the results.","enum":["CA","CA_OWNER","DURATION","ENTRY_TYPE","EXPIRATION_STATUS","HAS_IPS","HAS_WILDCARDS","LOG","LOG_API","LOG_OPERATOR","PUBLIC_KEY_ALGORITHM","SIGNATURE_ALGORITHM","TLD","VALIDATION_LEVEL"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Filters results by certificate authority.","in":"query","name":"ca","schema":{"description":"Filters results by certificate authority.","items":{"type":"string"},"type":"array"}},{"description":"Filters results by certificate authority owner.","in":"query","name":"caOwner","schema":{"description":"Filters results by certificate authority owner.","items":{"type":"string"},"type":"array"}},{"description":"Filters results by certificate duration.","in":"query","name":"duration","schema":{"description":"Filters results by certificate duration.","items":{"enum":["LTE_3D","GT_3D_LTE_7D","GT_7D_LTE_10D","GT_10D_LTE_47D","GT_47D_LTE_100D","GT_100D_LTE_200D","GT_200D"],"type":"string"},"type":"array"}},{"description":"Filters results by entry type (certificate vs. pre-certificate).","in":"query","name":"entryType","schema":{"description":"Filters results by entry type (certificate vs. pre-certificate).","items":{"enum":["PRECERTIFICATE","CERTIFICATE"],"type":"string"},"type":"array"}},{"description":"Filters results by expiration status (expired vs. valid).","in":"query","name":"expirationStatus","schema":{"description":"Filters results by expiration status (expired vs. valid).","items":{"enum":["EXPIRED","VALID"],"type":"string"},"type":"array"}},{"description":"Filters results based on whether the certificates are bound to specific IP addresses.","in":"query","name":"hasIps","schema":{"description":"Filters results based on whether the certificates are bound to specific IP addresses.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results based on whether the certificates contain wildcard domains.","in":"query","name":"hasWildcards","schema":{"description":"Filters results based on whether the certificates contain wildcard domains.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by certificate log.","in":"query","name":"log","schema":{"description":"Filters results by certificate log.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by certificate log API (RFC6962 vs. static).","in":"query","name":"logApi","schema":{"description":"Filters results by certificate log API (RFC6962 vs. static).","items":{"enum":["RFC6962","STATIC"],"type":"string"},"type":"array"}},{"description":"Filters results by certificate log operator.","in":"query","name":"logOperator","schema":{"description":"Filters results by certificate log operator.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by public key algorithm.","in":"query","name":"publicKeyAlgorithm","schema":{"description":"Filters results by public key algorithm.","items":{"enum":["DSA","ECDSA","RSA"],"type":"string"},"type":"array"}},{"description":"Filters results by signature algorithm.","in":"query","name":"signatureAlgorithm","schema":{"description":"Filters results by signature algorithm.","items":{"enum":["DSA_SHA_1","DSA_SHA_256","ECDSA_SHA_1","ECDSA_SHA_256","ECDSA_SHA_384","ECDSA_SHA_512","PSS_SHA_256","PSS_SHA_384","PSS_SHA_512","RSA_MD2","RSA_MD5","RSA_SHA_1","RSA_SHA_256","RSA_SHA_384","RSA_SHA_512"],"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by validation level.","in":"query","name":"validationLevel","schema":{"description":"Filters results by validation level.","items":{"enum":["DOMAIN","ORGANIZATION","EXTENDED"],"type":"string"},"type":"array"}},{"description":"Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only.","in":"query","name":"uniqueEntries","schema":{"description":"Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only.","items":{"enum":["true","false"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"RAW_VALUES","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["RAW_VALUES","PERCENTAGE"],"example":"RAW_VALUES","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"anyOf":[{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"DigiCert":"10.274394","GoDaddy":"8.381743","Internet Security Research Group":"63.40249"},"type":"object"},{"properties":{"rfc6962":{"type":"string"},"static":{"type":"string"}},"required":["rfc6962","static"],"type":"object"},{"properties":{"gt_121d":{"type":"string"},"gt_16d_lte_31d":{"type":"string"},"gt_31d_lte_91d":{"type":"string"},"gt_3d_lte_16d":{"type":"string"},"gt_91d_lte_121d":{"type":"string"},"lte_3d":{"type":"string"}},"required":["gt_31d_lte_91d","gt_121d","lte_3d","gt_91d_lte_121d","gt_16d_lte_31d","gt_3d_lte_16d"],"type":"object"},{"properties":{"CERTIFICATE":{"type":"string"},"PRECERTIFICATE":{"type":"string"}},"required":["CERTIFICATE","PRECERTIFICATE"],"type":"object"},{"properties":{"EXPIRED":{"type":"string"},"VALID":{"type":"string"}},"required":["VALID","EXPIRED"],"type":"object"},{"properties":{"NEGATIVE":{"type":"string"},"POSITIVE":{"type":"string"}},"required":["POSITIVE","NEGATIVE"],"type":"object"},{"properties":{"DSA":{"type":"string"},"ECDSA":{"type":"string"},"RSA":{"type":"string"}},"required":["RSA","ECDSA","DSA"],"type":"object"},{"properties":{"domain":{"type":"string"},"extended":{"type":"string"},"organization":{"type":"string"},"unknown":{"type":"string"}},"required":["domain","organization","unknown","extended"],"type":"object"}]}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get certificate distribution by dimension","tags":["Radar Certificate Transparency"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ct/timeseries":{"get":{"description":"Retrieves certificate volume over time.","operationId":"radar-get-ct-timeseries","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by certificate authority.","in":"query","name":"ca","schema":{"description":"Filters results by certificate authority.","items":{"type":"string"},"type":"array"}},{"description":"Filters results by certificate authority owner.","in":"query","name":"caOwner","schema":{"description":"Filters results by certificate authority owner.","items":{"type":"string"},"type":"array"}},{"description":"Filters results by certificate duration.","in":"query","name":"duration","schema":{"description":"Filters results by certificate duration.","items":{"enum":["LTE_3D","GT_3D_LTE_7D","GT_7D_LTE_10D","GT_10D_LTE_47D","GT_47D_LTE_100D","GT_100D_LTE_200D","GT_200D"],"type":"string"},"type":"array"}},{"description":"Filters results by entry type (certificate vs. pre-certificate).","in":"query","name":"entryType","schema":{"description":"Filters results by entry type (certificate vs. pre-certificate).","items":{"enum":["PRECERTIFICATE","CERTIFICATE"],"type":"string"},"type":"array"}},{"description":"Filters results by expiration status (expired vs. valid).","in":"query","name":"expirationStatus","schema":{"description":"Filters results by expiration status (expired vs. valid).","items":{"enum":["EXPIRED","VALID"],"type":"string"},"type":"array"}},{"description":"Filters results based on whether the certificates are bound to specific IP addresses.","in":"query","name":"hasIps","schema":{"description":"Filters results based on whether the certificates are bound to specific IP addresses.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results based on whether the certificates contain wildcard domains.","in":"query","name":"hasWildcards","schema":{"description":"Filters results based on whether the certificates contain wildcard domains.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by certificate log.","in":"query","name":"log","schema":{"description":"Filters results by certificate log.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by certificate log API (RFC6962 vs. static).","in":"query","name":"logApi","schema":{"description":"Filters results by certificate log API (RFC6962 vs. static).","items":{"enum":["RFC6962","STATIC"],"type":"string"},"type":"array"}},{"description":"Filters results by certificate log operator.","in":"query","name":"logOperator","schema":{"description":"Filters results by certificate log operator.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by public key algorithm.","in":"query","name":"publicKeyAlgorithm","schema":{"description":"Filters results by public key algorithm.","items":{"enum":["DSA","ECDSA","RSA"],"type":"string"},"type":"array"}},{"description":"Filters results by signature algorithm.","in":"query","name":"signatureAlgorithm","schema":{"description":"Filters results by signature algorithm.","items":{"enum":["DSA_SHA_1","DSA_SHA_256","ECDSA_SHA_1","ECDSA_SHA_256","ECDSA_SHA_384","ECDSA_SHA_512","PSS_SHA_256","PSS_SHA_384","PSS_SHA_512","RSA_MD2","RSA_MD5","RSA_SHA_1","RSA_SHA_256","RSA_SHA_384","RSA_SHA_512"],"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by validation level.","in":"query","name":"validationLevel","schema":{"description":"Filters results by validation level.","items":{"enum":["DOMAIN","ORGANIZATION","EXTENDED"],"type":"string"},"type":"array"}},{"description":"Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only.","in":"query","name":"uniqueEntries","schema":{"description":"Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only.","items":{"enum":["true","false"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"additionalProperties":{"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"},"values":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"},"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"}},"required":["meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get certificates time series","tags":["Radar Certificate Transparency"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ct/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of certificates grouped by chosen the specified dimension over time.","operationId":"radar-get-ct-timeseries-group","parameters":[{"description":"Specifies the certificate attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the certificate attribute by which to group the results.","enum":["CA","CA_OWNER","DURATION","ENTRY_TYPE","EXPIRATION_STATUS","HAS_IPS","HAS_WILDCARDS","LOG","LOG_API","LOG_OPERATOR","PUBLIC_KEY_ALGORITHM","SIGNATURE_ALGORITHM","TLD","VALIDATION_LEVEL"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Filters results by certificate authority.","in":"query","name":"ca","schema":{"description":"Filters results by certificate authority.","items":{"type":"string"},"type":"array"}},{"description":"Filters results by certificate authority owner.","in":"query","name":"caOwner","schema":{"description":"Filters results by certificate authority owner.","items":{"type":"string"},"type":"array"}},{"description":"Filters results by certificate duration.","in":"query","name":"duration","schema":{"description":"Filters results by certificate duration.","items":{"enum":["LTE_3D","GT_3D_LTE_7D","GT_7D_LTE_10D","GT_10D_LTE_47D","GT_47D_LTE_100D","GT_100D_LTE_200D","GT_200D"],"type":"string"},"type":"array"}},{"description":"Filters results by entry type (certificate vs. pre-certificate).","in":"query","name":"entryType","schema":{"description":"Filters results by entry type (certificate vs. pre-certificate).","items":{"enum":["PRECERTIFICATE","CERTIFICATE"],"type":"string"},"type":"array"}},{"description":"Filters results by expiration status (expired vs. valid).","in":"query","name":"expirationStatus","schema":{"description":"Filters results by expiration status (expired vs. valid).","items":{"enum":["EXPIRED","VALID"],"type":"string"},"type":"array"}},{"description":"Filters results based on whether the certificates are bound to specific IP addresses.","in":"query","name":"hasIps","schema":{"description":"Filters results based on whether the certificates are bound to specific IP addresses.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results based on whether the certificates contain wildcard domains.","in":"query","name":"hasWildcards","schema":{"description":"Filters results based on whether the certificates contain wildcard domains.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by certificate log.","in":"query","name":"log","schema":{"description":"Filters results by certificate log.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by certificate log API (RFC6962 vs. static).","in":"query","name":"logApi","schema":{"description":"Filters results by certificate log API (RFC6962 vs. static).","items":{"enum":["RFC6962","STATIC"],"type":"string"},"type":"array"}},{"description":"Filters results by certificate log operator.","in":"query","name":"logOperator","schema":{"description":"Filters results by certificate log operator.","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by public key algorithm.","in":"query","name":"publicKeyAlgorithm","schema":{"description":"Filters results by public key algorithm.","items":{"enum":["DSA","ECDSA","RSA"],"type":"string"},"type":"array"}},{"description":"Filters results by signature algorithm.","in":"query","name":"signatureAlgorithm","schema":{"description":"Filters results by signature algorithm.","items":{"enum":["DSA_SHA_1","DSA_SHA_256","ECDSA_SHA_1","ECDSA_SHA_256","ECDSA_SHA_384","ECDSA_SHA_512","PSS_SHA_256","PSS_SHA_384","PSS_SHA_512","RSA_MD2","RSA_MD5","RSA_SHA_1","RSA_SHA_256","RSA_SHA_384","RSA_SHA_512"],"type":"string"},"type":"array"}},{"description":"Filters results by validation level.","in":"query","name":"validationLevel","schema":{"description":"Filters results by validation level.","items":{"enum":["DOMAIN","ORGANIZATION","EXTENDED"],"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"RAW_VALUES","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["RAW_VALUES","PERCENTAGE"],"example":"RAW_VALUES","type":"string"}},{"description":"Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only.","in":"query","name":"uniqueEntries","schema":{"description":"Specifies whether to filter out duplicate certificates and pre-certificates. Set to true for unique entries only.","items":{"enum":["true","false"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"anyOf":[{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"DigiCert":["10.274394"],"GoDaddy":["8.381743"],"Internet Security Research Group":["63.40249"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"},{"properties":{"rfc6962":{"items":{"type":"string"},"type":"array"},"static":{"items":{"type":"string"},"type":"array"}},"required":["rfc6962","static"],"type":"object"},{"properties":{"gt_121d":{"items":{"type":"string"},"type":"array"},"gt_16d_lte_31d":{"items":{"type":"string"},"type":"array"},"gt_31d_lte_91d":{"items":{"type":"string"},"type":"array"},"gt_3d_lte_16d":{"items":{"type":"string"},"type":"array"},"gt_91d_lte_121d":{"items":{"type":"string"},"type":"array"},"lte_3d":{"items":{"type":"string"},"type":"array"}},"required":["gt_31d_lte_91d","gt_121d","lte_3d","gt_91d_lte_121d","gt_16d_lte_31d","gt_3d_lte_16d"],"type":"object"},{"properties":{"CERTIFICATE":{"items":{"type":"string"},"type":"array"},"PRECERTIFICATE":{"items":{"type":"string"},"type":"array"}},"required":["CERTIFICATE","PRECERTIFICATE"],"type":"object"},{"properties":{"EXPIRED":{"items":{"type":"string"},"type":"array"},"VALID":{"items":{"type":"string"},"type":"array"}},"required":["VALID","EXPIRED"],"type":"object"},{"properties":{"NEGATIVE":{"items":{"type":"string"},"type":"array"},"POSITIVE":{"items":{"type":"string"},"type":"array"}},"required":["POSITIVE","NEGATIVE"],"type":"object"},{"properties":{"DSA":{"items":{"type":"string"},"type":"array"},"ECDSA":{"items":{"type":"string"},"type":"array"},"RSA":{"items":{"type":"string"},"type":"array"}},"required":["RSA","ECDSA","DSA"],"type":"object"},{"properties":{"domain":{"items":{"type":"string"},"type":"array"},"extended":{"items":{"type":"string"},"type":"array"},"organization":{"items":{"type":"string"},"type":"array"},"unknown":{"items":{"type":"string"},"type":"array"}},"required":["domain","organization","unknown","extended"],"type":"object"}]}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get time series of certificate distribution by dimension","tags":["Radar Certificate Transparency"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/datasets":{"get":{"description":"Retrieves a list of datasets.","operationId":"radar-get-reports-datasets","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Skips the specified number of objects before fetching the results.","in":"query","name":"offset","schema":{"description":"Skips the specified number of objects before fetching the results.","minimum":0,"type":"integer"}},{"description":"Filters results by dataset type.","in":"query","name":"datasetType","schema":{"default":"RANKING_BUCKET","description":"Filters results by dataset type.","enum":["RANKING_BUCKET","REPORT"],"example":"RANKING_BUCKET","type":"string"}},{"description":"Filters results by the specified date.","in":"query","name":"date","schema":{"description":"Filters results by the specified date.","example":"2024-09-19","format":"date","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"datasets":{"items":{"properties":{"description":{"example":"This dataset contains a list of the op 20000 domains globally","type":"string"},"id":{"example":3,"type":"integer"},"meta":{"type":"object"},"tags":{"items":{"example":"global","type":"string"},"type":"array"},"title":{"example":"Top bucket 20000 domains","type":"string"},"type":{"example":"RANKING_BUCKET","type":"string"}},"required":["id","title","description","type","tags","meta"],"type":"object"},"type":"array"}},"required":["datasets"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List datasets","tags":["Radar Datasets"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/datasets/download":{"post":{"description":"Retrieves an URL to download a single dataset.","operationId":"radar-post-reports-dataset-download-url","parameters":[{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"datasetId":{"example":3,"type":"integer","x-auditable":true}},"required":["datasetId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"dataset":{"properties":{"url":{"example":"https://example.com/download","type":"string"}},"required":["url"],"type":"object"}},"required":["dataset"],"type":"object"}},"required":["result"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get dataset download URL","tags":["Radar Datasets"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/datasets/{alias}":{"get":{"description":"Retrieves the CSV content of a given dataset by alias or ID. When getting the content by alias the latest dataset is returned, optionally filtered by the latest available at a given date.","operationId":"radar-get-reports-dataset-download","parameters":[{"description":"Dataset alias or ID.","in":"path","name":"alias","required":true,"schema":{"description":"Dataset alias or ID.","example":"ranking_top_1000","type":"string"}}],"responses":{"200":{"content":{"text/csv":{"schema":{"type":"string"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get dataset CSV stream","tags":["Radar Datasets"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/dns/summary/cache_hit":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by cache status.","operationId":"radar-get-dns-summary-by-cache-hit-status","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"NEGATIVE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"POSITIVE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["POSITIVE","NEGATIVE"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by cache status summary","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead."}},"/radar/dns/summary/dnssec":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS responses by DNSSEC (DNS Security Extensions) support.","operationId":"radar-get-dns-summary-by-dnssec","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"INSECURE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"INVALID":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"OTHER":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"SECURE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["INSECURE","SECURE","INVALID","OTHER"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by DNSSEC support summary","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead."}},"/radar/dns/summary/dnssec_aware":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by DNSSEC (DNS Security Extensions) client awareness.","operationId":"radar-get-dns-summary-by-dnssec-awareness","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"NOT_SUPPORTED":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"SUPPORTED":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["NOT_SUPPORTED","SUPPORTED"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by DNSSEC awareness summary","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead."}},"/radar/dns/summary/dnssec_e2e":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNSSEC-validated answers by end-to-end security status.","operationId":"radar-get-dns-summary-by-dnssec-e2e-version","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"NEGATIVE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"POSITIVE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["NEGATIVE","POSITIVE"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by DNSSEC end-to-end summary","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead."}},"/radar/dns/summary/ip_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by IP version.","operationId":"radar-get-dns-summary-by-ip-version","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"IPv4":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"IPv6":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["IPv4","IPv6"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by IP version summary","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead."}},"/radar/dns/summary/matching_answer":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by matching answers.","operationId":"radar-get-dns-summary-by-matching-answer-status","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"NEGATIVE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"POSITIVE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["POSITIVE","NEGATIVE"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by matching answer summary","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead."}},"/radar/dns/summary/protocol":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by DNS transport protocol.","operationId":"radar-get-dns-summary-by-protocol","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"HTTPS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"TCP":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"TLS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"UDP":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["UDP","TLS","HTTPS","TCP"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by protocol summary","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead."}},"/radar/dns/summary/query_type":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by type.","operationId":"radar-get-dns-summary-by-query-type","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"A":"20","AAAA":"20","HTTPS":"20","NS":"20","PTR":"20"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by type summary","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead."}},"/radar/dns/summary/response_code":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by response code.","operationId":"radar-get-dns-summary-by-response-code","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"NOERROR":"70","NOTIMP":"5","NXDOMAIN":"10","REFUSED":"5","SERVFAIL":"5"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by response code summary","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead."}},"/radar/dns/summary/response_ttl":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by minimum response TTL.","operationId":"radar-get-dns-summary-by-response-ttl","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"gt_15m_lte_1h":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"gt_1d_lte_1w":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"gt_1h_lte_1d":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"gt_1m_lte_5m":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"gt_1w":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"gt_5m_lte_15m":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"lte_1m":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["lte_1m","gt_1m_lte_5m","gt_5m_lte_15m","gt_15m_lte_1h","gt_1h_lte_1d","gt_1d_lte_1w","gt_1w"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by response TTL summary","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/summary_v2/) instead."}},"/radar/dns/summary/{dimension}":{"get":{"description":"Retrieves the distribution of DNS queries by the specified dimension.","operationId":"radar-get-dns-summary","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["IP_VERSION","CACHE_HIT","DNSSEC","DNSSEC_AWARE","DNSSEC_E2E","MATCHING_ANSWER","PROTOCOL","QUERY_TYPE","RESPONSE_CODE","RESPONSE_TTL","TLD","TLD_DNS_MAGNITUDE"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results based on cache status.","in":"query","name":"cacheHit","schema":{"description":"Filters results based on cache status.","items":{"type":"boolean"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response TTL.","in":"query","name":"responseTtl","schema":{"description":"Filters results by DNS response TTL.","items":{"enum":["LTE_1M","GT_1M_LTE_5M","GT_5M_LTE_15M","GT_15M_LTE_1H","GT_1H_LTE_1D","GT_1D_LTE_1W","GT_1W"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC (DNS Security Extensions) support.","in":"query","name":"dnssec","schema":{"description":"Filters results based on DNSSEC (DNS Security Extensions) support.","items":{"enum":["INVALID","INSECURE","SECURE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC (DNS Security Extensions) client awareness.","in":"query","name":"dnssecAware","schema":{"description":"Filters results based on DNSSEC (DNS Security Extensions) client awareness.","items":{"enum":["SUPPORTED","NOT_SUPPORTED"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC-validated answers by end-to-end security status.","in":"query","name":"dnssecE2e","schema":{"description":"Filters results based on DNSSEC-validated answers by end-to-end security status.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Filters results based on whether the queries have a matching answer.","in":"query","name":"matchingAnswer","schema":{"description":"Filters results based on whether the queries have a matching answer.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"type":"string"},"example":{"IPv4":"50.168733","IPv6":"25.084366"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS summary by dimension","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/dns/timeseries":{"get":{"description":"Retrieves normalized query volume to the 1.1.1.1 DNS resolver over time.","operationId":"radar-get-dns-timeseries","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results based on cache status.","in":"query","name":"cacheHit","schema":{"description":"Filters results based on cache status.","items":{"type":"boolean"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response TTL.","in":"query","name":"responseTtl","schema":{"description":"Filters results by DNS response TTL.","items":{"enum":["LTE_1M","GT_1M_LTE_5M","GT_5M_LTE_15M","GT_15M_LTE_1H","GT_1H_LTE_1D","GT_1D_LTE_1W","GT_1W"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC (DNS Security Extensions) support.","in":"query","name":"dnssec","schema":{"description":"Filters results based on DNSSEC (DNS Security Extensions) support.","items":{"enum":["INVALID","INSECURE","SECURE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC (DNS Security Extensions) client awareness.","in":"query","name":"dnssecAware","schema":{"description":"Filters results based on DNSSEC (DNS Security Extensions) client awareness.","items":{"enum":["SUPPORTED","NOT_SUPPORTED"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC-validated answers by end-to-end security status.","in":"query","name":"dnssecE2e","schema":{"description":"Filters results based on DNSSEC-validated answers by end-to-end security status.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results based on whether the queries have a matching answer.","in":"query","name":"matchingAnswer","schema":{"description":"Filters results based on whether the queries have a matching answer.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"additionalProperties":{"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"},"values":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"},"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"}},"required":["meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries time series","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/dns/timeseries_groups/cache_hit":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by cache status over time.","operationId":"radar-get-dns-timeseries-group-by-cache-hit-status","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"NEGATIVE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"POSITIVE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["POSITIVE","NEGATIVE"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by cache status time series","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead."}},"/radar/dns/timeseries_groups/dnssec":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS responses by DNSSEC (DNS Security Extensions) support over time.","operationId":"radar-get-dns-timeseries-group-by-dnssec","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"INSECURE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"INVALID":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"OTHER":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"SECURE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["INSECURE","SECURE","INVALID","OTHER"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by DNSSEC support time series","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead."}},"/radar/dns/timeseries_groups/dnssec_aware":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by DNSSEC (DNS Security Extensions) client awareness over time.","operationId":"radar-get-dns-timeseries-group-by-dnssec-awareness","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"NOT_SUPPORTED":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"SUPPORTED":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["NOT_SUPPORTED","SUPPORTED"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by DNSSEC awareness time series","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead."}},"/radar/dns/timeseries_groups/dnssec_e2e":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNSSEC-validated answers by end-to-end security status over time.","operationId":"radar-get-dns-timeseries-group-by-dnssec-e2e-version","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"NEGATIVE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"POSITIVE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["NEGATIVE","POSITIVE"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by DNSSEC end-to-end time series","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead."}},"/radar/dns/timeseries_groups/ip_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by IP version over time.","operationId":"radar-get-dns-timeseries-group-by-ip-version","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"IPv4":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"IPv6":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["IPv4","IPv6"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by IP version time series","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead."}},"/radar/dns/timeseries_groups/matching_answer":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by matching answers over time.","operationId":"radar-get-dns-timeseries-group-by-matching-answer-status","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"NEGATIVE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"POSITIVE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["POSITIVE","NEGATIVE"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by matching answer time series","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead."}},"/radar/dns/timeseries_groups/protocol":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by DNS transport protocol over time.","operationId":"radar-get-dns-timeseries-group-by-protocol","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"HTTPS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"TCP":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"TLS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"UDP":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["UDP","TLS","HTTPS","TCP"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by protocol time series","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead."}},"/radar/dns/timeseries_groups/query_type":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by type over time.","operationId":"radar-get-dns-timeseries-group-by-query-type","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"A":["20"],"AAAA":["20"],"HTTPS":["20"],"NS":["20"],"PTR":["20"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by type time series","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead."}},"/radar/dns/timeseries_groups/response_code":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by response code over time.","operationId":"radar-get-dns-timeseries-group-by-response-code","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"NOERROR":["70"],"NOTIMP":["5"],"NXDOMAIN":["10"],"REFUSED":["5"],"SERVFAIL":["5"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by response code time series","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead."}},"/radar/dns/timeseries_groups/response_ttl":{"get":{"deprecated":true,"description":"Retrieves the distribution of DNS queries by minimum answer TTL over time.","operationId":"radar-get-dns-timeseries-group-by-response-ttl","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"gt_15m_lte_1h":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"gt_1d_lte_1w":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"gt_1h_lte_1d":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"gt_1m_lte_5m":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"gt_1w":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"gt_5m_lte_15m":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"lte_1m":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["lte_1m","gt_1m_lte_5m","gt_5m_lte_15m","gt_15m_lte_1h","gt_1h_lte_1d","gt_1d_lte_1w","gt_1w"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS queries by response TTL time series","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar DNS Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/dns/methods/timeseries_groups_v2/) instead."}},"/radar/dns/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of DNS queries grouped by dimension over time.","operationId":"radar-get-dns-timeseries-group","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["IP_VERSION","CACHE_HIT","DNSSEC","DNSSEC_AWARE","DNSSEC_E2E","MATCHING_ANSWER","PROTOCOL","QUERY_TYPE","RESPONSE_CODE","RESPONSE_TTL","TLD"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results based on cache status.","in":"query","name":"cacheHit","schema":{"description":"Filters results based on cache status.","items":{"type":"boolean"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response TTL.","in":"query","name":"responseTtl","schema":{"description":"Filters results by DNS response TTL.","items":{"enum":["LTE_1M","GT_1M_LTE_5M","GT_5M_LTE_15M","GT_15M_LTE_1H","GT_1H_LTE_1D","GT_1D_LTE_1W","GT_1W"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC (DNS Security Extensions) support.","in":"query","name":"dnssec","schema":{"description":"Filters results based on DNSSEC (DNS Security Extensions) support.","items":{"enum":["INVALID","INSECURE","SECURE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC (DNS Security Extensions) client awareness.","in":"query","name":"dnssecAware","schema":{"description":"Filters results based on DNSSEC (DNS Security Extensions) client awareness.","items":{"enum":["SUPPORTED","NOT_SUPPORTED"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC-validated answers by end-to-end security status.","in":"query","name":"dnssecE2e","schema":{"description":"Filters results based on DNSSEC-validated answers by end-to-end security status.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Filters results based on whether the queries have a matching answer.","in":"query","name":"matchingAnswer","schema":{"description":"Filters results based on whether the queries have a matching answer.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"IPv4":["50.168733"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get DNS time series grouped by dimension","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/dns/top/ases":{"get":{"description":"Retrieves the top autonomous systems by DNS queries made to 1.1.1.1 DNS resolver.","operationId":"radar-get-dns-top-ases","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by domain name.","in":"query","name":"domain","schema":{"description":"Filters results by domain name.","example":"google.com","items":{"example":"google.com","maxLength":253,"minLength":1,"pattern":"^(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)\\.)+(?:[A-Za-z]{2,63})$","type":"string"},"type":"array"}},{"description":"Filters results based on cache status.","in":"query","name":"cacheHit","schema":{"description":"Filters results based on cache status.","items":{"type":"boolean"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response TTL.","in":"query","name":"responseTtl","schema":{"description":"Filters results by DNS response TTL.","items":{"enum":["LTE_1M","GT_1M_LTE_5M","GT_5M_LTE_15M","GT_15M_LTE_1H","GT_1H_LTE_1D","GT_1D_LTE_1W","GT_1W"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC (DNS Security Extensions) support.","in":"query","name":"dnssec","schema":{"description":"Filters results based on DNSSEC (DNS Security Extensions) support.","items":{"enum":["INVALID","INSECURE","SECURE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC (DNS Security Extensions) client awareness.","in":"query","name":"dnssecAware","schema":{"description":"Filters results based on DNSSEC (DNS Security Extensions) client awareness.","items":{"enum":["SUPPORTED","NOT_SUPPORTED"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC-validated answers by end-to-end security status.","in":"query","name":"dnssecE2e","schema":{"description":"Filters results based on DNSSEC-validated answers by end-to-end security status.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results based on whether the queries have a matching answer.","in":"query","name":"matchingAnswer","schema":{"description":"Filters results based on whether the queries have a matching answer.","items":{"type":"boolean"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":174,"type":"integer"},"clientASName":{"example":"Cogent-174","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by DNS queries","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/dns/top/locations":{"get":{"description":"Retrieves the top locations by DNS queries made to 1.1.1.1 DNS resolver.","operationId":"radar-get-dns-top-locations","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by domain name.","in":"query","name":"domain","schema":{"description":"Filters results by domain name.","example":"google.com","items":{"example":"google.com","maxLength":253,"minLength":1,"pattern":"^(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)\\.)+(?:[A-Za-z]{2,63})$","type":"string"},"type":"array"}},{"description":"Filters results based on cache status.","in":"query","name":"cacheHit","schema":{"description":"Filters results based on cache status.","items":{"type":"boolean"},"type":"array"}},{"description":"Specifies whether the response includes empty DNS responses (NODATA).","in":"query","name":"nodata","schema":{"default":["true"],"description":"Specifies whether the response includes empty DNS responses (NODATA).","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by DNS transport protocol.","in":"query","name":"protocol","schema":{"description":"Filters results by DNS transport protocol.","items":{"enum":["UDP","TCP","HTTPS","TLS"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS query type.","in":"query","name":"queryType","schema":{"description":"Filters results by DNS query type.","items":{"enum":["A","AAAA","A6","AFSDB","ANY","APL","ATMA","AXFR","CAA","CDNSKEY","CDS","CERT","CNAME","CSYNC","DHCID","DLV","DNAME","DNSKEY","DOA","DS","EID","EUI48","EUI64","GPOS","GID","HINFO","HIP","HTTPS","IPSECKEY","ISDN","IXFR","KEY","KX","L32","L64","LOC","LP","MAILA","MAILB","MB","MD","MF","MG","MINFO","MR","MX","NAPTR","NB","NBSTAT","NID","NIMLOC","NINFO","NS","NSAP","NSEC","NSEC3","NSEC3PARAM","NULL","NXT","OPENPGPKEY","OPT","PTR","PX","RKEY","RP","RRSIG","RT","SIG","SINK","SMIMEA","SOA","SPF","SRV","SSHFP","SVCB","TA","TALINK","TKEY","TLSA","TSIG","TXT","UINFO","UID","UNSPEC","URI","WKS","X25","ZONEMD"],"nullable":true,"type":"string"},"type":"array"}},{"description":"Filters results by DNS response code.","in":"query","name":"responseCode","schema":{"description":"Filters results by DNS response code.","items":{"enum":["NOERROR","FORMERR","SERVFAIL","NXDOMAIN","NOTIMP","REFUSED","YXDOMAIN","YXRRSET","NXRRSET","NOTAUTH","NOTZONE","BADSIG","BADKEY","BADTIME","BADMODE","BADNAME","BADALG","BADTRUNC","BADCOOKIE"],"type":"string"},"type":"array"}},{"description":"Filters results by DNS response TTL.","in":"query","name":"responseTtl","schema":{"description":"Filters results by DNS response TTL.","items":{"enum":["LTE_1M","GT_1M_LTE_5M","GT_5M_LTE_15M","GT_15M_LTE_1H","GT_1H_LTE_1D","GT_1D_LTE_1W","GT_1W"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC (DNS Security Extensions) support.","in":"query","name":"dnssec","schema":{"description":"Filters results based on DNSSEC (DNS Security Extensions) support.","items":{"enum":["INVALID","INSECURE","SECURE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC (DNS Security Extensions) client awareness.","in":"query","name":"dnssecAware","schema":{"description":"Filters results based on DNSSEC (DNS Security Extensions) client awareness.","items":{"enum":["SUPPORTED","NOT_SUPPORTED"],"type":"string"},"type":"array"}},{"description":"Filters results based on DNSSEC-validated answers by end-to-end security status.","in":"query","name":"dnssecE2e","schema":{"description":"Filters results based on DNSSEC-validated answers by end-to-end security status.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results based on whether the queries have a matching answer.","in":"query","name":"matchingAnswer","schema":{"description":"Filters results based on whether the queries have a matching answer.","items":{"type":"boolean"},"type":"array"}},{"description":"Filters results by top-level domain.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain.","example":"com","items":{"example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"PT","type":"string"},"clientCountryName":{"example":"Portugal","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by DNS queries","tags":["Radar DNS"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/routing/summary/arc":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation.","operationId":"radar-get-email-routing-summary-by-arc","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","in":"query","name":"encrypted","schema":{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","example":"ENCRYPTED","items":{"enum":["ENCRYPTED","NOT_ENCRYPTED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"FAIL":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"NONE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"PASS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email ARC validation summary","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead."}},"/radar/email/routing/summary/dkim":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation.","operationId":"radar-get-email-routing-summary-by-dkim","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","in":"query","name":"encrypted","schema":{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","example":"ENCRYPTED","items":{"enum":["ENCRYPTED","NOT_ENCRYPTED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"FAIL":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"NONE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"PASS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email DKIM validation summary","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead."}},"/radar/email/routing/summary/dmarc":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation.","operationId":"radar-get-email-routing-summary-by-dmarc","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","in":"query","name":"encrypted","schema":{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","example":"ENCRYPTED","items":{"enum":["ENCRYPTED","NOT_ENCRYPTED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"FAIL":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"NONE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"PASS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email DMARC validation summary","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead."}},"/radar/email/routing/summary/encrypted":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by encryption status (encrypted vs. not-encrypted).","operationId":"radar-get-email-routing-summary-by-encrypted","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"ENCRYPTED":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"NOT_ENCRYPTED":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["ENCRYPTED","NOT_ENCRYPTED"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email encryption status summary","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead."}},"/radar/email/routing/summary/ip_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by IP version.","operationId":"radar-get-email-routing-summary-by-ip-version","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","in":"query","name":"encrypted","schema":{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","example":"ENCRYPTED","items":{"enum":["ENCRYPTED","NOT_ENCRYPTED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"IPv4":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"IPv6":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["IPv4","IPv6"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email IP version summary","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead."}},"/radar/email/routing/summary/spf":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by SPF (Sender Policy Framework) validation.","operationId":"radar-get-email-routing-summary-by-spf","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","in":"query","name":"encrypted","schema":{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","example":"ENCRYPTED","items":{"enum":["ENCRYPTED","NOT_ENCRYPTED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"FAIL":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"NONE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"PASS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email SPF validation summary","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead."}},"/radar/email/routing/summary/{dimension}":{"get":{"description":"Retrieves the distribution of email routing metrics by the specified dimension.","operationId":"radar-get-email-routing-summary","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["IP_VERSION","ENCRYPTED","ARC","DKIM","DMARC","SPF"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","in":"query","name":"encrypted","schema":{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","example":"ENCRYPTED","items":{"enum":["ENCRYPTED","NOT_ENCRYPTED"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"type":"string"},"example":{"FAIL":"25.084366","PASS":"50.168733"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email routing summary by dimension","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/routing/timeseries_groups/arc":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation over time.","operationId":"radar-get-email-routing-timeseries-group-by-arc","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","in":"query","name":"encrypted","schema":{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","example":"ENCRYPTED","items":{"enum":["ENCRYPTED","NOT_ENCRYPTED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"FAIL":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"NONE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"PASS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email ARC validation time series","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Routing Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/timeseries_groups_v2/) instead."}},"/radar/email/routing/timeseries_groups/dkim":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation over time.","operationId":"radar-get-email-routing-timeseries-group-by-dkim","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","in":"query","name":"encrypted","schema":{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","example":"ENCRYPTED","items":{"enum":["ENCRYPTED","NOT_ENCRYPTED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"FAIL":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"NONE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"PASS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email DKIM validation time series","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Routing Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/timeseries_groups_v2/) instead."}},"/radar/email/routing/timeseries_groups/dmarc":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation over time.","operationId":"radar-get-email-routing-timeseries-group-by-dmarc","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","in":"query","name":"encrypted","schema":{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","example":"ENCRYPTED","items":{"enum":["ENCRYPTED","NOT_ENCRYPTED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"FAIL":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"NONE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"PASS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email DMARC validation time series","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Routing Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/timeseries_groups_v2/) instead."}},"/radar/email/routing/timeseries_groups/encrypted":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by encryption status (encrypted vs. not-encrypted) over time.","operationId":"radar-get-email-routing-timeseries-group-by-encrypted","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"ENCRYPTED":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"NOT_ENCRYPTED":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["ENCRYPTED","NOT_ENCRYPTED"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email encryption status time series","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Routing Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/timeseries_groups_v2/) instead."}},"/radar/email/routing/timeseries_groups/ip_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by IP version over time.","operationId":"radar-get-email-routing-timeseries-group-by-ip-version","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","in":"query","name":"encrypted","schema":{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","example":"ENCRYPTED","items":{"enum":["ENCRYPTED","NOT_ENCRYPTED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"IPv4":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"IPv6":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["IPv4","IPv6"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email IP version time series","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Routing Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/timeseries_groups_v2/) instead."}},"/radar/email/routing/timeseries_groups/spf":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by SPF (Sender Policy Framework) validation over time.","operationId":"radar-get-email-routing-timeseries-group-by-spf","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","in":"query","name":"encrypted","schema":{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","example":"ENCRYPTED","items":{"enum":["ENCRYPTED","NOT_ENCRYPTED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"FAIL":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"NONE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"PASS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email SPF validation time series","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Routing Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/timeseries_groups_v2/) instead."}},"/radar/email/routing/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of email routing metrics grouped by dimension over time.","operationId":"radar-get-email-routing-timeseries-group","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["IP_VERSION","ENCRYPTED","ARC","DKIM","DMARC","SPF"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","in":"query","name":"encrypted","schema":{"description":"Filters results by encryption status (encrypted vs. not-encrypted).","example":"ENCRYPTED","items":{"enum":["ENCRYPTED","NOT_ENCRYPTED"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"PASS":["50.168733"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email routing time series grouped by dimension","tags":["Radar Email Routing"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/security/summary/arc":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation.","operationId":"radar-get-email-security-summary-by-arc","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"FAIL":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"NONE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"PASS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email ARC validation summary","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead."}},"/radar/email/security/summary/dkim":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation.","operationId":"radar-get-email-security-summary-by-dkim","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"FAIL":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"NONE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"PASS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email DKIM validation summary","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead."}},"/radar/email/security/summary/dmarc":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation.","operationId":"radar-get-email-security-summary-by-dmarc","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"FAIL":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"NONE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"PASS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email DMARC validation summary","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead."}},"/radar/email/security/summary/malicious":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by malicious classification.","operationId":"radar-get-email-security-summary-by-malicious","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"MALICIOUS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"NOT_MALICIOUS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["MALICIOUS","NOT_MALICIOUS"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email malicious classification summary","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead."}},"/radar/email/security/summary/spam":{"get":{"deprecated":true,"description":"Retrieves the proportion of emails by spam classification (spam vs. non-spam).","operationId":"radar-get-email-security-summary-by-spam","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"NOT_SPAM":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"SPAM":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["SPAM","NOT_SPAM"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email spam classification summary","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead."}},"/radar/email/security/summary/spf":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by SPF (Sender Policy Framework) validation.","operationId":"radar-get-email-security-summary-by-spf","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"FAIL":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"NONE":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"PASS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email SPF validation summary","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead."}},"/radar/email/security/summary/spoof":{"get":{"deprecated":true,"description":"Retrieves the proportion of emails by spoof classification (spoof vs. non-spoof).","operationId":"radar-get-email-security-summary-by-spoof","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"NOT_SPOOF":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"SPOOF":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["SPOOF","NOT_SPOOF"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email spoof classification summary","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead."}},"/radar/email/security/summary/threat_category":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by threat categories.","operationId":"radar-get-email-security-summary-by-threat-category","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"BrandImpersonation":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"CredentialHarvester":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"IdentityDeception":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"Link":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["IdentityDeception","Link","BrandImpersonation","CredentialHarvester"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email threat category summary","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead."}},"/radar/email/security/summary/tls_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by TLS version.","operationId":"radar-get-email-security-summary-by-tls-version","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"TLS 1.0":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"TLS 1.1":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"TLS 1.2":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"TLS 1.3":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["TLS 1.0","TLS 1.1","TLS 1.2","TLS 1.3"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email TLS version summary","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead."}},"/radar/email/security/summary/{dimension}":{"get":{"description":"Retrieves the distribution of email security metrics by the specified dimension.","operationId":"radar-get-email-security-summary","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["SPAM","MALICIOUS","SPOOF","THREAT_CATEGORY","ARC","DKIM","DMARC","SPF","TLS_VERSION"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"type":"string"},"example":{"FAIL":"25.084366","PASS":"50.168733"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email security summary by dimension","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/security/timeseries_groups/arc":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation over time.","operationId":"radar-get-email-security-timeseries-group-by-arc","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"FAIL":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"NONE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"PASS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email ARC validation time series","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead."}},"/radar/email/security/timeseries_groups/dkim":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation over time.","operationId":"radar-get-email-security-timeseries-group-by-dkim","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"FAIL":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"NONE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"PASS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email DKIM validation time series","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead."}},"/radar/email/security/timeseries_groups/dmarc":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation over time.","operationId":"radar-get-email-security-timeseries-group-by-dmarc","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"FAIL":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"NONE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"PASS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email DMARC validation time series","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead."}},"/radar/email/security/timeseries_groups/malicious":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by malicious classification over time.","operationId":"radar-get-email-security-timeseries-group-by-malicious","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"MALICIOUS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"NOT_MALICIOUS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["MALICIOUS","NOT_MALICIOUS"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email malicious classification time series","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead."}},"/radar/email/security/timeseries_groups/spam":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by spam classification (spam vs. non-spam) over time.","operationId":"radar-get-email-security-timeseries-group-by-spam","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"NOT_SPAM":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"SPAM":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["SPAM","NOT_SPAM"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email spam classification time series","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead."}},"/radar/email/security/timeseries_groups/spf":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by SPF (Sender Policy Framework) validation over time.","operationId":"radar-get-email-security-timeseries-group-by-spf","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"FAIL":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"NONE":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"PASS":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email SPF validation time series","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead."}},"/radar/email/security/timeseries_groups/spoof":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by spoof classification (spoof vs. non-spoof) over time.","operationId":"radar-get-email-security-timeseries-group-by-spoof","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"NOT_SPOOF":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"SPOOF":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["SPOOF","NOT_SPOOF"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email spoof classification time series","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead."}},"/radar/email/security/timeseries_groups/threat_category":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by threat category over time.","operationId":"radar-get-email-security-timeseries-group-by-threat-category","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"BrandImpersonation":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"CredentialHarvester":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"IdentityDeception":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"Link":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["IdentityDeception","Link","BrandImpersonation","CredentialHarvester"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email threat category time series","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead."}},"/radar/email/security/timeseries_groups/tls_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of emails by TLS version over time.","operationId":"radar-get-email-security-timeseries-group-by-tls-version","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"TLS 1.0":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"TLS 1.1":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"TLS 1.2":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"TLS 1.3":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["TLS 1.0","TLS 1.1","TLS 1.2","TLS 1.3"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email TLS version time series","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Email Security Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/timeseries_groups_v2/) instead."}},"/radar/email/security/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of email security metrics grouped by dimension over time.","operationId":"radar-get-email-security-timeseries-group","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["SPAM","MALICIOUS","SPOOF","THREAT_CATEGORY","ARC","DKIM","DMARC","SPF","TLS_VERSION"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"PASS":["50.168733"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get email security time series grouped by dimension","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/security/top/tlds":{"get":{"description":"Retrieves the top TLDs by number of email messages.","operationId":"radar-get-email-security-top-tlds-by-messages","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Filters results by TLD category.","in":"query","name":"tldCategory","schema":{"description":"Filters results by TLD category.","enum":["CLASSIC","COUNTRY"],"example":"CLASSIC","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"name":{"example":"com.","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top TLDs by email message volume","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/security/top/tlds/malicious/{malicious}":{"get":{"description":"Retrieves the top TLDs by emails classified as malicious or not.","operationId":"radar-get-email-security-top-tlds-by-malicious","parameters":[{"description":"Malicious classification.","in":"path","name":"malicious","required":true,"schema":{"description":"Malicious classification.","enum":["MALICIOUS","NOT_MALICIOUS"],"example":"MALICIOUS","type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Filters results by TLD category.","in":"query","name":"tldCategory","schema":{"description":"Filters results by TLD category.","enum":["CLASSIC","COUNTRY"],"example":"CLASSIC","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"name":{"example":"com.","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top TLDs by email malicious classification","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/security/top/tlds/spam/{spam}":{"get":{"description":"Retrieves the top TLDs by emails classified as spam or not.","operationId":"radar-get-email-security-top-tlds-by-spam","parameters":[{"description":"Spam classification.","in":"path","name":"spam","required":true,"schema":{"description":"Spam classification.","enum":["SPAM","NOT_SPAM"],"example":"SPAM","type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Filters results by TLD category.","in":"query","name":"tldCategory","schema":{"description":"Filters results by TLD category.","enum":["CLASSIC","COUNTRY"],"example":"CLASSIC","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"name":{"example":"com.","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top TLDs by email spam classification","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/security/top/tlds/spoof/{spoof}":{"get":{"description":"Retrieves the top TLDs by emails classified as spoof or not.","operationId":"radar-get-email-security-top-tlds-by-spoof","parameters":[{"description":"Spoof classification.","in":"path","name":"spoof","required":true,"schema":{"description":"Spoof classification.","enum":["SPOOF","NOT_SPOOF"],"example":"SPOOF","type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by ARC (Authenticated Received Chain) validation.","in":"query","name":"arc","schema":{"description":"Filters results by ARC (Authenticated Received Chain) validation.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","in":"query","name":"dkim","schema":{"description":"Filters results by DKIM (DomainKeys Identified Mail) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","in":"query","name":"dmarc","schema":{"description":"Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by SPF (Sender Policy Framework) validation status.","in":"query","name":"spf","schema":{"description":"Filters results by SPF (Sender Policy Framework) validation status.","example":"PASS","items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"type":"string"},"type":"array"}},{"description":"Filters results by TLD category.","in":"query","name":"tldCategory","schema":{"description":"Filters results by TLD category.","enum":["CLASSIC","COUNTRY"],"example":"CLASSIC","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"name":{"example":"com.","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top TLDs by email spoof classification","tags":["Radar Email Security"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/entities/asns":{"get":{"description":"Retrieves a list of autonomous systems.","operationId":"radar-get-entities-asn-list","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Skips the specified number of objects before fetching the results.","in":"query","name":"offset","schema":{"description":"Skips the specified number of objects before fetching the results.","minimum":0,"type":"integer"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list.","example":"174,7922","type":"string"}},{"description":"Filters results by location. Specify an alpha-2 location code.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify an alpha-2 location code.","example":"US","maxLength":2,"minLength":2,"type":"string"}},{"description":"Specifies the metric to order the ASNs by.","in":"query","name":"orderBy","schema":{"default":"ASN","description":"Specifies the metric to order the ASNs by.","enum":["ASN","POPULATION"],"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"asns":{"items":{"properties":{"aka":{"type":"string"},"asn":{"example":714,"type":"integer"},"country":{"example":"GB","type":"string"},"countryName":{"example":"United Kingdom","type":"string"},"name":{"example":"Apple Inc.","type":"string"},"orgName":{"type":"string"},"website":{"example":"https://www.apple.com/support/systemstatus/","type":"string"}},"required":["name","asn","country","countryName"],"type":"object"},"type":"array"}},"required":["asns"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List autonomous systems","tags":["Radar Autonomous Systems"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/entities/asns/ip":{"get":{"description":"Retrieves the requested autonomous system information based on IP address. Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).","operationId":"radar-get-entities-asn-by-ip","parameters":[{"description":"IP address.","in":"query","name":"ip","required":true,"schema":{"description":"IP address.","example":"8.8.8.8","format":"ip","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"asn":{"properties":{"aka":{"type":"string"},"asn":{"example":714,"type":"integer"},"country":{"example":"GB","type":"string"},"countryName":{"example":"United Kingdom","type":"string"},"estimatedUsers":{"properties":{"estimatedUsers":{"description":"Total estimated users.","example":86099,"type":"integer"},"locations":{"items":{"properties":{"estimatedUsers":{"description":"Estimated users per location.","example":16710,"type":"integer"},"locationAlpha2":{"example":"US","type":"string"},"locationName":{"example":"United States","type":"string"}},"required":["locationName","locationAlpha2"],"type":"object"},"type":"array"}},"required":["locations"],"type":"object"},"name":{"example":"Apple Inc.","type":"string"},"orgName":{"type":"string"},"related":{"items":{"properties":{"aka":{"type":"string"},"asn":{"type":"integer"},"estimatedUsers":{"description":"Total estimated users.","example":65345,"type":"integer"},"name":{"type":"string"}},"required":["name","asn"],"type":"object"},"type":"array"},"source":{"description":"Regional Internet Registry.","example":"RIPE","type":"string"},"website":{"example":"https://www.apple.com/support/systemstatus/","type":"string"}},"required":["name","country","countryName","related","asn","website","orgName","source","estimatedUsers"],"type":"object"}},"required":["asn"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS details by IP address","tags":["Radar Autonomous Systems"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/entities/asns/{asn}":{"get":{"description":"Retrieves the requested autonomous system information. (A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this AS). Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).","operationId":"radar-get-entities-asn-by-id","parameters":[{"description":"Single Autonomous System Number (ASN) as integer.","in":"path","name":"asn","required":true,"schema":{"description":"Single Autonomous System Number (ASN) as integer.","example":174,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"asn":{"properties":{"aka":{"type":"string"},"asn":{"example":714,"type":"integer"},"confidenceLevel":{"example":5,"type":"integer"},"country":{"example":"GB","type":"string"},"countryName":{"example":"United Kingdom","type":"string"},"estimatedUsers":{"properties":{"estimatedUsers":{"description":"Total estimated users.","example":86099,"type":"integer"},"locations":{"items":{"properties":{"estimatedUsers":{"description":"Estimated users per location.","example":16710,"type":"integer"},"locationAlpha2":{"example":"US","type":"string"},"locationName":{"example":"United States","type":"string"}},"required":["locationName","locationAlpha2"],"type":"object"},"type":"array"}},"required":["locations"],"type":"object"},"name":{"example":"Apple Inc.","type":"string"},"orgName":{"type":"string"},"related":{"items":{"properties":{"aka":{"type":"string"},"asn":{"example":174,"type":"integer"},"estimatedUsers":{"description":"Total estimated users.","example":65345,"type":"integer"},"name":{"example":"Cogent-174","type":"string"}},"required":["name","asn"],"type":"object"},"type":"array"},"source":{"description":"Regional Internet Registry.","example":"RIPE","type":"string"},"website":{"example":"https://www.apple.com/support/systemstatus/","type":"string"}},"required":["name","country","countryName","confidenceLevel","related","source","asn","website","orgName","estimatedUsers"],"type":"object"}},"required":["asn"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS details by ASN","tags":["Radar Autonomous Systems"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/entities/asns/{asn}/as_set":{"get":{"description":"Retrieves Internet Routing Registry AS-SETs that an AS is a member of.","operationId":"radar-get-asns-as-set","parameters":[{"description":"Retrieves all AS-SETs that the given AS is a member of.","in":"path","name":"asn","required":true,"schema":{"description":"Retrieves all AS-SETs that the given AS is a member of.","example":3,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"as_sets":{"items":{"properties":{"as_members_count":{"description":"The number of AS members in the AS-SET","type":"integer"},"as_set_members_count":{"description":"The number of AS-SET members in the AS-SET","type":"integer"},"as_set_upstreams_count":{"description":"The number of recursive upstream AS-SETs","type":"integer"},"asn_cone_size":{"description":"The number of unique ASNs in the AS-SETs recursive downstream","type":"integer"},"hierarchical_asn":{"description":"The AS number following hierarchical AS-SET name","type":"integer"},"inferred_asn":{"description":"The inferred AS number of the AS-SET","type":"integer"},"irr_sources":{"description":"The IRR sources of the AS-SET","items":{"type":"string"},"type":"array"},"name":{"description":"The name of the AS-SET","type":"string"},"peeringdb_asn":{"description":"The AS number matching PeeringDB record","type":"integer"}},"required":["name","as_members_count","as_set_members_count","irr_sources","asn_cone_size","as_set_upstreams_count"],"type":"object"},"type":"array"},"paths":{"description":"Paths from the AS-SET that include the given AS to its upstreams recursively","items":{"items":{"type":"string"},"type":"array"},"type":"array"}},"required":["as_sets","paths"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get IRR AS-SETs that an AS is a member of","tags":["Radar Autonomous Systems"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/entities/asns/{asn}/rel":{"get":{"description":"Retrieves AS-level relationship for given networks.","operationId":"radar-get-asns-rel","parameters":[{"description":"Retrieves all ASNs with provider-customer or peering relationships with the given ASN.","in":"path","name":"asn","required":true,"schema":{"description":"Retrieves all ASNs with provider-customer or peering relationships with the given ASN.","example":3,"type":"integer"}},{"description":"Retrieves the AS relationship of ASN2 with respect to the given ASN.","in":"query","name":"asn2","schema":{"description":"Retrieves the AS relationship of ASN2 with respect to the given ASN.","type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"data_time":{"type":"string"},"query_time":{"type":"string"},"total_peers":{"type":"integer"}},"required":["data_time","query_time","total_peers"],"type":"object"},"rels":{"items":{"properties":{"asn1":{"type":"integer"},"asn1_country":{"type":"string"},"asn1_name":{"type":"string"},"asn2":{"type":"integer"},"asn2_country":{"type":"string"},"asn2_name":{"type":"string"},"rel":{"type":"string"}},"required":["asn1","asn1_country","asn1_name","asn2","asn2_country","asn2_name","rel"],"type":"object"},"type":"array"}},"required":["rels","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get AS-level relationships by ASN","tags":["Radar Autonomous Systems"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/entities/ip":{"get":{"description":"Retrieves IP address information.","operationId":"radar-get-entities-ip","parameters":[{"description":"IP address.","in":"query","name":"ip","required":true,"schema":{"description":"IP address.","example":"8.8.8.8","format":"ip","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"ip":{"properties":{"asn":{"example":"15169","type":"string"},"asnLocation":{"example":"US","type":"string"},"asnName":{"example":"GOOGLE","type":"string"},"asnOrgName":{"example":"Google LLC","type":"string"},"ip":{"example":"8.8.8.8","type":"string"},"ipVersion":{"example":"IPv4","type":"string"},"location":{"example":"GB","type":"string"},"locationName":{"example":"United Kingdom","type":"string"}},"required":["ip","ipVersion","location","locationName","asn","asnName","asnLocation","asnOrgName"],"type":"object"}},"required":["ip"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get IP address details","tags":["Radar IP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/entities/locations":{"get":{"description":"Retrieves a list of locations.","operationId":"radar-get-entities-locations","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Skips the specified number of objects before fetching the results.","in":"query","name":"offset","schema":{"description":"Skips the specified number of objects before fetching the results.","minimum":0,"type":"integer"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 location codes.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 location codes.","example":"US,CA","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"locations":{"items":{"properties":{"alpha2":{"example":"AF","type":"string"},"latitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"longitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"name":{"example":"Afghanistan","type":"string"}},"required":["name","latitude","longitude","alpha2"],"type":"object"},"type":"array"}},"required":["locations"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List locations","tags":["Radar Locations"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/entities/locations/{location}":{"get":{"description":"Retrieves the requested location information. (A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this location).","operationId":"radar-get-entities-location-by-alpha2","parameters":[{"description":"Location alpha-2 code.","in":"path","name":"location","required":true,"schema":{"description":"Location alpha-2 code.","example":"US","maxLength":2,"minLength":2,"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"location":{"properties":{"alpha2":{"example":"AF","type":"string"},"confidenceLevel":{"example":5,"type":"integer"},"latitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"longitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"name":{"example":"Afghanistan","type":"string"},"region":{"example":"Middle East","type":"string"},"subregion":{"example":"Southern Asia","type":"string"}},"required":["name","region","subregion","latitude","longitude","alpha2","confidenceLevel"],"type":"object"}},"required":["location"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get location details","tags":["Radar Locations"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/geolocations":{"get":{"description":"Retrieves a list of geolocations.","operationId":"radar-get-geolocations","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Skips the specified number of objects before fetching the results.","in":"query","name":"offset","schema":{"description":"Skips the specified number of objects before fetching the results.","minimum":0,"type":"integer"}},{"description":"Filters results by geolocation. Specify a comma-separated list of GeoNames IDs.","in":"query","name":"geoId","schema":{"description":"Filters results by geolocation. Specify a comma-separated list of GeoNames IDs.","example":"3190509,360689","type":"string"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 location codes.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 location codes.","example":"US,CA","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"geolocations":{"items":{"properties":{"geoId":{"example":"2267056","type":"string"},"latitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"longitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"name":{"example":"Lisbon","type":"string"},"parent":{"properties":{"geoId":{"example":"2264397","type":"string"},"latitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"longitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"name":{"example":"Portugal","type":"string"},"parent":{"properties":{"geoId":{"example":"6255148","type":"string"},"latitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"longitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"name":{"example":"Europe","type":"string"},"type":{"description":"The type of the geolocation.","enum":["CONTINENT","COUNTRY","ADM1"],"type":"string"}},"required":["geoId","name","type","latitude","longitude"],"type":"object"},"type":{"description":"The type of the geolocation.","enum":["CONTINENT","COUNTRY","ADM1"],"type":"string"}},"required":["geoId","name","type","latitude","longitude","parent"],"type":"object"},"type":{"description":"The type of the geolocation.","enum":["CONTINENT","COUNTRY","ADM1"],"type":"string"}},"required":["geoId","name","type","latitude","longitude","parent"],"type":"object"},"type":"array"}},"required":["geolocations"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Geolocations","tags":["Radar Geolocations"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/geolocations/{geo_id}":{"get":{"description":"Retrieves the requested Geolocation information.","operationId":"radar-get-geolocation-details","parameters":[{"description":"Geolocation ID. Refer to [GeoNames](https://download.geonames.org/export/dump/readme.txt)","in":"path","name":"geo_id","required":true,"schema":{"description":"Geolocation ID. Refer to [GeoNames](https://download.geonames.org/export/dump/readme.txt)","example":"3190509","maxLength":100,"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"geolocation":{"properties":{"geoId":{"example":"2267056","type":"string"},"latitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"longitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"name":{"example":"Lisbon","type":"string"},"parent":{"properties":{"geoId":{"example":"2264397","type":"string"},"latitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"longitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"name":{"example":"Portugal","type":"string"},"parent":{"properties":{"geoId":{"example":"6255148","type":"string"},"latitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"longitude":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"name":{"example":"Europe","type":"string"},"type":{"description":"The type of the geolocation.","enum":["CONTINENT","COUNTRY","ADM1"],"type":"string"}},"required":["geoId","name","type","latitude","longitude"],"type":"object"},"type":{"description":"The type of the geolocation.","enum":["CONTINENT","COUNTRY","ADM1"],"type":"string"}},"required":["geoId","name","type","latitude","longitude","parent"],"type":"object"},"type":{"description":"The type of the geolocation.","enum":["CONTINENT","COUNTRY","ADM1"],"type":"string"}},"required":["geoId","name","type","latitude","longitude","parent"],"type":"object"}},"required":["geolocation"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Geolocation details","tags":["Radar Geolocations"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/summary/bot_class":{"get":{"deprecated":true,"description":"Retrieves the distribution of bot-generated HTTP requests to genuine human traffic, as classified by Cloudflare. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information.","operationId":"radar-get-http-summary-by-bot-class","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"bot":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"human":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["human","bot"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by bot class summary","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead."}},"/radar/http/summary/device_type":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests generated by mobile, desktop, and other types of devices.","operationId":"radar-get-http-summary-by-device-type","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"desktop":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"mobile":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"other":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["desktop","mobile","other"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by device type summary","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead."}},"/radar/http/summary/http_protocol":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. HTTPS).","operationId":"radar-get-http-summary-by-http-protocol","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"http":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"https":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["http","https"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by HTTP/HTTPS summary","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead."}},"/radar/http/summary/http_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by HTTP version.","operationId":"radar-get-http-summary-by-http-version","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"HTTP/1.x":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"HTTP/2":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"HTTP/3":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["HTTP/1.x","HTTP/2","HTTP/3"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by HTTP version summary","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead."}},"/radar/http/summary/ip_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by IP version.","operationId":"radar-get-http-summary-by-ip-version","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"IPv4":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"IPv6":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["IPv4","IPv6"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by IP version summary","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead."}},"/radar/http/summary/os":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by operating system (Windows, macOS, Android, iOS, and others).","operationId":"radar-get-http-summary-by-operating-system","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"ANDROID":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"IOS":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["ANDROID","IOS"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by OS summary","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead."}},"/radar/http/summary/post_quantum":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by post-quantum support.","operationId":"radar-get-http-summary-by-post-quantum","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"NOT_SUPPORTED":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"SUPPORTED":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["SUPPORTED","NOT_SUPPORTED"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by post-quantum support summary","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead."}},"/radar/http/summary/tls_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by TLS version.","operationId":"radar-get-http-summary-by-tls-version","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"TLS 1.0":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"TLS 1.1":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"TLS 1.2":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"TLS 1.3":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"TLS QUIC":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["TLS 1.0","TLS 1.1","TLS 1.2","TLS 1.3","TLS QUIC"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by TLS version summary","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead."}},"/radar/http/summary/{dimension}":{"get":{"description":"Retrieves the distribution of HTTP requests by the specified dimension.","operationId":"radar-get-http-summary","parameters":[{"description":"Specifies the HTTP attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the HTTP attribute by which to group the results.","enum":["ADM1","BOT_CLASS","BROWSER","BROWSER_FAMILY","DEVICE_TYPE","HTTP_PROTOCOL","HTTP_VERSION","IP_VERSION","OS","POST_QUANTUM","TLS_VERSION"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"type":"string"},"example":{"Chrome":"50.168733","Firefox":"25.084366"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests summary by dimension","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/timeseries":{"get":{"description":"Retrieves the HTTP requests over time.","operationId":"radar-get-http-timeseries","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE_CHANGE","MIN0_MAX"],"example":"MIN0_MAX","type":"string"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"additionalProperties":{"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"},"values":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"},"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"}},"required":["meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests time series","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/timeseries_groups/bot_class":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests classified as automated or human over time. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information.","operationId":"radar-get-http-timeseries-group-by-bot-class","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"bot":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"human":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","human","bot"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by bot class time series","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead."}},"/radar/http/timeseries_groups/browser":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by user agent over time.","operationId":"radar-get-http-timeseries-group-by-browsers","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"Chrome":["50.168733"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by user agent time series","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead."}},"/radar/http/timeseries_groups/browser_family":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by user agent family over time.","operationId":"radar-get-http-timeseries-group-by-browser-families","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"Chrome":["50.168733"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by user agent family time series","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead."}},"/radar/http/timeseries_groups/device_type":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by device type over time.","operationId":"radar-get-http-timeseries-group-by-device-type","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"desktop":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"mobile":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"other":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","desktop","mobile","other"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by device type time series","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead."}},"/radar/http/timeseries_groups/http_protocol":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. HTTPS) over time.","operationId":"radar-get-http-timeseries-group-by-http-protocol","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"http":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"https":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","http","https"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by HTTP/HTTPS time series","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead."}},"/radar/http/timeseries_groups/http_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by HTTP version over time.","operationId":"radar-get-http-timeseries-group-by-http-version","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"HTTP/1.x":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"HTTP/2":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"HTTP/3":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","HTTP/1.x","HTTP/2","HTTP/3"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by HTTP version time series","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead."}},"/radar/http/timeseries_groups/ip_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by IP version over time.","operationId":"radar-get-http-timeseries-group-by-ip-version","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"IPv4":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"IPv6":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","IPv4","IPv6"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by IP version time series","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead."}},"/radar/http/timeseries_groups/os":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by operating system over time.","operationId":"radar-get-http-timeseries-group-by-operating-system","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"ANDROID":["97.28898"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by OS time series","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead."}},"/radar/http/timeseries_groups/post_quantum":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by post-quantum support over time.","operationId":"radar-get-http-timeseries-group-by-post-quantum","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"NOT_SUPPORTED":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"SUPPORTED":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","SUPPORTED","NOT_SUPPORTED"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by post-quantum support time series","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead."}},"/radar/http/timeseries_groups/tls_version":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP requests by TLS version over time.","operationId":"radar-get-http-timeseries-group-by-tls-version","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"TLS 1.0":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"TLS 1.1":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"TLS 1.2":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"TLS 1.3":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"TLS QUIC":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","TLS 1.0","TLS 1.1","TLS 1.2","TLS 1.3","TLS QUIC"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests by TLS version time series","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/timeseries_groups_v2/) instead."}},"/radar/http/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of HTTP requests grouped by dimension.","operationId":"radar-get-http-timeseries-group","parameters":[{"description":"Specifies the HTTP attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the HTTP attribute by which to group the results.","enum":["ADM1","BOT_CLASS","BROWSER","BROWSER_FAMILY","DEVICE_TYPE","HTTP_PROTOCOL","HTTP_VERSION","IP_VERSION","OS","POST_QUANTUM","TLS_VERSION"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"Chrome":["50.168733"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP requests time series grouped by dimension","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases":{"get":{"description":"Retrieves the top autonomous systems by HTTP requests.","operationId":"radar-get-http-top-ases-by-http-requests","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by HTTP requests","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/bot_class/{bot_class}":{"get":{"description":"Retrieves the top autonomous systems, by HTTP requests, of the requested bot class.","operationId":"radar-get-http-top-ases-by-bot-class","parameters":[{"description":"Bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"path","name":"bot_class","required":true,"schema":{"description":"Bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by HTTP requests for a bot class","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/browser_family/{browser_family}":{"get":{"description":"Retrieves the top autonomous systems, by HTTP requests, of the requested browser family.","operationId":"radar-get-http-top-ases-by-browser-family","parameters":[{"description":"Browser family.","in":"path","name":"browser_family","required":true,"schema":{"description":"Browser family.","enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by HTTP requests for a browser family","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/device_type/{device_type}":{"get":{"description":"Retrieves the top autonomous systems, by HTTP requests, of the requested device type.","operationId":"radar-get-http-top-ases-by-device-type","parameters":[{"description":"Device type.","in":"path","name":"device_type","required":true,"schema":{"description":"Device type.","enum":["DESKTOP","MOBILE","OTHER"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by HTTP requests for a device type","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/http_protocol/{http_protocol}":{"get":{"description":"Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP protocol.","operationId":"radar-get-http-top-ases-by-http-protocol","parameters":[{"description":"HTTP protocol (HTTP vs. HTTPS).","in":"path","name":"http_protocol","required":true,"schema":{"description":"HTTP protocol (HTTP vs. HTTPS).","enum":["HTTP","HTTPS"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by HTTP requests for an HTTP protocol","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/http_version/{http_version}":{"get":{"description":"Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP version.","operationId":"radar-get-http-top-ases-by-http-version","parameters":[{"description":"HTTP version.","in":"path","name":"http_version","required":true,"schema":{"description":"HTTP version.","enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by HTTP requests for an HTTP version","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/ip_version/{ip_version}":{"get":{"description":"Retrieves the top autonomous systems, by HTTP requests, of the requested IP version.","operationId":"radar-get-http-top-ases-by-ip-version","parameters":[{"description":"IP version.","in":"path","name":"ip_version","required":true,"schema":{"description":"IP version.","enum":["IPv4","IPv6"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by HTTP requests for an IP version","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/os/{os}":{"get":{"description":"Retrieves the top autonomous systems, by HTTP requests, of the requested operating system.","operationId":"radar-get-http-top-ases-by-operating-system","parameters":[{"description":"Operating system.","in":"path","name":"os","required":true,"schema":{"description":"Operating system.","enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by HTTP requests for an OS","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/tls_version/{tls_version}":{"get":{"description":"Retrieves the top autonomous systems, by HTTP requests, of the requested TLS protocol version.","operationId":"radar-get-http-top-ases-by-tls-version","parameters":[{"description":"TLS version.","in":"path","name":"tls_version","required":true,"schema":{"description":"TLS version.","enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by HTTP requests for a TLS version","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/browser":{"get":{"deprecated":true,"description":"Retrieves the top user agents by HTTP requests.","operationId":"radar-get-http-top-browsers","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"name":{"example":"chrome","type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top user agents by HTTP requests","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead."}},"/radar/http/top/browser_family":{"get":{"deprecated":true,"description":"Retrieves the top user agents, aggregated in families, by HTTP requests.","operationId":"radar-get-http-top-browser-families","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"name":{"example":"chrome","type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top user agent families by HTTP requests","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar HTTP Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/http/methods/summary_v2/) instead."}},"/radar/http/top/locations":{"get":{"description":"Retrieves the top locations by HTTP requests.","operationId":"radar-get-http-top-locations-by-http-requests","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by HTTP requests","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/bot_class/{bot_class}":{"get":{"description":"Retrieves the top locations, by HTTP requests, of the requested bot class.","operationId":"radar-get-http-top-locations-by-bot-class","parameters":[{"description":"Bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"path","name":"bot_class","required":true,"schema":{"description":"Bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by HTTP requests for a bot class","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/browser_family/{browser_family}":{"get":{"description":"Retrieves the top locations, by HTTP requests, of the requested browser family.","operationId":"radar-get-http-top-locations-by-browser-family","parameters":[{"description":"Browser family.","in":"path","name":"browser_family","required":true,"schema":{"description":"Browser family.","enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by HTTP requests for a browser family","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/device_type/{device_type}":{"get":{"description":"Retrieves the top locations, by HTTP requests, of the requested device type.","operationId":"radar-get-http-top-locations-by-device-type","parameters":[{"description":"Device type.","in":"path","name":"device_type","required":true,"schema":{"description":"Device type.","enum":["DESKTOP","MOBILE","OTHER"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by HTTP requests for a device type","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/http_protocol/{http_protocol}":{"get":{"description":"Retrieves the top locations, by HTTP requests, of the requested HTTP protocol.","operationId":"radar-get-http-top-locations-by-http-protocol","parameters":[{"description":"HTTP protocol (HTTP vs. HTTPS).","in":"path","name":"http_protocol","required":true,"schema":{"description":"HTTP protocol (HTTP vs. HTTPS).","enum":["HTTP","HTTPS"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by HTTP requests for an HTTP protocol","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/http_version/{http_version}":{"get":{"description":"Retrieves the top locations, by HTTP requests, of the requested HTTP version.","operationId":"radar-get-http-top-locations-by-http-version","parameters":[{"description":"HTTP version.","in":"path","name":"http_version","required":true,"schema":{"description":"HTTP version.","enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by HTTP requests for an HTTP version","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/ip_version/{ip_version}":{"get":{"description":"Retrieves the top locations, by HTTP requests, of the requested IP version.","operationId":"radar-get-http-top-locations-by-ip-version","parameters":[{"description":"IP version.","in":"path","name":"ip_version","required":true,"schema":{"description":"IP version.","enum":["IPv4","IPv6"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by HTTP requests for an IP version","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/os/{os}":{"get":{"description":"Retrieves the top locations, by HTTP requests, of the requested operating system.","operationId":"radar-get-http-top-locations-by-operating-system","parameters":[{"description":"Operating system.","in":"path","name":"os","required":true,"schema":{"description":"Operating system.","enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by TLS version.","in":"query","name":"tlsVersion","schema":{"description":"Filters results by TLS version.","example":"TLSv1_2","items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by HTTP requests for an OS","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/tls_version/{tls_version}":{"get":{"description":"Retrieves the top locations, by HTTP requests, of the requested TLS protocol version.","operationId":"radar-get-http-top-locations-by-tls-version","parameters":[{"description":"TLS version.","in":"path","name":"tls_version","required":true,"schema":{"description":"TLS version.","enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by device type.","in":"query","name":"deviceType","schema":{"description":"Filters results by device type.","example":"DESKTOP","items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","in":"query","name":"httpProtocol","schema":{"description":"Filters results by HTTP protocol (HTTP vs. HTTPS).","example":"HTTPS","items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filters results by HTTP version.","in":"query","name":"httpVersion","schema":{"description":"Filters results by HTTP version.","example":"HTTPv1","items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filters results by IP version (Ipv4 vs. IPv6).","in":"query","name":"ipVersion","schema":{"description":"Filters results by IP version (Ipv4 vs. IPv6).","example":"IPv4","items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filters results by operating system.","in":"query","name":"os","schema":{"description":"Filters results by operating system.","example":"WINDOWS","items":{"enum":["WINDOWS","MACOSX","IOS","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filters results by browser family.","in":"query","name":"browserFamily","schema":{"description":"Filters results by browser family.","example":"CHROME","items":{"enum":["CHROME","EDGE","FIREFOX","SAFARI"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by HTTP requests for a TLS version","tags":["Radar HTTP"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/leaked_credential_checks/summary/bot_class":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP authentication requests by bot class.","operationId":"radar-get-leaked-credential-checks-summary-by-bot-class","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by compromised credential status (clean vs. compromised).","in":"query","name":"compromised","schema":{"description":"Filters results by compromised credential status (clean vs. compromised).","example":"COMPROMISED","items":{"enum":["CLEAN","COMPROMISED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"bot":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"human":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["human","bot"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP authentication requests by bot class summary","tags":["Radar Leaked Credential Checks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Leaked Credentials Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/leaked_credentials/methods/summary_v2/) instead."}},"/radar/leaked_credential_checks/summary/compromised":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP authentication requests by compromised credential status.","operationId":"radar-get-leaked-credential-checks-summary-by-compromised","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"CLEAN":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"COMPROMISED":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["COMPROMISED","CLEAN"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP authentication requests by compromised credential status summary","tags":["Radar Leaked Credential Checks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Leaked Credentials Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/leaked_credentials/methods/summary_v2/) instead."}},"/radar/leaked_credential_checks/summary/{dimension}":{"get":{"description":"Retrieves an aggregated summary of HTTP authentication requests grouped by the specified dimension.","operationId":"radar-get-leaked-credential-checks-summary","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["COMPROMISED","BOT_CLASS"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by compromised credential status (clean vs. compromised).","in":"query","name":"compromised","schema":{"description":"Filters results by compromised credential status (clean vs. compromised).","example":"COMPROMISED","items":{"enum":["CLEAN","COMPROMISED"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"CLEAN":"85.123456","COMPROMISED":"14.876544"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP authentication requests distribution by dimension","tags":["Radar Leaked Credential Checks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/leaked_credential_checks/timeseries_groups/bot_class":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP authentication requests by bot class over time.","operationId":"radar-get-leaked-credential-checks-timeseries-group-by-bot-class","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by compromised credential status (clean vs. compromised).","in":"query","name":"compromised","schema":{"description":"Filters results by compromised credential status (clean vs. compromised).","example":"COMPROMISED","items":{"enum":["CLEAN","COMPROMISED"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"bot":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"human":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","human","bot"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP authentication requests by bot class time series","tags":["Radar Leaked Credential Checks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Leaked Credentials Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/leaked_credentials/methods/timeseries_groups_v2/) instead."}},"/radar/leaked_credential_checks/timeseries_groups/compromised":{"get":{"deprecated":true,"description":"Retrieves the distribution of HTTP authentication requests by compromised credential status over time.","operationId":"radar-get-leaked-credential-checks-timeseries-group-by-compromised","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"CLEAN":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"COMPROMISED":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","CLEAN","COMPROMISED"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get HTTP authentication requests by compromised credential status time series","tags":["Radar Leaked Credential Checks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Leaked Credentials Timeseries Groups By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/leaked_credentials/methods/timeseries_groups_v2/) instead."}},"/radar/leaked_credential_checks/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of HTTP authentication requests, grouped by the specified dimension over time.","operationId":"radar-get-leaked-credential-checks-timeseries-group","parameters":[{"description":"Specifies the attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the attribute by which to group the results.","enum":["COMPROMISED","BOT_CLASS"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"description":"Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","example":"LIKELY_AUTOMATED","items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filters results by compromised credential status (clean vs. compromised).","in":"query","name":"compromised","schema":{"description":"Filters results by compromised credential status (clean vs. compromised).","example":"COMPROMISED","items":{"enum":["CLEAN","COMPROMISED"],"type":"string"},"type":"array"}},{"description":"Filters results by leaked credential check result.","in":"query","name":"checkResult","schema":{"description":"Filters results by leaked credential check result.","example":"PASSWORD_LEAKED","items":{"enum":["CLEAN","USERNAME_LEAKED","USERNAME_PASSWORD_SIMILAR","USERNAME_AND_PASSWORD_LEAKED","PASSWORD_LEAKED"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE_CHANGE","MIN0_MAX"],"example":"MIN0_MAX","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"CLEAN":["85.123456"],"COMPROMISED":["14.876544"],"timestamps":["2024-07-30T03:00:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get time series distribution of HTTP authentication requests by dimension.","tags":["Radar Leaked Credential Checks"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/netflows/summary":{"get":{"deprecated":true,"description":"Retrieves the distribution of network traffic (NetFlows) by HTTP vs other protocols.","operationId":"radar-get-netflows-summary-deprecated","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"HTTP":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"OTHER":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["HTTP","OTHER"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get network traffic summary","tags":["Radar NetFlows"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Get Network Traffic Distribution By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/netflows/methods/summary_v2/) instead."}},"/radar/netflows/summary/{dimension}":{"get":{"description":"Retrieves the distribution of network traffic (NetFlows) by the specified dimension.","operationId":"radar-get-netflows-summary","parameters":[{"description":"Specifies the NetFlows attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the NetFlows attribute by which to group the results.","enum":["ADM1","PRODUCT"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Filters the results by network traffic product types.","in":"query","name":"product","schema":{"description":"Filters the results by network traffic product types.","example":"ALL","items":{"enum":["HTTP","ALL"],"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"type":"string"},"example":{"Germany":"25.084366","United States":"50.168733"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get network traffic distribution by dimension","tags":["Radar NetFlows"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/netflows/timeseries":{"get":{"description":"Retrieves network traffic (NetFlows) over time.","operationId":"radar-get-netflows-timeseries","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters the results by network traffic product types.","in":"query","name":"product","schema":{"description":"Filters the results by network traffic product types.","example":"ALL","items":{"enum":["HTTP","ALL"],"type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE_CHANGE","MIN0_MAX"],"example":"MIN0_MAX","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"},"values":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get network traffic time series","tags":["Radar NetFlows"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/netflows/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of NetFlows traffic, grouped by chosen the specified dimension over time.","operationId":"radar-get-netflows-timeseries-group","parameters":[{"description":"Specifies the NetFlows attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the NetFlows attribute by which to group the results.","enum":["ADM1","PRODUCT"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Filters the results by network traffic product types.","in":"query","name":"product","schema":{"description":"Filters the results by network traffic product types.","example":"ALL","items":{"enum":["HTTP","ALL"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"Germany":["25.084366"],"United States":["50.168733"],"timestamps":["2023-08-08T10:15:00Z"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get time series distribution of network traffic by dimension","tags":["Radar NetFlows"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/netflows/top/ases":{"get":{"description":"Retrieves the top autonomous systems by network traffic (NetFlows).","operationId":"radar-get-netflows-top-ases","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":16509,"type":"number"},"clientASName":{"example":"AMAZON-02","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by network traffic","tags":["Radar NetFlows"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/netflows/top/locations":{"get":{"description":"Retrieves the top locations by network traffic (NetFlows).","operationId":"radar-get-netflows-top-locations","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","in":"query","name":"geoId","schema":{"description":"Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs. Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689` excludes results from the 2267056 (Lisbon), but includes results from 5128638 (New York).","example":"2267056,360689","items":{"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryName","clientCountryAlpha2","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by network traffic","tags":["Radar NetFlows"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/origins":{"get":{"description":"Retrieves a list of origins with their regions.","operationId":"radar-get-origins","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Skips the specified number of objects before fetching the results.","in":"query","name":"offset","schema":{"description":"Skips the specified number of objects before fetching the results.","minimum":0,"type":"integer"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"origins":{"items":{"properties":{"regions":{"items":{"properties":{"region":{"description":"The region code.","example":"us-east-1","type":"string"}},"required":["region"],"type":"object"},"type":"array"},"slug":{"description":"The origin slug.","example":"amazon","type":"string"}},"required":["slug","regions"],"type":"object"},"type":"array"}},"required":["origins"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Origins","tags":["Radar Origins"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/origins/summary/{dimension}":{"get":{"description":"Retrieves an aggregated summary of origin metrics grouped by the specified dimension.","operationId":"radar-get-origins-summary","parameters":[{"description":"Specifies the origin attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the origin attribute by which to group the results.","enum":["REGION","SUCCESS_RATE","PERCENTILE"],"type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Filters results by origin.","in":"query","name":"origin","required":true,"schema":{"description":"Filters results by origin.","example":["AMAZON"],"items":{"description":"Origins.","enum":["AMAZON","GOOGLE","MICROSOFT","ORACLE"],"type":"string"},"type":"array"}},{"description":"Specifies the metric to retrieve.","in":"query","name":"metric","required":true,"schema":{"description":"Specifies the metric to retrieve.","enum":["CONNECTION_FAILURES","REQUESTS","RESPONSE_HEADER_RECEIVE_DURATION","TCP_HANDSHAKE_DURATION","TCP_RTT","TLS_HANDSHAKE_DURATION"],"example":"REQUESTS","type":"string"}},{"description":"Filters results by origin region.","in":"query","name":"region","schema":{"description":"Filters results by origin region.","example":["us-east-1"],"items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"additionalProperties":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"example":{"eu-west-1":"52.14","us-east-1":"45.23","us-west-2":"38.67"},"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get origin metrics distribution by dimension","tags":["Radar Origins"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/origins/timeseries":{"get":{"description":"Retrieves the time series of origin metrics for the specified origin.","operationId":"radar-get-origins-timeseries","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by origin.","in":"query","name":"origin","required":true,"schema":{"description":"Filters results by origin.","example":["AMAZON"],"items":{"description":"Origins.","enum":["AMAZON","GOOGLE","MICROSOFT","ORACLE"],"type":"string"},"type":"array"}},{"description":"Specifies the metric to retrieve.","in":"query","name":"metric","required":true,"schema":{"description":"Specifies the metric to retrieve.","enum":["CONNECTION_FAILURES","REQUESTS","RESPONSE_HEADER_RECEIVE_DURATION","TCP_HANDSHAKE_DURATION","TCP_RTT","TLS_HANDSHAKE_DURATION"],"example":"REQUESTS","type":"string"}},{"description":"Filters results by origin region.","in":"query","name":"region","schema":{"description":"Filters results by origin region.","example":["us-east-1"],"items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"additionalProperties":{"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"},"values":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"},"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"}},"required":["meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get origin metrics time series","tags":["Radar Origins"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/origins/timeseries_groups/{dimension}":{"get":{"description":"Retrieves the distribution of origin metrics grouped by the specified dimension over time.","operationId":"radar-get-origins-timeseries-group","parameters":[{"description":"Specifies the origin attribute by which to group the results.","in":"path","name":"dimension","required":true,"schema":{"description":"Specifies the origin attribute by which to group the results.","enum":["REGION","SUCCESS_RATE","PERCENTILE"],"type":"string"}},{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per group to the top items within the specified time range. When item count exceeds the limit, extra items appear grouped under an \"other\" category.","example":10,"type":"integer"}},{"description":"Filters results by origin.","in":"query","name":"origin","required":true,"schema":{"description":"Filters results by origin.","example":["AMAZON"],"items":{"description":"Origins.","enum":["AMAZON","GOOGLE","MICROSOFT","ORACLE"],"type":"string"},"type":"array"}},{"description":"Specifies the metric to retrieve.","in":"query","name":"metric","required":true,"schema":{"description":"Specifies the metric to retrieve.","enum":["CONNECTION_FAILURES","REQUESTS","RESPONSE_HEADER_RECEIVE_DURATION","TCP_HANDSHAKE_DURATION","TCP_RTT","TLS_HANDSHAKE_DURATION"],"example":"REQUESTS","type":"string"}},{"description":"Filters results by origin region.","in":"query","name":"region","schema":{"description":"Filters results by origin region.","example":["us-east-1"],"items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"default":"PERCENTAGE","description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX"],"example":"PERCENTAGE","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},"type":"array"},"example":{"eu-west-1":["52.14"],"timestamps":["2023-08-08T10:15:00Z"],"us-east-1":["45.23"],"us-west-2":["38.67"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get origin metrics time series grouped by dimension","tags":["Radar Origins"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/origins/{slug}":{"get":{"description":"Retrieves the requested origin information with its regions.","operationId":"radar-get-origin-details","parameters":[{"description":"Origin slug.","in":"path","name":"slug","required":true,"schema":{"description":"Origin slug.","enum":["AMAZON","GOOGLE","MICROSOFT","ORACLE"],"example":"amazon","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"origin":{"properties":{"regions":{"items":{"properties":{"region":{"description":"The region code.","example":"us-east-1","type":"string"}},"required":["region"],"type":"object"},"type":"array"},"slug":{"description":"The origin slug.","example":"amazon","type":"string"}},"required":["slug","regions"],"type":"object"}},"required":["origin"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Origin details","tags":["Radar Origins"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/quality/iqi/summary":{"get":{"description":"Retrieves a summary (percentiles) of bandwidth, latency, or DNS response time from the Radar Internet Quality Index (IQI).","operationId":"radar-get-quality-index-summary","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Defines which metric to return (bandwidth, latency, or DNS response time).","in":"query","name":"metric","required":true,"schema":{"description":"Defines which metric to return (bandwidth, latency, or DNS response time).","enum":["BANDWIDTH","DNS","LATENCY"],"example":"latency","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"p25":{"example":"32.20938","type":"string"},"p50":{"example":"61.819881","type":"string"},"p75":{"example":"133.813087","type":"string"}},"required":["p75","p50","p25"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Internet Quality Index (IQI) summary","tags":["Radar Quality"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/quality/iqi/timeseries_groups":{"get":{"description":"Retrieves a time series (percentiles) of bandwidth, latency, or DNS response time from the Radar Internet Quality Index (IQI).","operationId":"radar-get-quality-index-timeseries-group","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Enables interpolation for all series (using the average).","in":"query","name":"interpolation","schema":{"description":"Enables interpolation for all series (using the average).","type":"boolean"}},{"description":"Defines which metric to return (bandwidth, latency, or DNS response time).","in":"query","name":"metric","required":true,"schema":{"description":"Defines which metric to return (bandwidth, latency, or DNS response time).","enum":["BANDWIDTH","DNS","LATENCY"],"example":"latency","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"p25":{"items":{"example":"31.253439","type":"string"},"type":"array"},"p50":{"items":{"example":"60.337738","type":"string"},"type":"array"},"p75":{"items":{"example":"125.940175","type":"string"},"type":"array"},"timestamps":{"items":{"example":"2023-04-17T00:00:00Z","type":"string"},"type":"array"}},"required":["timestamps","p75","p50","p25"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Internet Quality Index (IQI) time series","tags":["Radar Quality"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/quality/speed/histogram":{"get":{"description":"Retrieves a histogram from the previous 90 days of Cloudflare Speed Test data, split into fixed bandwidth (Mbps), latency (ms), or jitter (ms) buckets.","operationId":"radar-get-quality-speed-histogram","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Specifies the width for every bucket in the histogram.","in":"query","name":"bucketSize","schema":{"description":"Specifies the width for every bucket in the histogram.","type":"integer"}},{"description":"Metrics to be returned.","in":"query","name":"metricGroup","schema":{"default":"bandwidth","description":"Metrics to be returned.","enum":["BANDWIDTH","LATENCY","JITTER"],"example":"bandwidth","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"histogram_0":{"properties":{"bandwidthDownload":{"items":{"example":"83681","type":"string"},"type":"array"},"bandwidthUpload":{"items":{"example":"181079","type":"string"},"type":"array"},"bucketMin":{"items":{"example":"0","type":"string"},"type":"array"}},"required":["bandwidthUpload","bandwidthDownload","bucketMin"],"type":"object"},"meta":{"description":"Metadata for the results.","properties":{"bucketSize":{"description":"The width for every bucket in the histogram.","type":"integer"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"totalTests":{"items":{"type":"integer"},"type":"array"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","bucketSize","totalTests"],"type":"object"}},"required":["histogram_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get speed tests histogram","tags":["Radar Quality"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/quality/speed/summary":{"get":{"description":"Retrieves a summary of bandwidth, latency, jitter, and packet loss, from the previous 90 days of Cloudflare Speed Test data.","operationId":"radar-get-quality-speed-summary","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"bandwidthDownload":{"example":"83.765201","type":"string"},"bandwidthUpload":{"example":"39.005561","type":"string"},"jitterIdle":{"example":"25.648713","type":"string"},"jitterLoaded":{"example":"77.462155","type":"string"},"latencyIdle":{"example":"83.165385","type":"string"},"latencyLoaded":{"example":"270.561124","type":"string"},"packetLoss":{"example":"1.23705","type":"string"}},"required":["bandwidthDownload","bandwidthUpload","latencyIdle","latencyLoaded","jitterIdle","jitterLoaded","packetLoss"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get speed tests summary","tags":["Radar Quality"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/quality/speed/top/ases":{"get":{"description":"Retrieves the top autonomous systems by bandwidth, latency, jitter, or packet loss, from the previous 90 days of Cloudflare Speed Test data.","operationId":"radar-get-quality-speed-top-ases","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Specifies the metric to order the results by.","in":"query","name":"orderBy","schema":{"default":"BANDWIDTH_DOWNLOAD","description":"Specifies the metric to order the results by.","enum":["BANDWIDTH_DOWNLOAD","BANDWIDTH_UPLOAD","LATENCY_IDLE","LATENCY_LOADED","JITTER_IDLE","JITTER_LOADED"],"type":"string"}},{"description":"Reverses the order of results.","in":"query","name":"reverse","schema":{"description":"Reverses the order of results.","type":"boolean"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"bandwidthDownload":{"example":"642.509004","type":"string"},"bandwidthUpload":{"example":"300.672274","type":"string"},"clientASN":{"example":33353,"type":"number"},"clientASName":{"example":"SIE-CGEI-ASN-1","type":"string"},"jitterIdle":{"example":"2.956908","type":"string"},"jitterLoaded":{"example":"19.500469","type":"string"},"latencyIdle":{"example":"15.925","type":"string"},"latencyLoaded":{"example":"65.65","type":"string"},"numTests":{"example":13123,"type":"number"},"rankPower":{"example":0.77,"type":"number"}},"required":["clientASN","clientASName","bandwidthDownload","bandwidthUpload","latencyIdle","latencyLoaded","jitterIdle","jitterLoaded","numTests","rankPower"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top ASes by speed test results","tags":["Radar Quality"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/quality/speed/top/locations":{"get":{"description":"Retrieves the top locations by bandwidth, latency, jitter, or packet loss, from the previous 90 days of Cloudflare Speed Test data.","operationId":"radar-get-quality-speed-top-locations","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Specifies the metric to order the results by.","in":"query","name":"orderBy","schema":{"default":"BANDWIDTH_DOWNLOAD","description":"Specifies the metric to order the results by.","enum":["BANDWIDTH_DOWNLOAD","BANDWIDTH_UPLOAD","LATENCY_IDLE","LATENCY_LOADED","JITTER_IDLE","JITTER_LOADED"],"type":"string"}},{"description":"Reverses the order of results.","in":"query","name":"reverse","schema":{"description":"Reverses the order of results.","type":"boolean"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"bandwidthDownload":{"example":"295.886073","type":"string"},"bandwidthUpload":{"example":"158.85269","type":"string"},"clientCountryAlpha2":{"example":"IS","type":"string"},"clientCountryName":{"example":"Iceland","type":"string"},"jitterIdle":{"example":"9.640685","type":"string"},"jitterLoaded":{"example":"46.480023","type":"string"},"latencyIdle":{"example":"15.208124","type":"string"},"latencyLoaded":{"example":"114.758887","type":"string"},"numTests":{"example":13123,"type":"number"},"rankPower":{"example":0.77,"type":"number"}},"required":["clientCountryAlpha2","clientCountryName","bandwidthDownload","bandwidthUpload","latencyIdle","latencyLoaded","jitterIdle","jitterLoaded","numTests","rankPower"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by speed test results","tags":["Radar Quality"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ranking/domain/{domain}":{"get":{"description":"Retrieves domain rank details. Cloudflare provides an ordered rank for the top 100 domains, but for the remainder it only provides ranking buckets like top 200 thousand, top one million, etc.. These are available through Radar datasets endpoints.","operationId":"radar-get-ranking-domain-details","parameters":[{"description":"Domain name.","in":"path","name":"domain","required":true,"schema":{"description":"Domain name.","example":"google.com","pattern":"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$","type":"string"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"The ranking type.","in":"query","name":"rankingType","schema":{"default":"POPULAR","description":"The ranking type.","enum":["POPULAR","TRENDING_RISE","TRENDING_STEADY"],"example":"POPULAR","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Includes top locations in the response.","in":"query","name":"includeTopLocations","schema":{"description":"Includes top locations in the response.","type":"boolean"}},{"description":"Filters results by the specified array of dates.","in":"query","name":"date","schema":{"description":"Filters results by the specified array of dates.","example":"2022-09-19","items":{"format":"date","type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"details_0":{"properties":{"bucket":{"description":"Only available in POPULAR ranking for the most recent ranking.","example":"2000","type":"string"},"categories":{"items":{"properties":{"id":{"example":81,"type":"integer"},"name":{"example":"Content Servers","type":"string"},"superCategoryId":{"example":26,"type":"integer"}},"required":["superCategoryId","name","id"],"type":"object"},"type":"array"},"rank":{"example":3,"type":"integer"},"top_locations":{"items":{"properties":{"locationCode":{"example":"US","type":"string"},"locationName":{"example":"United States","type":"string"},"rank":{"example":1,"type":"integer"}},"required":["rank","locationName","locationCode"],"type":"object"},"type":"array"}},"required":["categories"],"type":"object"},"meta":{"properties":{"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"}},"required":["dateRange"],"type":"object"}},"required":["details_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get domain rank details","tags":["Radar Domains Ranking"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ranking/internet_services/categories":{"get":{"description":"Retrieves the list of Internet services categories.","operationId":"radar-get-ranking-internet-services-categories","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"description":"Limits the number of objects returned in the response.","example":5,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by the specified array of dates.","in":"query","name":"date","schema":{"description":"Filters results by the specified array of dates.","example":"2022-09-19","items":{"format":"date","type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"categories_0":{"items":{"properties":{"name":{"example":"Generative AI","type":"string"}},"required":["name"],"type":"object"},"type":"array"}},"required":["categories_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Internet services categories","tags":["Radar Internet Services Ranking"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ranking/internet_services/timeseries_groups":{"get":{"description":"Retrieves Internet Services rank update changes over time.","operationId":"radar-get-ranking-internet-services-timeseries","parameters":[{"description":"Filters results by Internet service category.","in":"query","name":"serviceCategory","schema":{"description":"Filters results by Internet service category.","example":"Generative AI","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"anyOf":[{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},{"type":"number"}],"description":"A numeric string."},"type":"array"},"example":{"Google":[2],"timestamps":["2022-09-02"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Internet services rank time series","tags":["Radar Internet Services Ranking"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ranking/internet_services/top":{"get":{"description":"Retrieves top Internet services based on their rank.","operationId":"radar-get-ranking-top-internet-services","parameters":[{"description":"Filters results by Internet service category.","in":"query","name":"serviceCategory","schema":{"description":"Filters results by Internet service category.","example":"Generative AI","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"description":"Limits the number of objects returned in the response.","example":5,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by the specified array of dates.","in":"query","name":"date","schema":{"description":"Filters results by the specified array of dates.","example":"2022-09-19","items":{"format":"date","type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"rank":{"example":1,"type":"integer"},"service":{"example":"Google","type":"string"}},"required":["rank","service"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top Internet services","tags":["Radar Internet Services Ranking"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ranking/timeseries_groups":{"get":{"description":"Retrieves domains rank over time.","operationId":"radar-get-ranking-domain-timeseries","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"The ranking type.","in":"query","name":"rankingType","schema":{"default":"POPULAR","description":"The ranking type.","enum":["POPULAR","TRENDING_RISE","TRENDING_STEADY"],"example":"POPULAR","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 location codes.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 location codes.","example":"US","items":{"type":"string"},"type":"array"}},{"description":"Filters results by domain name. Specify a comma-separated list of domain names.","in":"query","name":"domains","schema":{"description":"Filters results by domain name. Specify a comma-separated list of domain names.","example":"google.com,facebook.com","items":{"example":"google.com","maxLength":253,"minLength":1,"pattern":"^(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)\\.)+(?:[A-Za-z]{2,63})$","type":"string"},"type":"array"}},{"description":"Filters results by domain category.","in":"query","name":"domainCategory","schema":{"description":"Filters results by domain category.","example":"News \u0026 Media","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"additionalProperties":{"items":{"anyOf":[{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"},{"type":"number"}],"description":"A numeric string."},"type":"array"},"example":{"google.com":[2],"timestamps":["2022-09-02"]},"properties":{"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get domains rank time series","tags":["Radar Domains Ranking"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ranking/top":{"get":{"description":"Retrieves the top or trending domains based on their rank. Popular domains are domains of broad appeal based on how people use the Internet. Trending domains are domains that are generating a surge in interest. For more information on top domains, see https://blog.cloudflare.com/radar-domain-rankings/.","operationId":"radar-get-ranking-top-domains","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"description":"Limits the number of objects returned in the response.","example":5,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 location codes.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 location codes.","example":"US","items":{"type":"string"},"type":"array"}},{"description":"Filters results by domain category.","in":"query","name":"domainCategory","schema":{"description":"Filters results by domain category.","example":"News \u0026 Media","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by the specified array of dates.","in":"query","name":"date","schema":{"description":"Filters results by the specified array of dates.","example":"2022-09-19","items":{"format":"date","type":"string"},"type":"array"}},{"description":"The ranking type.","in":"query","name":"rankingType","schema":{"default":"POPULAR","description":"The ranking type.","enum":["POPULAR","TRENDING_RISE","TRENDING_STEADY"],"example":"POPULAR","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"categories":{"items":{"properties":{"id":{"example":81,"type":"number"},"name":{"example":"Content Servers","type":"string"},"superCategoryId":{"example":26,"type":"number"}},"required":["superCategoryId","name","id"],"type":"object"},"type":"array"},"domain":{"example":"google.com","type":"string"},"pctRankChange":{"description":"Only available in TRENDING rankings.","example":10.8,"type":"number"},"rank":{"example":1,"type":"integer"}},"required":["rank","domain","categories"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top or trending domains","tags":["Radar Domains Ranking"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/robots_txt/top/domain_categories":{"get":{"description":"Retrieves the top domain categories by the number of robots.txt files parsed.","operationId":"radar-get-robots-txt-top-domain-categories-by-files-parsed","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by user agent category.","in":"query","name":"userAgentCategory","schema":{"default":"AI","description":"Filters results by user agent category.","enum":["AI"],"example":"AI","type":"string"}},{"description":"Filters results by the specified array of dates.","in":"query","name":"date","schema":{"description":"Filters results by the specified array of dates.","example":"2022-09-19","items":{"format":"date","type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"name":{"example":"News \u0026 Media","type":"string"},"value":{"example":273,"type":"integer"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top domain categories by robots.txt files parsed","tags":["Radar Robots.txt"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/robots_txt/top/user_agents/directive":{"get":{"description":"Retrieves the top user agents on robots.txt files.","operationId":"radar-get-robots-txt-top-user-agents-by-directive","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by user agent category.","in":"query","name":"userAgentCategory","schema":{"default":"AI","description":"Filters results by user agent category.","enum":["AI"],"example":"AI","type":"string"}},{"description":"Filters results by the specified array of dates.","in":"query","name":"date","schema":{"description":"Filters results by the specified array of dates.","example":"2022-09-19","items":{"format":"date","type":"string"},"type":"array"}},{"description":"Filters results by domain category.","in":"query","name":"domainCategory","schema":{"description":"Filters results by domain category.","example":"News \u0026 Media","items":{"maxLength":100,"type":"string"},"type":"array"}},{"description":"Filters results by robots.txt directive.","in":"query","name":"directive","schema":{"description":"Filters results by robots.txt directive.","enum":["ALLOW","DISALLOW"],"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"fully":{"example":235,"type":"integer"},"name":{"example":"GPTBot","type":"string"},"partially":{"example":38,"type":"integer"},"value":{"example":273,"type":"integer"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top user agents on robots.txt files","tags":["Radar Robots.txt"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/search/global":{"get":{"description":"Searches for locations, autonomous systems, reports, bots, certificate logs, certificate authorities, industries and verticals","operationId":"radar-get-search-global","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Limits the number of objects per search category.","in":"query","name":"limitPerGroup","schema":{"description":"Limits the number of objects per search category.","type":"number"}},{"description":"String used to perform the search operation.","in":"query","name":"query","required":true,"schema":{"description":"String used to perform the search operation.","example":"United","type":"string"}},{"description":"Search types included in results.","in":"query","name":"include","schema":{"description":"Search types included in results.","items":{"enum":["ADM1S","ASNS","BOTS","CERTIFICATE_AUTHORITIES","CERTIFICATE_LOGS","ORIGINS","ORIGIN_REGIONS","INDUSTRIES","LOCATIONS","NOTEBOOKS","TLDS","VERTICALS"],"type":"string"},"type":"array"}},{"description":"Search types excluded from results.","in":"query","name":"exclude","schema":{"description":"Search types excluded from results.","items":{"enum":["ADM1S","ASNS","BOTS","CERTIFICATE_AUTHORITIES","CERTIFICATE_LOGS","ORIGINS","ORIGIN_REGIONS","INDUSTRIES","LOCATIONS","NOTEBOOKS","TLDS","VERTICALS"],"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"search":{"items":{"properties":{"code":{"example":"13335","type":"string"},"name":{"example":"Cloudflare","type":"string"},"type":{"example":"asn","type":"string"}},"required":["code","name","type"],"type":"object"},"type":"array"}},"required":["search"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Search for locations, ASes, reports, and more","tags":["Radar Search"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/tcp_resets_timeouts/summary":{"get":{"description":"Retrieves the distribution of connection stage by TCP connections terminated within the first 10 packets by a reset or timeout.","operationId":"radar-get-tcp-resets-timeouts-summary","parameters":[{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"summary_0":{"properties":{"later_in_flow":{"description":"Connection resets within the first 10 packets from the client, but after the server has received multiple data packets.","example":"10","type":"string"},"no_match":{"description":"All other connections.","example":"65","type":"string"},"post_ack":{"description":"Connection resets or timeouts after the server received both a SYN packet and an ACK packet, meaning the connection was successfully established.","example":"5","type":"string"},"post_psh":{"description":"Connection resets or timeouts after the server received a packet with PSH flag set, following connection establishment.","example":"10","type":"string"},"post_syn":{"description":"Connection resets or timeouts after the server received only a single SYN packet.","example":"10","type":"string"}},"required":["no_match","post_syn","post_ack","post_psh","later_in_flow"],"type":"object"}},"required":["summary_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get TCP resets and timeouts summary","tags":["Radar TCP Resets and Timeouts"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/tcp_resets_timeouts/timeseries_groups":{"get":{"description":"Retrieves the distribution of connection stage by TCP connections terminated within the first 10 packets by a reset or timeout over time.","operationId":"radar-get-tcp-resets-timeouts-timeseries-group","parameters":[{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["15m","1h","1d","1w"],"example":"1h","type":"string"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"aggInterval":{"description":"Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","enum":["FIFTEEN_MINUTES","ONE_HOUR","ONE_DAY","ONE_WEEK","ONE_MONTH"],"type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units","aggInterval"],"type":"object"},"serie_0":{"properties":{"later_in_flow":{"items":{"description":"Connection resets within the first 10 packets from the client, but after the server has received multiple data packets.","example":"10","type":"string"},"type":"array"},"no_match":{"items":{"description":"All other connections.","example":"65","type":"string"},"type":"array"},"post_ack":{"items":{"description":"Connection resets or timeouts after the server received both a SYN packet and an ACK packet, meaning the connection was successfully established.","example":"5","type":"string"},"type":"array"},"post_psh":{"items":{"description":"Connection resets or timeouts after the server received a packet with PSH flag set, following connection establishment.","example":"10","type":"string"},"type":"array"},"post_syn":{"items":{"description":"Connection resets or timeouts after the server received only a single SYN packet.","example":"10","type":"string"},"type":"array"},"timestamps":{"items":{"format":"date-time","type":"string"},"type":"array"}},"required":["timestamps","no_match","post_syn","post_ack","post_psh","later_in_flow"],"type":"object"}},"required":["serie_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get TCP resets and timeouts time series","tags":["Radar TCP Resets and Timeouts"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/tlds":{"get":{"description":"Retrieves a list of TLDs.","operationId":"radar-get-tlds","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Skips the specified number of objects before fetching the results.","in":"query","name":"offset","schema":{"description":"Skips the specified number of objects before fetching the results.","minimum":0,"type":"integer"}},{"description":"Filters results by TLD manager.","in":"query","name":"tldManager","schema":{"description":"Filters results by TLD manager.","maxLength":100,"type":"string"}},{"description":"Filters results by TLD type.","in":"query","name":"tldType","schema":{"description":"Filters results by TLD type.","enum":["GENERIC","COUNTRY_CODE","GENERIC_RESTRICTED","INFRASTRUCTURE","SPONSORED"],"type":"string"}},{"description":"Filters results by top-level domain. Specify a comma-separated list of TLDs.","in":"query","name":"tld","schema":{"description":"Filters results by top-level domain. Specify a comma-separated list of TLDs.","example":"com,pt","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"tlds":{"items":{"properties":{"manager":{"description":"The organization that manages the TLD.","example":"VeriSign Global Registry Services","type":"string"},"tld":{"description":"The actual TLD.","example":"com","type":"string"},"type":{"description":"The type of TLD.","example":"GENERIC","type":"string"}},"required":["tld","type","manager"],"type":"object"},"type":"array"}},"required":["tlds"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List TLDs","tags":["Radar Top-Level Domains"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/tlds/{tld}":{"get":{"description":"Retrieves the requested TLD information.","operationId":"radar-get-tld-details","parameters":[{"description":"Top-level domain.","in":"path","name":"tld","required":true,"schema":{"description":"Top-level domain.","example":"com","maxLength":63,"minLength":2,"pattern":"^[a-z0-9](?:[a-z0-9-]*[a-z0-9])$","type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"tld":{"properties":{"manager":{"description":"The organization that manages the TLD.","example":"VeriSign Global Registry Services","type":"string"},"tld":{"description":"The actual TLD.","example":"com","type":"string"},"type":{"description":"The type of TLD.","example":"GENERIC","type":"string"}},"required":["tld","type","manager"],"type":"object"}},"required":["tld"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get TLD details","tags":["Radar Top-Level Domains"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/traffic_anomalies":{"get":{"description":"Retrieves the latest Internet traffic anomalies, which are signals that might indicate an outage. These alerts are automatically detected by Radar and manually verified by our team.","operationId":"radar-get-traffic-anomalies","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Skips the specified number of objects before fetching the results.","in":"query","name":"offset","schema":{"description":"Skips the specified number of objects before fetching the results.","minimum":0,"type":"integer"}},{"description":"Filters results by date range.","in":"query","name":"dateRange","schema":{"description":"Filters results by date range.","example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"}},{"description":"Start of the date range (inclusive).","in":"query","name":"dateStart","schema":{"description":"Start of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"in":"query","name":"status","schema":{"enum":["VERIFIED","UNVERIFIED"],"type":"string"}},{"description":"Filters results by entity type (LOCATION, AS, or ORIGIN).","in":"query","name":"type","schema":{"description":"Filters results by entity type (LOCATION, AS, or ORIGIN).","example":"LOCATION","items":{"enum":["LOCATION","AS","ORIGIN"],"type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify a single Autonomous System Number (ASN) as integer.","example":174,"type":"integer"}},{"description":"Filters results by location. Specify an alpha-2 location code.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify an alpha-2 location code.","example":"US","maxLength":2,"minLength":2,"type":"string"}},{"description":"Filters results by origin.","in":"query","name":"origin","schema":{"description":"Filters results by origin.","example":"amazon-us-east-1","maxLength":100,"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"trafficAnomalies":{"items":{"properties":{"asnDetails":{"properties":{"asn":{"example":"189","type":"string"},"locations":{"properties":{"code":{"example":"US","type":"string"},"name":{"example":"United States","type":"string"}},"required":["code","name"],"type":"object"},"name":{"example":"LUMEN-LEGACY-L3-PARTITION","type":"string"}},"required":["asn","name"],"type":"object"},"endDate":{"format":"date-time","type":"string"},"locationDetails":{"properties":{"code":{"example":"US","type":"string"},"name":{"example":"United States","type":"string"}},"required":["code","name"],"type":"object"},"originDetails":{"properties":{"name":{"example":"us-east-1 Amazon Web Services","type":"string"},"origin":{"example":"amazon-us-east-1","type":"string"}},"required":["origin","name"],"type":"object"},"startDate":{"example":"2023-08-02T23:15:00Z","type":"string"},"status":{"example":"UNVERIFIED","type":"string"},"type":{"example":"LOCATION","type":"string"},"uuid":{"example":"55a57f33-8bc0-4984-b4df-fdaff72df39d","type":"string"},"visibleInDataSources":{"items":{"type":"string"},"type":"array"}},"required":["uuid","type","status","startDate"],"type":"object"},"type":"array"}},"required":["trafficAnomalies"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"List of Internet traffic anomalies."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get latest Internet traffic anomalies","tags":["Radar Traffic Anomalies"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/traffic_anomalies/locations":{"get":{"description":"Retrieves the sum of Internet traffic anomalies, grouped by location. These anomalies are signals that might indicate an outage, automatically detected by Radar and manually verified by our team.","operationId":"radar-get-traffic-anomalies-top","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Filters results by date range.","in":"query","name":"dateRange","schema":{"description":"Filters results by date range.","example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"}},{"description":"Start of the date range (inclusive).","in":"query","name":"dateStart","schema":{"description":"Start of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","format":"date-time","type":"string"}},{"in":"query","name":"status","schema":{"enum":["VERIFIED","UNVERIFIED"],"type":"string"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"trafficAnomalies":{"items":{"properties":{"clientCountryAlpha2":{"example":"PT","type":"string"},"clientCountryName":{"example":"Portugal","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["trafficAnomalies"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"List of locations with number of traffic anomalies."},"400":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"},"result":{"type":"object"},"success":{"example":false,"type":"boolean"}},"required":["result","success","errors"],"type":"object"}}},"description":"Bad request."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top locations by total traffic anomalies","tags":["Radar Traffic Anomalies"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/verified_bots/top/bots":{"get":{"deprecated":true,"description":"Retrieves the top verified bots by HTTP requests, with owner and category.","operationId":"radar-get-verified-bots-top-by-http-requests","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"botCategory":{"example":"Search Engine Crawler","type":"string"},"botName":{"example":"GoogleBot","type":"string"},"botOwner":{"example":"Google","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["botName","botCategory","botOwner","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top verified bots by HTTP requests","tags":["Radar Verified Bots"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Bots API](https://developers.cloudflare.com/api/resources/radar/subresources/bots/) instead."}},"/radar/verified_bots/top/categories":{"get":{"deprecated":true,"description":"Retrieves the top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests.","operationId":"radar-get-verified-bots-top-categories-by-http-requests","parameters":[{"description":"Limits the number of objects returned in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limits the number of objects returned in the response.","example":5,"exclusiveMinimum":true,"minimum":0,"type":"integer"}},{"description":"Array of names used to label the series in the response.","in":"query","name":"name","schema":{"description":"Array of names used to label the series in the response.","items":{"example":"main_series","type":"string"},"type":"array"}},{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"description":"Filters results by date range. For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","example":"7d","items":{"example":"7d","pattern":"^((([1-9]|[1-9][0-9]|[1-2][0-9][0-9]|3[0-5][0-9]|36[0-4])[d](control)?)|(([1-9]|[1-4][0-9]|5[0-2])[w](control)?))$","type":"string"},"type":"array"}},{"description":"Start of the date range.","in":"query","name":"dateStart","schema":{"description":"Start of the date range.","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"description":"End of the date range (inclusive).","example":"2023-09-01T11:41:33.782Z","items":{"format":"date-time","type":"string"},"type":"array"}},{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"description":"Filters results by Autonomous System. Specify one or more Autonomous System Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","items":{"type":"string"},"type":"array"}},{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"description":"Filters results by location. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude locations from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","items":{"type":"string"},"type":"array"}},{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","in":"query","name":"continent","schema":{"description":"Filters results by continent. Specify a comma-separated list of alpha-2 codes. Prefix with `-` to exclude continents from results. For example, `-EU,NA` excludes results from EU, but includes results from NA.","example":"EU,NA","items":{"type":"string"},"type":"array"}},{"description":"Format in which results will be returned.","in":"query","name":"format","schema":{"description":"Format in which results will be returned.","enum":["JSON","CSV"],"example":"json","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"description":"Metadata for the results.","properties":{"confidenceInfo":{"nullable":true,"properties":{"annotations":{"items":{"description":"Annotation associated with the result (e.g. outage or other type of event).","properties":{"dataSource":{"description":"Data source for annotations.","enum":["ALL","AI_BOTS","AI_GATEWAY","BGP","BOTS","CONNECTION_ANOMALY","CT","DNS","DNS_MAGNITUDE","DNS_AS112","DOS","EMAIL_ROUTING","EMAIL_SECURITY","FW","FW_PG","HTTP","HTTP_CONTROL","HTTP_CRAWLER_REFERER","HTTP_ORIGINS","IQI","LEAKED_CREDENTIALS","NET","ROBOTS_TXT","SPEED","WORKERS_AI"],"type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endDate":{"format":"date-time","type":"string"},"eventType":{"description":"Event type for annotations.","enum":["EVENT","GENERAL","OUTAGE","PARTIAL_PROJECTION","PIPELINE","TRAFFIC_ANOMALY"],"type":"string"},"isInstantaneous":{"description":"Whether event is a single point in time or a time range.","type":"boolean"},"linkedUrl":{"format":"uri","type":"string"},"startDate":{"format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startDate","endDate","linkedUrl","isInstantaneous"],"type":"object"},"type":"array"},"level":{"description":"Provides an indication of how much confidence Cloudflare has in the data.","type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"items":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"type":"array"},"lastUpdated":{"description":"Timestamp of the last dataset update.","format":"date-time","type":"string"},"normalization":{"description":"Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","enum":["PERCENTAGE","MIN0_MAX","MIN_MAX","RAW_VALUES","PERCENTAGE_CHANGE","ROLLING_AVERAGE","OVERLAPPED_PERCENTAGE","RATIO"],"type":"string"},"units":{"description":"Measurement units for the results.","items":{"properties":{"name":{"example":"*","type":"string"},"value":{"example":"requests","type":"string"}},"required":["name","value"],"type":"object"},"type":"array"}},"required":["dateRange","confidenceInfo","normalization","lastUpdated","units"],"type":"object"},"top_0":{"items":{"properties":{"botCategory":{"example":"Search","type":"string"},"value":{"description":"A numeric string.","example":"10","pattern":"^\\d+$","type":"string"}},"required":["botCategory","value"],"type":"object"},"type":"array"}},"required":["top_0","meta"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful response."},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found.","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get top verified bot categories by HTTP requests","tags":["Radar Verified Bots"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"Use [Radar Bots API](https://developers.cloudflare.com/api/resources/radar/subresources/bots/) instead."}},"/ready":{"get":{"description":"Return a success message after running readiness checks","responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Run readiness checks","tags":["brand_protection"]}},"/signed-url":{"get":{"responses":{"default":{"$ref":"#/components/responses/brand-protection-api_DEFAULT_ERROR"}},"security":[{"api_token":[]}],"summary":"Internal route for testing signed URLs","tags":["logo_match"]}},"/tenants/{tenant_id}":{"get":{"description":"Retrieves a Tenant by Tenant ID.","operationId":"Tenants_retrieveTenant","parameters":[{"in":"path","name":"tenant_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"$ref":"#/components/schemas/organizations-api_Tenant"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get tenant","tags":["Tenants"]}},"/tenants/{tenant_id}/account_types":{"get":{"description":"List of account types available for the Tenant to provision accounts.","operationId":"Tenants_validAccountTypes","parameters":[{"in":"path","name":"tenant_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"items":{"type":"string"},"type":"array"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get tenant account types","tags":["Tenants"]}},"/tenants/{tenant_id}/accounts":{"get":{"description":"List of accounts for the Tenant.","operationId":"Tenants_listAccounts","parameters":[{"in":"path","name":"tenant_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"items":{"$ref":"#/components/schemas/organizations-api_Account"},"type":"array"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List tenant accounts","tags":["Tenants"]}},"/tenants/{tenant_id}/entitlements":{"get":{"description":"List of innate entitlements available for the Tenant.","operationId":"Tenants_listEntitlements","parameters":[{"in":"path","name":"tenant_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"$ref":"#/components/schemas/organizations-api_InnateEntitlements"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List tenant entitlements","tags":["Tenants"]}},"/tenants/{tenant_id}/memberships":{"get":{"description":"List of active members (Cloudflare users) for the Tenant.","operationId":"Tenants_listMemberships","parameters":[{"in":"path","name":"tenant_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"items":{"$ref":"#/components/schemas/organizations-api_TenantMembership"},"type":"array"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List tenant memberships","tags":["Tenants"]}},"/user":{"get":{"operationId":"user-user-details","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_user_response"}}},"description":"User Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"User Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"User Details","tags":["User"],"x-api-token-group":["User Details Write","User Details Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Edit part of your user details.","operationId":"user-edit-user","requestBody":{"content":{"application/json":{"schema":{"properties":{"country":{"$ref":"#/components/schemas/iam_country"},"first_name":{"$ref":"#/components/schemas/iam_first_name"},"last_name":{"$ref":"#/components/schemas/iam_last_name"},"telephone":{"$ref":"#/components/schemas/iam_telephone"},"zipcode":{"$ref":"#/components/schemas/iam_zipcode"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_user_response"}}},"description":"Edit User response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Edit User response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Edit User","tags":["User"],"x-api-token-group":["User Details Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/audit_logs":{"get":{"description":"Gets a list of audit logs for a user account. Can be filtered by who made the change, on which zone, and the timeframe of the change.","operationId":"audit-logs-get-user-audit-logs","parameters":[{"in":"query","name":"id","schema":{"description":"Finds a specific log by its ID.","example":"f174be97-19b1-40d6-954d-70cd5fbd52db","type":"string"}},{"in":"query","name":"export","schema":{"description":"Indicates that this request is an export of logs in CSV format.","example":true,"type":"boolean"}},{"in":"query","name":"action.type","schema":{"description":"Filters by the action type.","example":"add","type":"string"}},{"in":"query","name":"actor.ip","schema":{"description":"Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.","example":"17.168.228.63","type":"string"}},{"in":"query","name":"actor.email","schema":{"description":"Filters by the email address of the actor that made the change.","example":"alice@example.com","format":"email","type":"string"}},{"in":"query","name":"since","schema":{"oneOf":[{"description":"Limits the returned results to logs newer than the specified date. A `full-date` that conforms to RFC3339.","example":"2019-04-30","format":"date","type":"string"},{"description":"Limits the returned results to logs newer than the specified date. A `date-time` that conforms to RFC3339.","example":"2019-04-30T01:12:20Z","format":"date-time","type":"string"}]}},{"in":"query","name":"before","schema":{"oneOf":[{"description":"Limits the returned results to logs older than the specified date. A `full-date` that conforms to RFC3339.","example":"2019-04-30","format":"date","type":"string"},{"description":"Limits the returned results to logs older than the specified date. A `date-time` that conforms to RFC3339.","example":"2019-04-30T01:12:20Z","format":"date-time","type":"string"}]}},{"in":"query","name":"zone.name","schema":{"description":"Filters by the name of the zone associated to the change.","example":"example.com","type":"string"}},{"in":"query","name":"direction","schema":{"default":"desc","description":"Changes the direction of the chronological sorting.","enum":["desc","asc"],"example":"desc","type":"string"}},{"in":"query","name":"per_page","schema":{"default":100,"description":"Sets the number of results to return per page.","example":25,"maximum":1000,"minimum":1,"type":"number"}},{"in":"query","name":"page","schema":{"default":1,"description":"Defines which page of results to return.","example":50,"minimum":1,"type":"number"}},{"in":"query","name":"hide_user_logs","schema":{"default":false,"description":"Indicates whether or not to hide user level audit logs.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/aaa_audit_logs_response_collection"}}},"description":"Get user audit logs response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/aaa_audit_logs_response_collection"},{"$ref":"#/components/schemas/aaa_api-response-common-failure"}]}}},"description":"Get user audit logs response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get user audit logs","tags":["Audit Logs"],"x-api-token-group":["Account Settings Write","Account Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/billing/history":{"get":{"deprecated":true,"description":"Accesses your billing history object.","operationId":"user-billing-history-(-deprecated)-billing-history-details","parameters":[{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of items per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Field to order billing history by.","enum":["type","occurred_at","action"],"example":"occurred_at","type":"string"}},{"in":"query","name":"occurred_at","schema":{"$ref":"#/components/schemas/bill-subs-api_occurred_at"}},{"in":"query","name":"type","schema":{"description":"The billing item type.","example":"charge","maxLength":30,"readOnly":true,"type":"string"}},{"in":"query","name":"action","schema":{"description":"The billing item action.","example":"subscription","maxLength":30,"readOnly":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_billing_history_collection"}}},"description":"Billing History Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_billing_history_collection"},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"Billing History Details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Billing History Details","tags":["User Billing History"],"x-api-token-group":["Billing Write","Billing Read"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/billing/profile":{"get":{"deprecated":true,"description":"Accesses your billing profile object.","operationId":"user-billing-profile-(-deprecated)-billing-profile-details","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_billing_response_single"}}},"description":"Billing Profile Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_billing_response_single"},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"Billing Profile Details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Billing Profile Details","tags":["User Billing Profile"],"x-api-token-group":["Billing Write","Billing Read"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/firewall/access_rules/rules":{"get":{"description":"Fetches IP Access rules of the user. You can filter the results using several optional parameters.","operationId":"ip-access-rules-for-a-user-list-ip-access-rules","parameters":[{"in":"query","name":"mode","schema":{"$ref":"#/components/schemas/firewall_schemas-mode"}},{"in":"query","name":"configuration.target","schema":{"description":"Defines the target to search in existing rules.","enum":["ip","ip_range","asn","country"],"example":"ip","type":"string"}},{"in":"query","name":"configuration.value","schema":{"description":"Defines the target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.\nNotes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.","example":"198.51.100.4","type":"string"}},{"in":"query","name":"notes","schema":{"description":"Defines the string to search for in the notes of existing IP Access rules.\nNotes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.","example":"my note","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"Defines the search requirements. When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.","enum":["any","all"],"type":"string"}},{"in":"query","name":"page","schema":{"description":"Defines the requested page within paginated list of results.","example":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"description":"Defines the maximum number of results requested.","example":20,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Defines the field used to sort returned rules.","enum":["configuration.target","configuration.value","mode"],"example":"mode","type":"string"}},{"in":"query","name":"direction","schema":{"description":"Defines the direction used to sort returned rules.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_rule_collection_response"}}},"description":"List IP Access rules response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_rule_collection_response"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"List IP Access rules response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List IP Access rules","tags":["IP Access rules for a user"],"x-api-token-group":["Account Firewall Access Rules Write","Account Firewall Access Rules Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a new IP Access rule for all zones owned by the current user.\n\nNote: To create an IP Access rule that applies to a specific zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.","operationId":"ip-access-rules-for-a-user-create-an-ip-access-rule","requestBody":{"content":{"application/json":{"schema":{"properties":{"configuration":{"$ref":"#/components/schemas/firewall_configuration"},"mode":{"$ref":"#/components/schemas/firewall_schemas-mode"},"notes":{"allOf":[{"$ref":"#/components/schemas/firewall_notes"},{"default":""}]}},"required":["mode","configuration"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_rule_single_response"}}},"description":"Create an IP Access rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_rule_single_response"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Create an IP Access rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create an IP Access rule","tags":["IP Access rules for a user"],"x-api-token-group":["Account Firewall Access Rules Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/firewall/access_rules/rules/{rule_id}":{"delete":{"description":"Deletes an IP Access rule at the user level.\n\nNote: Deleting a user-level rule will affect all zones owned by the user.","operationId":"ip-access-rules-for-a-user-delete-an-ip-access-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_rule_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_rule_single_id_response"}}},"description":"Delete an IP Access rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_rule_single_id_response"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Delete an IP Access rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an IP Access rule","tags":["IP Access rules for a user"],"x-api-token-group":["Account Firewall Access Rules Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates an IP Access rule defined at the user level. You can only update the rule action (`mode` parameter) and notes.","operationId":"ip-access-rules-for-a-user-update-an-ip-access-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_rule_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"mode":{"$ref":"#/components/schemas/firewall_schemas-mode"},"notes":{"$ref":"#/components/schemas/firewall_notes"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_rule_single_response"}}},"description":"Update an IP Access rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_rule_single_response"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update an IP Access rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an IP Access rule","tags":["IP Access rules for a user"],"x-api-token-group":["Account Firewall Access Rules Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/invites":{"get":{"description":"Lists all invitations associated with my user.","operationId":"user'-s-invites-list-invitations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_schemas-collection_invite_response"}}},"description":"List Invitations response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"List Invitations response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Invitations","tags":["User's Invites"],"x-api-token-group":["Memberships Write","Memberships Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/user/invites/{invite_id}":{"get":{"description":"Gets the details of an invitation.","operationId":"user'-s-invites-invitation-details","parameters":[{"in":"path","name":"invite_id","required":true,"schema":{"$ref":"#/components/schemas/iam_invite_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_invite_response"}}},"description":"Invitation Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Invitation Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Invitation Details","tags":["User's Invites"],"x-api-token-group":["Memberships Write","Memberships Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Responds to an invitation.","operationId":"user'-s-invites-respond-to-invitation","parameters":[{"in":"path","name":"invite_id","required":true,"schema":{"$ref":"#/components/schemas/iam_invite_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"status":{"description":"Status of your response to the invitation (rejected or accepted).","enum":["accepted","rejected"],"example":"accepted"}},"required":["status"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_invite_response"}}},"description":"Respond to Invitation response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Respond to Invitation response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Respond to Invitation","tags":["User's Invites"],"x-api-token-group":["Memberships Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/user/load_balancers/monitors":{"get":{"description":"List configured monitors for a user.","operationId":"load-balancer-monitors-list-monitors","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-response-collection"}}},"description":"Successful list monitors response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-response-collection"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Failed list monitors response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Monitors","tags":["Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]},"post":{"description":"Create a configured monitor.","operationId":"load-balancer-monitors-create-monitor","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-editable"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-response-single"}}},"description":"Create Monitor response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-response-single"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Create Monitor response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Monitor","tags":["Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]}},"/user/load_balancers/monitors/{monitor_id}":{"delete":{"description":"Delete a configured monitor.","operationId":"load-balancer-monitors-delete-monitor","parameters":[{"in":"path","name":"monitor_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_id_response"}}},"description":"Delete Monitor response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_id_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Delete Monitor response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Monitor","tags":["Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]},"get":{"description":"List a single configured monitor for a user.","operationId":"load-balancer-monitors-monitor-details","parameters":[{"in":"path","name":"monitor_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-response-single"}}},"description":"Monitor Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-response-single"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Monitor Details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Monitor Details","tags":["Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]},"patch":{"description":"Apply changes to an existing monitor, overwriting the supplied properties.","operationId":"load-balancer-monitors-patch-monitor","parameters":[{"in":"path","name":"monitor_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-editable"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-response-single"}}},"description":"Patch Monitor response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-response-single"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Patch Monitor response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Monitor","tags":["Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]},"put":{"description":"Modify a configured monitor.","operationId":"load-balancer-monitors-update-monitor","parameters":[{"in":"path","name":"monitor_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-editable"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-response-single"}}},"description":"Update Monitor response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-response-single"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Update Monitor response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Monitor","tags":["Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]}},"/user/load_balancers/monitors/{monitor_id}/preview":{"post":{"description":"Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.","operationId":"load-balancer-monitors-preview-monitor","parameters":[{"in":"path","name":"monitor_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-editable"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_preview_response"}}},"description":"Preview Monitor response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_preview_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Preview Monitor response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Preview Monitor","tags":["Load Balancer Monitors"]}},"/user/load_balancers/monitors/{monitor_id}/references":{"get":{"description":"Get the list of resources that reference the provided monitor.","operationId":"load-balancer-monitors-list-monitor-references","parameters":[{"in":"path","name":"monitor_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_monitor-references-response"}}},"description":"List Monitor References response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-references-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"List Monitor References response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Monitor References","tags":["Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]}},"/user/load_balancers/pools":{"get":{"description":"List configured pools.","operationId":"load-balancer-pools-list-pools","parameters":[{"in":"query","name":"monitor","schema":{"description":"The ID of the Monitor to use for checking the health of origins within this pool.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-response_collection"}}},"description":"List Pools response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-response_collection"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"List Pools response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Pools","tags":["Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]},"patch":{"description":"Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`.","operationId":"load-balancer-pools-patch-pools","requestBody":{"content":{"application/json":{"schema":{"properties":{"notification_email":{"$ref":"#/components/schemas/load-balancing_patch_pools_notification_email"}},"type":"string"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-response_collection"}}},"description":"Patch Pools response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-response_collection"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Patch Pools response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Pools","tags":["Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]},"post":{"description":"Create a new pool.","operationId":"load-balancer-pools-create-pool","requestBody":{"content":{"application/json":{"schema":{"properties":{"check_regions":{"$ref":"#/components/schemas/load-balancing_check_regions"},"description":{"$ref":"#/components/schemas/load-balancing_schemas-description"},"enabled":{"$ref":"#/components/schemas/load-balancing_enabled"},"latitude":{"$ref":"#/components/schemas/load-balancing_latitude"},"load_shedding":{"$ref":"#/components/schemas/load-balancing_load_shedding"},"longitude":{"$ref":"#/components/schemas/load-balancing_longitude"},"minimum_origins":{"$ref":"#/components/schemas/load-balancing_minimum_origins"},"monitor":{"$ref":"#/components/schemas/load-balancing_monitor_id"},"monitor_group":{"$ref":"#/components/schemas/load-balancing_monitor_group_id"},"name":{"$ref":"#/components/schemas/load-balancing_name"},"networks":{"$ref":"#/components/schemas/load-balancing_networks"},"notification_email":{"$ref":"#/components/schemas/load-balancing_notification_email"},"notification_filter":{"$ref":"#/components/schemas/load-balancing_notification_filter"},"origin_steering":{"$ref":"#/components/schemas/load-balancing_origin_steering"},"origins":{"$ref":"#/components/schemas/load-balancing_origins"}},"required":["origins","name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-single_response"}}},"description":"Create Pool response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-single_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Create Pool response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Pool","tags":["Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]}},"/user/load_balancers/pools/{pool_id}":{"delete":{"description":"Delete a configured pool.","operationId":"load-balancer-pools-delete-pool","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-id_response"}}},"description":"Delete Pool response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-id_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Delete Pool response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Pool","tags":["Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]},"get":{"description":"Fetch a single configured pool.","operationId":"load-balancer-pools-pool-details","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-single_response"}}},"description":"Pool Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-single_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Pool Details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Pool Details","tags":["Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]},"patch":{"description":"Apply changes to an existing pool, overwriting the supplied properties.","operationId":"load-balancer-pools-patch-pool","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"check_regions":{"$ref":"#/components/schemas/load-balancing_check_regions"},"description":{"$ref":"#/components/schemas/load-balancing_schemas-description"},"disabled_at":{"$ref":"#/components/schemas/load-balancing_schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/load-balancing_enabled"},"latitude":{"$ref":"#/components/schemas/load-balancing_latitude"},"load_shedding":{"$ref":"#/components/schemas/load-balancing_load_shedding"},"longitude":{"$ref":"#/components/schemas/load-balancing_longitude"},"minimum_origins":{"$ref":"#/components/schemas/load-balancing_minimum_origins"},"monitor":{"$ref":"#/components/schemas/load-balancing_monitor_id"},"monitor_group":{"$ref":"#/components/schemas/load-balancing_monitor_group_id"},"name":{"$ref":"#/components/schemas/load-balancing_name"},"notification_email":{"$ref":"#/components/schemas/load-balancing_notification_email"},"notification_filter":{"$ref":"#/components/schemas/load-balancing_notification_filter"},"origin_steering":{"$ref":"#/components/schemas/load-balancing_origin_steering"},"origins":{"$ref":"#/components/schemas/load-balancing_origins"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-single_response"}}},"description":"Patch Pool response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-single_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Patch Pool response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Pool","tags":["Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]},"put":{"description":"Modify a configured pool.","operationId":"load-balancer-pools-update-pool","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"check_regions":{"$ref":"#/components/schemas/load-balancing_check_regions"},"description":{"$ref":"#/components/schemas/load-balancing_schemas-description"},"disabled_at":{"$ref":"#/components/schemas/load-balancing_schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/load-balancing_enabled"},"latitude":{"$ref":"#/components/schemas/load-balancing_latitude"},"load_shedding":{"$ref":"#/components/schemas/load-balancing_load_shedding"},"longitude":{"$ref":"#/components/schemas/load-balancing_longitude"},"minimum_origins":{"$ref":"#/components/schemas/load-balancing_minimum_origins"},"monitor":{"$ref":"#/components/schemas/load-balancing_monitor_id"},"monitor_group":{"$ref":"#/components/schemas/load-balancing_monitor_group_id"},"name":{"$ref":"#/components/schemas/load-balancing_name"},"networks":{"$ref":"#/components/schemas/load-balancing_networks"},"notification_email":{"$ref":"#/components/schemas/load-balancing_notification_email"},"notification_filter":{"$ref":"#/components/schemas/load-balancing_notification_filter"},"origin_steering":{"$ref":"#/components/schemas/load-balancing_origin_steering"},"origins":{"$ref":"#/components/schemas/load-balancing_origins"}},"required":["origins","name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_schemas-single_response"}}},"description":"Update Pool response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_schemas-single_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Update Pool response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Pool","tags":["Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write"]}},"/user/load_balancers/pools/{pool_id}/health":{"get":{"description":"Fetch the latest pool health status for a single pool.","operationId":"load-balancer-pools-pool-health-details","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_health_details"}}},"description":"Pool Health Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_health_details"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Pool Health Details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Pool Health Details","tags":["Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]}},"/user/load_balancers/pools/{pool_id}/preview":{"post":{"description":"Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.","operationId":"load-balancer-pools-preview-pool","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_monitor-editable"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_preview_response"}}},"description":"Preview Pool response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_preview_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Preview Pool response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Preview Pool","tags":["Load Balancer Pools"]}},"/user/load_balancers/pools/{pool_id}/references":{"get":{"description":"Get the list of resources that reference the provided pool.","operationId":"load-balancer-pools-list-pool-references","parameters":[{"in":"path","name":"pool_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_pools-references-response"}}},"description":"List Pool References response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_pools-references-response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"List Pool References response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Pool References","tags":["Load Balancer Pools"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]}},"/user/load_balancers/preview/{preview_id}":{"get":{"description":"Get the result of a previous preview operation using the provided preview_id.","operationId":"load-balancer-monitors-preview-result","parameters":[{"in":"path","name":"preview_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_preview_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_preview_result_response"}}},"description":"Preview Result response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_preview_result_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Preview Result response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Preview Result","tags":["Load Balancer Monitors"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]}},"/user/load_balancing_analytics/events":{"get":{"description":"List origin health changes.","operationId":"load-balancer-healthcheck-events-list-healthcheck-events","parameters":[{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/load-balancing_until"}},{"in":"query","name":"pool_name","schema":{"$ref":"#/components/schemas/load-balancing_pool_name"}},{"in":"query","name":"origin_healthy","schema":{"$ref":"#/components/schemas/load-balancing_origin_healthy"}},{"in":"query","name":"pool_id","schema":{"$ref":"#/components/schemas/load-balancing_schemas-identifier"}},{"in":"query","name":"since","schema":{"description":"Start date and time of requesting data period in the ISO8601 format.","example":"2016-11-11T12:00:00Z","format":"date-time","type":"string"}},{"in":"query","name":"origin_name","schema":{"description":"The name for the origin to filter.","example":"primary-dc-1","type":"string"}},{"in":"query","name":"pool_healthy","schema":{"default":true,"description":"If true, filter events where the pool status is healthy. If false, filter events where the pool status is unhealthy.","example":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-response_collection"}}},"description":"List Healthcheck Events response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_components-schemas-response_collection"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"List Healthcheck Events response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Healthcheck Events","tags":["Load Balancer Healthcheck Events"],"x-api-token-group":["Load Balancing: Monitors and Pools Write","Load Balancing: Monitors and Pools Read"]}},"/user/organizations":{"get":{"deprecated":true,"description":"Lists organizations the user is associated with.","operationId":"user'-s-organizations-list-organizations","parameters":[{"in":"query","name":"name","schema":{"$ref":"#/components/schemas/iam_schemas-name"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of organizations per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Field to order organizations by.","enum":["id","name","status"],"example":"status","type":"string"}},{"in":"query","name":"direction","schema":{"description":"Direction to order organizations.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"Whether to match all search requirements or at least one (any).","enum":["any","all"],"type":"string"}},{"in":"query","name":"status","schema":{"description":"Whether the user is a member of the organization or has an inivitation pending.","enum":["member","invited"],"example":"member","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_collection_organization_response"}}},"description":"List Organizations response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"List Organizations response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Organizations","tags":["User's Organizations"],"x-api-token-group":["Memberships Write","Memberships Read"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/user/organizations/{organization_id}":{"delete":{"deprecated":true,"description":"Removes association to an organization.","operationId":"user'-s-organizations-leave-organization","parameters":[{"in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"}},"type":"object"}}},"description":"Leave Organization response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Leave Organization response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Leave Organization","tags":["User's Organizations"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"deprecated":true,"description":"Gets a specific organization the user is associated with.","operationId":"user'-s-organizations-organization-details","parameters":[{"in":"path","name":"organization_id","required":true,"schema":{"$ref":"#/components/schemas/iam_common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_organization_response"}}},"description":"Organization Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Organization Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Organization Details","tags":["User's Organizations"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/user/subscriptions":{"get":{"description":"Lists all of a user's subscriptions.","operationId":"user-subscription-get-user-subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_user_subscription_response_collection"}}},"description":"Get User Subscriptions response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_user_subscription_response_collection"},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"Get User Subscriptions response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get User Subscriptions","tags":["User Subscription"],"x-api-token-group":["Billing Write","Billing Read"],"x-cfPermissionsRequired":{"enum":["#billing:read"]}}},"/user/subscriptions/{identifier}":{"delete":{"description":"Deletes a user's subscription.","operationId":"user-subscription-delete-user-subscription","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"subscription_id":{"$ref":"#/components/schemas/bill-subs-api_schemas-identifier"}},"type":"object"}}},"description":"Delete User Subscription response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"subscription_id":{"$ref":"#/components/schemas/bill-subs-api_schemas-identifier"}},"type":"object"},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"Delete User Subscription response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete User Subscription","tags":["User Subscription"],"x-api-token-group":["Billing Write"],"x-cfPermissionsRequired":{"enum":["#billing:edit"]}},"put":{"description":"Updates a user's subscriptions.","operationId":"user-subscription-update-user-subscription","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_subscription-v2"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_user_subscription_response_single"}}},"description":"Update User Subscription response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_user_subscription_response_single"},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"Update User Subscription response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update User Subscription","tags":["User Subscription"],"x-api-token-group":["Billing Write"],"x-cfPermissionsRequired":{"enum":["#billing:read","#billing:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/tokens":{"get":{"description":"List all access tokens you created.","operationId":"user-api-tokens-list-tokens","parameters":[{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"direction","schema":{"description":"Direction to order results.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_collection_tokens_response"}}},"description":"List Tokens response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"List Tokens response failure"}},"security":[{"api_token":[]}],"summary":"List Tokens","tags":["User API Tokens"],"x-api-token-group":["API Tokens Write","API Tokens Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.list"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a new access token.","operationId":"user-api-tokens-create-token","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_create_payload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_token_create_response"}}},"description":"Create Token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Create Token response failure"}},"security":[{"api_token":[]}],"summary":"Create Token","tags":["User API Tokens"],"x-api-token-group":["API Tokens Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.create"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/tokens/permission_groups":{"get":{"description":"Find all available permission groups for API Tokens","operationId":"permission-groups-list-permission-groups","parameters":[{"description":"Filter by the name of the permission group.\nThe value must be URL-encoded.","in":"query","name":"name","schema":{"example":"Account%20Settings%20Write","type":"string"}},{"description":"Filter by the scope of the permission group.\nThe value must be URL-encoded.","in":"query","name":"scope","schema":{"example":"com.cloudflare.api.account.zone","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_permissions_group_response_collection"}}},"description":"List Token Permission Groups response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"List Token Permission Groups response failure"}},"security":[{"api_token":[]}],"summary":"List Token Permission Groups","tags":["User API Tokens"],"x-api-token-group":["API Tokens Write","API Tokens Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/tokens/verify":{"get":{"description":"Test whether a token works.","operationId":"user-api-tokens-verify-token","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_token_verify_response_single_segment"}}},"description":"Verify Token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Verify Token response failure"}},"security":[{"api_token":[]}],"summary":"Verify Token","tags":["User API Tokens"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/tokens/{token_id}":{"delete":{"description":"Destroy a token.","operationId":"user-api-tokens-delete-token","parameters":[{"in":"path","name":"token_id","required":true,"schema":{"$ref":"#/components/schemas/iam_token_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-single-id"}}},"description":"Delete Token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Delete Token response failure"}},"security":[{"api_token":[]}],"summary":"Delete Token","tags":["User API Tokens"],"x-api-token-group":["API Tokens Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.delete"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get information about a specific token.","operationId":"user-api-tokens-token-details","parameters":[{"in":"path","name":"token_id","required":true,"schema":{"$ref":"#/components/schemas/iam_token_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_token_response"}}},"description":"Token Details response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Token Details response failure"}},"security":[{"api_token":[]}],"summary":"Token Details","tags":["User API Tokens"],"x-api-token-group":["API Tokens Write","API Tokens Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Update an existing token.","operationId":"user-api-tokens-update-token","parameters":[{"in":"path","name":"token_id","required":true,"schema":{"$ref":"#/components/schemas/iam_token_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_token_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_single_token_response"}}},"description":"Update Token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Update Token response failure"}},"security":[{"api_token":[]}],"summary":"Update Token","tags":["User API Tokens"],"x-api-token-group":["API Tokens Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/tokens/{token_id}/value":{"put":{"description":"Roll the token secret.","operationId":"user-api-tokens-roll-token","parameters":[{"in":"path","name":"token_id","required":true,"schema":{"$ref":"#/components/schemas/iam_token_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_response_single_value"}}},"description":"Roll Token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/iam_api-response-common-failure"}}},"description":"Roll Token response failure"}},"security":[{"api_token":[]}],"summary":"Roll Token","tags":["User API Tokens"],"x-api-token-group":["API Tokens Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/users/tenants":{"get":{"description":"Retrieves list of tenants the authenticated user / method has access to.","operationId":"User_listUserTenants","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"type":"object"},"maxItems":0,"type":"array"},"messages":{"items":{"$ref":"#/components/schemas/organizations-api_V4Message"},"type":"array"},"result":{"items":{"$ref":"#/components/schemas/organizations-api_Organization"},"type":"array"},"success":{"enum":[true],"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"}}},"description":"The request has succeeded."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations-api_V4ErrorResponse"}}},"description":"An unexpected error response."}},"security":[{"api_email":[],"api_key":[]}],"summary":"List user tenants","tags":["User"]}},"/zones":{"get":{"description":"Lists, searches, sorts, and filters your zones. Listing zones across more than 500 accounts\nis currently not allowed.\n","operationId":"zones-get","parameters":[{"examples":{"Basic Query":{"summary":"Simple Query","value":"example.com"},"Contains Query":{"summary":"Contains Query","value":"contains:.org"},"Ends With Query":{"summary":"Ends With Query","value":"ends_with:arpa"},"Starts With Query":{"summary":"Starts With Query","value":"starts_with:dev"}},"in":"query","name":"name","schema":{"description":"A domain name. Optional filter operators can be provided to extend refine the search:\n  * `equal` (default)\n  * `not_equal`\n  * `starts_with`\n  * `ends_with`\n  * `contains`\n  * `starts_with_case_sensitive`\n  * `ends_with_case_sensitive`\n  * `contains_case_sensitive`\n","maxLength":253,"type":"string"}},{"in":"query","name":"status","schema":{"description":"Specify a zone status to filter by.","enum":["initializing","pending","active","moved"],"type":"string"}},{"in":"query","name":"account.id","schema":{"description":"Filter by an account ID.","type":"string"}},{"examples":{"Basic Query":{"summary":"Simple Query","value":"Dev Account"},"Contains Query":{"summary":"Contains Query","value":"contains:Test"}},"in":"query","name":"account.name","schema":{"description":"An account Name. Optional filter operators can be provided to extend refine the search:\n  * `equal` (default)\n  * `not_equal`\n  * `starts_with`\n  * `ends_with`\n  * `contains`\n  * `starts_with_case_sensitive`\n  * `ends_with_case_sensitive`\n  * `contains_case_sensitive`\n","maxLength":253,"type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of zones per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Field to order zones by.","enum":["name","status","account.id","account.name","plan.id"],"example":"status","type":"string"}},{"in":"query","name":"direction","schema":{"description":"Direction to order zones.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"Whether to match all search requirements or at least one (any).","enum":["any","all"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_api-response-common"},{"properties":{"result_info":{"$ref":"#/components/schemas/zones_result_info"}}},{"properties":{"result":{"items":{"$ref":"#/components/schemas/zones_zone"},"type":"array"}}}]}}},"description":"List Zones response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_api-response-common-failure"}}},"description":"List Zones response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Zones","tags":["Zone"]},"post":{"operationId":"zones-post","requestBody":{"content":{"application/json":{"schema":{"properties":{"account":{"properties":{"id":{"$ref":"#/components/schemas/zones_identifier"}},"type":"object"},"name":{"$ref":"#/components/schemas/zones_name"},"type":{"$ref":"#/components/schemas/zones_type"}},"required":["name","account"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/zones_zone"}},"type":"object"}]}}},"description":"Create Zone response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_api-response-common-failure"}}},"description":"Create Zone response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Zone","tags":["Zone"],"x-api-token-group":["Zone Zone Edit","Zone DNS Edit"]}},"/zones/{zone_identifier}/analytics/colos":{"get":{"deprecated":true,"description":"This view provides a breakdown of analytics data by datacenter. Note: This is available to Enterprise customers only.","operationId":"zone-analytics-(-deprecated)-get-analytics-by-co-locations","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/zone-analytics-api_identifier"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/zone-analytics-api_until"}},{"in":"query","name":"since","schema":{"anyOf":[{"type":"string"},{"type":"integer"}],"default":-10080,"description":"The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.\n\nRanges that the Cloudflare web application provides will provide the following period length for each point:\n- Last 60 minutes (from -59 to -1): 1 minute resolution\n- Last 7 hours (from -419 to -60): 15 minutes resolution\n- Last 15 hours (from -899 to -420): 30 minutes resolution\n- Last 72 hours (from -4320 to -900): 1 hour resolution\n- Older than 3 days (-525600 to -4320): 1 day resolution.","example":"2015-01-01T12:23:00Z"}},{"in":"query","name":"continuous","schema":{"default":true,"description":"When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data.\n\nThe API response _may not represent the requested time window_.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone-analytics-api_colo_response"}}},"description":"Get analytics by Co-locations response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone-analytics-api_colo_response"},{"$ref":"#/components/schemas/zone-analytics-api_api-response-common-failure"}]}}},"description":"Get analytics by Co-locations response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get analytics by Co-locations","tags":["Zone Analytics (Deprecated)"],"x-api-token-group":["Analytics Read"],"x-cfDeprecation":{"description":"Please use the new GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/. It provides equivalent data and more features, including the ability to select only the metrics you need. Migration guide: https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/.","display":true,"eol":"2021-03-01","id":"zone_analytics_deprecation"},"x-cfPermissionsRequired":{"enum":["#analytics:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/analytics/dashboard":{"get":{"deprecated":true,"description":"The dashboard view provides both totals and timeseries data for the given zone and time period across the entire Cloudflare network.","operationId":"zone-analytics-(-deprecated)-get-dashboard","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/zone-analytics-api_identifier"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/zone-analytics-api_until"}},{"in":"query","name":"since","schema":{"anyOf":[{"type":"string"},{"type":"integer"}],"default":-10080,"description":"The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.\n\nRanges that the Cloudflare web application provides will provide the following period length for each point:\n- Last 60 minutes (from -59 to -1): 1 minute resolution\n- Last 7 hours (from -419 to -60): 15 minutes resolution\n- Last 15 hours (from -899 to -420): 30 minutes resolution\n- Last 72 hours (from -4320 to -900): 1 hour resolution\n- Older than 3 days (-525600 to -4320): 1 day resolution.","example":"2015-01-01T12:23:00Z"}},{"in":"query","name":"continuous","schema":{"default":true,"description":"When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data.\n\nThe API response _may not represent the requested time window_.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone-analytics-api_dashboard_response"}}},"description":"Get dashboard response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone-analytics-api_dashboard_response"},{"$ref":"#/components/schemas/zone-analytics-api_api-response-common-failure"}]}}},"description":"Get dashboard response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get dashboard","tags":["Zone Analytics (Deprecated)"],"x-api-token-group":["Analytics Read"],"x-cfDeprecation":{"description":"Please use the new GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/. It provides equivalent data and more features, including the ability to select only the metrics you need. Migration guide: https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/.","display":true,"eol":"2021-03-01","id":"zone_analytics_deprecation"},"x-cfPermissionsRequired":{"enum":["#analytics:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/custom_pages":{"get":{"description":"Fetches all the custom pages at the zone level.","operationId":"custom-pages-for-a-zone-list-custom-pages","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-pages_custom_page_result_list"}}},"description":"List custom pages response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-pages_custom_page_result_list"},{"$ref":"#/components/schemas/custom-pages_api-response-common-failure"}]}}},"description":"List custom pages response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List custom pages","tags":["Custom pages for a zone"],"x-api-token-group":["Custom Pages Write","Custom Pages Read","Zone Settings Write","Zone Settings Read"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/custom_pages/{identifier}":{"get":{"description":"Fetches the details of a custom page.","operationId":"custom-pages-for-a-zone-get-a-custom-page","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_error_page_type"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-pages_custom_page"}}},"description":"Get a custom page response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-pages_custom_page_result"},{"$ref":"#/components/schemas/custom-pages_api-response-common-failure"}]}}},"description":"Get a custom page response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a custom page","tags":["Custom pages for a zone"],"x-api-token-group":["Custom Pages Write","Custom Pages Read","Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Updates the configuration of an existing custom page.","operationId":"custom-pages-for-a-zone-update-a-custom-page","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_error_page_type"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"state":{"$ref":"#/components/schemas/custom-pages_state"},"url":{"$ref":"#/components/schemas/custom-pages_url"}},"required":["url","state"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-pages_custom_page_result"}}},"description":"Update a custom page response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-pages_custom_page_result"},{"$ref":"#/components/schemas/custom-pages_api-response-common-failure"}]}}},"description":"Update a custom page response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update a custom page","tags":["Custom pages for a zone"],"x-api-token-group":["Custom Pages Write","Zone Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}":{"delete":{"description":"Deletes an existing zone.","operationId":"zones-0-delete","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_identifier"}}],"requestBody":{"content":{"application/json":{}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_api-response-single-id"}}},"description":"Delete Zone response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_api-response-common-failure"}}},"description":"Delete Zone response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Zone","tags":["Zone"],"x-api-token-group":["Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"zones-0-get","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/zones_zone"}},"type":"object"}]}}},"description":"Zone Details response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_api-response-common-failure"}}},"description":"Zone Details response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Zone Details","tags":["Zone"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","Zero Trust: PII Read","Zaraz Edit","Zaraz Read","Zaraz Admin","Access: Apps and Policies Revoke","Access: Apps and Policies Write","Access: Apps and Policies Read","Access: Apps and Policies Revoke","Access: Mutual TLS Certificates Write","Access: Organizations, Identity Providers, and Groups Write","Zone Settings Write","Zone Settings Read","Zone Read","DNS Read","Workers Scripts Write","Workers Scripts Read","Zone Write","Workers Routes Write","Workers Routes Read","Stream Write","Stream Read","SSL and Certificates Write","SSL and Certificates Read","Logs Write","Logs Read","Cache Purge","Page Rules Write","Page Rules Read","Load Balancers Write","Load Balancers Read","Firewall Services Write","Firewall Services Read","DNS Write","Apps Write","Analytics Read","Access: Apps and Policies Write","Access: Apps and Policies Read"],"x-cfPermissionsRequired":{"enum":["#zone:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Edits a zone. Only one zone property can be changed at a time.","operationId":"zones-0-patch","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{"paused":true},"properties":{"paused":{"$ref":"#/components/schemas/zones_paused"},"plan":{"description":"(Deprecated) Please use the `/zones/{zone_id}/subscription` API\nto update a zone's plan. Changing this value will create/cancel\nassociated subscriptions. To view available plans for this zone,\nsee Zone Plans.\n","properties":{"id":{"$ref":"#/components/schemas/zones_identifier"}},"type":"object"},"type":{"description":"A full zone implies that DNS is hosted with Cloudflare. A partial\nzone is typically a partner-hosted zone or a CNAME setup. This\nparameter is only available to Enterprise customers or if it has\nbeen explicitly enabled on a zone.\n","enum":["full","partial","secondary","internal"],"example":"full","type":"string"},"vanity_name_servers":{"$ref":"#/components/schemas/zones_vanity_name_servers"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/zones_zone"}},"type":"object"}]}}},"description":"Edit Zone response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_api-response-common-failure"}}},"description":"Edit Zone response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Edit Zone","tags":["Zone"],"x-api-token-group":["Zone Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/access/apps":{"get":{"description":"List all Access Applications in a zone.","operationId":"zone-level-access-applications-list-access-applications","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_apps_components-schemas-response_collection-2"}}},"description":"List Access Applications response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List Access Applications response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Access Applications","tags":["Zone-Level Access applications"],"x-api-token-group":["Access: Apps and Policies Revoke","Access: Apps and Policies Write","Access: Apps and Policies Read","Access: Apps and Policies Revoke","Access: Apps and Policies Write","Access: Apps and Policies Read"]},"post":{"description":"Adds a new application to Access.","operationId":"zone-level-access-applications-add-a-bookmark-application","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_apps"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/access_apps_components-schemas-single_response-2"},{"properties":{"result":{"$ref":"#/components/schemas/access_apps"}}}]}}},"description":"Add an Access application response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Add an Access application response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Add an Access application","tags":["Zone-Level Access applications"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Write"]}},"/zones/{zone_id}/access/apps/ca":{"get":{"description":"Lists short-lived certificate CAs and their public keys.","operationId":"zone-level-access-short-lived-certificate-c-as-list-short-lived-certificate-c-as","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_ca_components-schemas-response_collection-2"}}},"description":"List short-lived certificate CAs response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List short-lived certificate CAs response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List short-lived certificate CAs","tags":["Zone-Level Access short-lived certificate CAs"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read","Access: Apps and Policies Write","Access: Apps and Policies Read"]}},"/zones/{zone_id}/access/apps/{app_id}":{"delete":{"description":"Deletes an application from Access.","operationId":"zone-level-access-applications-delete-an-access-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_id_response"}}},"description":"Delete an Access application response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete an Access application response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete an Access application","tags":["Zone-Level Access applications"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Write"]},"get":{"description":"Fetches information about an Access application.","operationId":"zone-level-access-applications-get-an-access-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_apps_components-schemas-single_response-2"}}},"description":"Get an Access application response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get an Access application response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get an Access application","tags":["Zone-Level Access applications"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read","Access: Apps and Policies Write","Access: Apps and Policies Read"]},"put":{"description":"Updates an Access application.","operationId":"zone-level-access-applications-update-a-bookmark-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_apps"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/access_apps_components-schemas-single_response-2"},{"properties":{"result":{"$ref":"#/components/schemas/access_apps"}}}]}}},"description":"Update an Access application response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update an Access application response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update an Access application","tags":["Zone-Level Access applications"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Write"]}},"/zones/{zone_id}/access/apps/{app_id}/ca":{"delete":{"description":"Deletes a short-lived certificate CA.","operationId":"zone-level-access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_ca_components-schemas-id_response"}}},"description":"Delete a short-lived certificate CA response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete a short-lived certificate CA response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a short-lived certificate CA","tags":["Zone-Level Access short-lived certificate CAs"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Write"]},"get":{"description":"Fetches a short-lived certificate CA and its public key.","operationId":"zone-level-access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_ca_components-schemas-single_response-2"}}},"description":"Get a short-lived certificate CA response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get a short-lived certificate CA response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a short-lived certificate CA","tags":["Zone-Level Access short-lived certificate CAs"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read","Access: Apps and Policies Write","Access: Apps and Policies Read"]},"post":{"description":"Generates a new short-lived certificate CA and public key.","operationId":"zone-level-access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_ca_components-schemas-single_response-2"}}},"description":"Create a short-lived certificate CA response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create a short-lived certificate CA response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a short-lived certificate CA","tags":["Zone-Level Access short-lived certificate CAs"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Write"]}},"/zones/{zone_id}/access/apps/{app_id}/policies":{"get":{"description":"Lists Access policies configured for an application.","operationId":"zone-level-access-policies-list-access-policies","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_policies_components-schemas-response_collection"}}},"description":"List Access policies response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List Access policies response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Access policies","tags":["Zone-Level Access policies"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read","Access: Apps and Policies Write","Access: Apps and Policies Read"]},"post":{"description":"Create a new Access policy for an application.","operationId":"zone-level-access-policies-create-an-access-policy","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"approval_groups":{"$ref":"#/components/schemas/access_schemas-approval_groups"},"approval_required":{"$ref":"#/components/schemas/access_schemas-approval_required"},"decision":{"$ref":"#/components/schemas/access_schemas-decision"},"exclude":{"$ref":"#/components/schemas/access_components-schemas-exclude"},"include":{"$ref":"#/components/schemas/access_include"},"isolation_required":{"$ref":"#/components/schemas/access_schemas-isolation_required"},"name":{"$ref":"#/components/schemas/access_policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/access_schemas-precedence"},"purpose_justification_prompt":{"$ref":"#/components/schemas/access_purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/access_schemas-purpose_justification_required"},"require":{"$ref":"#/components/schemas/access_components-schemas-require"}},"required":["name","decision","include"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_policies_components-schemas-single_response"}}},"description":"Create an Access policy response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create an Access policy response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create an Access policy","tags":["Zone-Level Access policies"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Write"]}},"/zones/{zone_id}/access/apps/{app_id}/policies/{policy_id}":{"delete":{"description":"Delete an Access policy.","operationId":"zone-level-access-policies-delete-an-access-policy","parameters":[{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_id_response"}}},"description":"Delete an Access policy response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete an Access policy response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete an Access policy","tags":["Zone-Level Access policies"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Write"]},"get":{"description":"Fetches a single Access policy.","operationId":"zone-level-access-policies-get-an-access-policy","parameters":[{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_policies_components-schemas-single_response"}}},"description":"Get an Access policy response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get an Access policy response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get an Access policy","tags":["Zone-Level Access policies"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read","Access: Apps and Policies Write","Access: Apps and Policies Read"]},"put":{"description":"Update a configured Access policy.","operationId":"zone-level-access-policies-update-an-access-policy","parameters":[{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"approval_groups":{"$ref":"#/components/schemas/access_schemas-approval_groups"},"approval_required":{"$ref":"#/components/schemas/access_schemas-approval_required"},"decision":{"$ref":"#/components/schemas/access_schemas-decision"},"exclude":{"$ref":"#/components/schemas/access_components-schemas-exclude"},"include":{"$ref":"#/components/schemas/access_include"},"isolation_required":{"$ref":"#/components/schemas/access_schemas-isolation_required"},"name":{"$ref":"#/components/schemas/access_policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/access_schemas-precedence"},"purpose_justification_prompt":{"$ref":"#/components/schemas/access_purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/access_schemas-purpose_justification_required"},"require":{"$ref":"#/components/schemas/access_components-schemas-require"}},"required":["name","decision","include"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_policies_components-schemas-single_response"}}},"description":"Update an Access policy response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update an Access policy response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update an Access policy","tags":["Zone-Level Access policies"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Write"]}},"/zones/{zone_id}/access/apps/{app_id}/revoke_tokens":{"post":{"description":"Revokes all tokens issued for an application.","operationId":"zone-level-access-applications-revoke-service-tokens","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-empty_response"}}},"description":"Revoke application tokens response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Revoke application tokens response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Revoke application tokens","tags":["Zone-Level Access applications"],"x-api-token-group":["Access: Apps and Policies Revoke","Access: Apps and Policies Write","Access: Apps and Policies Revoke","Access: Apps and Policies Write"]}},"/zones/{zone_id}/access/apps/{app_id}/settings":{"patch":{"description":"Updates application settings.","operationId":"zone-level-access-applications-patch-update-access-application-settings","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app_settings_request"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/access_single_response_update"}]}}},"description":"Update application settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update application settings response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update application settings","tags":["Zone-Level Access applications"]},"put":{"description":"Updates application settings.","operationId":"zone-level-access-applications-put-update-access-application-settings","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_app_settings_request"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/access_single_response_update"}]}}},"description":"Update application settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update application settings response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update application settings","tags":["Zone-Level Access applications"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Write"]}},"/zones/{zone_id}/access/apps/{app_id}/user_policy_checks":{"get":{"description":"Tests if a specific user has permission to access an application.","operationId":"zone-level-access-applications-test-access-policies","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/access_app_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-policy_check_response"}}},"description":"Test Access policies response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Test Access policies response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Test Access policies","tags":["Zone-Level Access applications"],"x-api-token-group":["Access: Apps and Policies Write","Access: Apps and Policies Read","Access: Apps and Policies Write","Access: Apps and Policies Read"]}},"/zones/{zone_id}/access/certificates":{"get":{"description":"Lists all mTLS certificates.","operationId":"zone-level-access-mtls-authentication-list-mtls-certificates","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_certificates_components-schemas-response_collection-2"}}},"description":"List mTLS certificates response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List mTLS certificates response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List mTLS certificates","tags":["Zone-Level Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write","Access: Mutual TLS Certificates Read"]},"post":{"description":"Adds a new mTLS root certificate to Access.","operationId":"zone-level-access-mtls-authentication-add-an-mtls-certificate","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"associated_hostnames":{"$ref":"#/components/schemas/access_schemas-associated_hostnames"},"certificate":{"description":"The certificate content.","example":"-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----","type":"string"},"name":{"$ref":"#/components/schemas/access_certificates_components-schemas-name-2"}},"required":["name","certificate"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_certificates_components-schemas-single_response-2"}}},"description":"Add an mTLS certificate response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Add an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Add an mTLS certificate","tags":["Zone-Level Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write"]}},"/zones/{zone_id}/access/certificates/settings":{"get":{"description":"List all mTLS hostname settings for this zone.","operationId":"zone-level-access-mtls-authentication-list-mtls-certificates-hostname-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-response_collection_hostnames"}}},"description":"List mTLS hostname settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List mTLS hostname settings response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List all mTLS hostname settings","tags":["Zone-Level Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write","Access: Mutual TLS Certificates Read"]},"put":{"description":"Updates an mTLS certificate's hostname settings.","operationId":"zone-level-access-mtls-authentication-update-an-mtls-certificate-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"settings":{"items":{"$ref":"#/components/schemas/access_schemas-settings"},"type":"array"}},"required":["settings"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-response_collection_hostnames"}}},"description":"Update an mTLS certificates hostname settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update an mTLS certificates hostname settings failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update an mTLS certificate's hostname settings","tags":["Zone-Level Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write"]}},"/zones/{zone_id}/access/certificates/{certificate_id}":{"delete":{"description":"Deletes an mTLS certificate.","operationId":"zone-level-access-mtls-authentication-delete-an-mtls-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_components-schemas-id_response"}}},"description":"Delete an mTLS certificate response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete an mTLS certificate","tags":["Zone-Level Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write"]},"get":{"description":"Fetches a single mTLS certificate.","operationId":"zone-level-access-mtls-authentication-get-an-mtls-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_certificates_components-schemas-single_response-2"}}},"description":"Get an mTLS certificate response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get an mTLS certificate","tags":["Zone-Level Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write","Access: Mutual TLS Certificates Read"]},"put":{"description":"Updates a configured mTLS certificate.","operationId":"zone-level-access-mtls-authentication-update-an-mtls-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"associated_hostnames":{"$ref":"#/components/schemas/access_schemas-associated_hostnames"},"name":{"$ref":"#/components/schemas/access_certificates_components-schemas-name-2"}},"required":["associated_hostnames"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_certificates_components-schemas-single_response-2"}}},"description":"Update an mTLS certificate response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update an mTLS certificate","tags":["Zone-Level Access mTLS authentication"],"x-api-token-group":["Access: Mutual TLS Certificates Write"]}},"/zones/{zone_id}/access/groups":{"get":{"description":"Lists all Access groups.","operationId":"zone-level-access-groups-list-access-groups","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_groups_components-schemas-response_collection"}}},"description":"List Access groups response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List Access groups response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Access groups","tags":["Zone-Level Access groups"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]},"post":{"description":"Creates a new Access group.","operationId":"zone-level-access-groups-create-an-access-group","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"exclude":{"$ref":"#/components/schemas/access_exclude"},"include":{"$ref":"#/components/schemas/access_include"},"name":{"$ref":"#/components/schemas/access_groups_components-schemas-name-2"},"require":{"$ref":"#/components/schemas/access_require"}},"required":["name","include"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_groups_components-schemas-single_response-2"}}},"description":"Create an Access group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create an Access group response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create an Access group","tags":["Zone-Level Access groups"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/zones/{zone_id}/access/groups/{group_id}":{"delete":{"description":"Deletes an Access group.","operationId":"zone-level-access-groups-delete-an-access-group","parameters":[{"in":"path","name":"group_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_id_response"}}},"description":"Delete an Access group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete an Access group response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete an Access group","tags":["Zone-Level Access groups"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]},"get":{"description":"Fetches a single Access group.","operationId":"zone-level-access-groups-get-an-access-group","parameters":[{"in":"path","name":"group_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_groups_components-schemas-single_response-2"}}},"description":"Get an Access group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get an Access group response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get an Access group","tags":["Zone-Level Access groups"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]},"put":{"description":"Updates a configured Access group.","operationId":"zone-level-access-groups-update-an-access-group","parameters":[{"in":"path","name":"group_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"exclude":{"$ref":"#/components/schemas/access_exclude"},"include":{"$ref":"#/components/schemas/access_include"},"name":{"$ref":"#/components/schemas/access_groups_components-schemas-name-2"},"require":{"$ref":"#/components/schemas/access_require"}},"required":["name","include"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_groups_components-schemas-single_response-2"}}},"description":"Update an Access group response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update an Access group response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update an Access group","tags":["Zone-Level Access groups"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/zones/{zone_id}/access/identity_providers":{"get":{"description":"Lists all configured identity providers.","operationId":"zone-level-access-identity-providers-list-access-identity-providers","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_identity-providers_components-schemas-response_collection"}}},"description":"List Access identity providers response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List Access identity providers response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Access identity providers","tags":["Zone-Level Access identity providers"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]},"post":{"description":"Adds a new identity provider to Access.","operationId":"zone-level-access-identity-providers-add-an-access-identity-provider","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-identity-providers"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_identity-providers_components-schemas-single_response"}}},"description":"Add an Access identity provider response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Add an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Add an Access identity provider","tags":["Zone-Level Access identity providers"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/zones/{zone_id}/access/identity_providers/{identity_provider_id}":{"delete":{"description":"Deletes an identity provider from Access.","operationId":"zone-level-access-identity-providers-delete-an-access-identity-provider","parameters":[{"in":"path","name":"identity_provider_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_id_response"}}},"description":"Delete an Access identity provider response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete an Access identity provider","tags":["Zone-Level Access identity providers"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]},"get":{"description":"Fetches a configured identity provider.","operationId":"zone-level-access-identity-providers-get-an-access-identity-provider","parameters":[{"in":"path","name":"identity_provider_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_identity-providers_components-schemas-single_response"}}},"description":"Get an Access identity provider response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get an Access identity provider","tags":["Zone-Level Access identity providers"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]},"put":{"description":"Updates a configured identity provider.","operationId":"zone-level-access-identity-providers-update-an-access-identity-provider","parameters":[{"in":"path","name":"identity_provider_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-identity-providers"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_identity-providers_components-schemas-single_response"}}},"description":"Update an Access identity provider response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update an Access identity provider","tags":["Zone-Level Access identity providers"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/zones/{zone_id}/access/organizations":{"get":{"description":"Returns the configuration for your Zero Trust organization.","operationId":"zone-level-zero-trust-organization-get-your-zero-trust-organization","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_organizations_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_organizations_components-schemas-single_response"}}},"description":"Get your Zero Trust organization response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get your Zero Trust organization response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get your Zero Trust organization","tags":["Zone-Level Zero Trust organization"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Revoke","Access: Organizations, Identity Providers, and Groups Write","Access: Organizations, Identity Providers, and Groups Read"]},"post":{"description":"Sets up a Zero Trust organization for your account.","operationId":"zone-level-zero-trust-organization-create-your-zero-trust-organization","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_organizations_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"auth_domain":{"$ref":"#/components/schemas/access_schemas-auth_domain"},"is_ui_read_only":{"$ref":"#/components/schemas/access_schemas-is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/access_schemas-login_design"},"name":{"$ref":"#/components/schemas/access_organizations_components-schemas-name"},"ui_read_only_toggle_reason":{"$ref":"#/components/schemas/access_ui_read_only_toggle_reason"},"user_seat_expiration_inactive_time":{"$ref":"#/components/schemas/access_schemas-user_seat_expiration_inactive_time"}},"required":["name","auth_domain"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_organizations_components-schemas-single_response"}}},"description":"Create your Zero Trust organization response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create your Zero Trust organization response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create your Zero Trust organization","tags":["Zone-Level Zero Trust organization"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]},"put":{"description":"Updates the configuration for your Zero Trust organization.","operationId":"zone-level-zero-trust-organization-update-your-zero-trust-organization","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_organizations_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"auth_domain":{"$ref":"#/components/schemas/access_schemas-auth_domain"},"is_ui_read_only":{"$ref":"#/components/schemas/access_schemas-is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/access_schemas-login_design"},"name":{"$ref":"#/components/schemas/access_organizations_components-schemas-name"},"ui_read_only_toggle_reason":{"$ref":"#/components/schemas/access_ui_read_only_toggle_reason"},"user_seat_expiration_inactive_time":{"$ref":"#/components/schemas/access_schemas-user_seat_expiration_inactive_time"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_organizations_components-schemas-single_response"}}},"description":"Update your Zero Trust organization response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update your Zero Trust organization response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update your Zero Trust organization","tags":["Zone-Level Zero Trust organization"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/zones/{zone_id}/access/organizations/revoke_user":{"post":{"description":"Revokes a user's access across all applications.","operationId":"zone-level-zero-trust-organization-revoke-all-access-tokens-for-a-user","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_organizations_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"email":{"description":"The email of the user to revoke.","example":"test@example.com","type":"string"}},"required":["email"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_empty_response"}}},"description":"Revoke all Access tokens for a user response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Revoke all Access tokens for a user response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Revoke all Access tokens for a user","tags":["Zone-Level Zero Trust organization"],"x-api-token-group":["Access: Organizations, Identity Providers, and Groups Write"]}},"/zones/{zone_id}/access/service_tokens":{"get":{"description":"Lists all service tokens.","operationId":"zone-level-access-service-tokens-list-service-tokens","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_service-tokens_components-schemas-response_collection"}}},"description":"List service tokens response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"List service tokens response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List service tokens","tags":["Zone-Level Access service tokens"],"x-api-token-group":["Access: Service Tokens Write","Access: Service Tokens Read"]},"post":{"description":"Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to create a new service token.","operationId":"zone-level-access-service-tokens-create-a-service-token","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"client_secret_version":{"$ref":"#/components/schemas/access_client_secret_version"},"duration":{"$ref":"#/components/schemas/access_schemas-duration"},"name":{"$ref":"#/components/schemas/access_service-tokens_components-schemas-name"},"previous_client_secret_expires_at":{"$ref":"#/components/schemas/access_previous_client_secret_expires_at"}},"required":["name"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_schemas-create_response"}}},"description":"Create a service token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Create a service token response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a service token","tags":["Zone-Level Access service tokens"],"x-api-token-group":["Access: Service Tokens Write"]}},"/zones/{zone_id}/access/service_tokens/{service_token_id}":{"delete":{"description":"Deletes a service token.","operationId":"zone-level-access-service-tokens-delete-a-service-token","parameters":[{"in":"path","name":"service_token_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_service-tokens_components-schemas-single_response"}}},"description":"Delete a service token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Delete a service token response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a service token","tags":["Zone-Level Access service tokens"],"x-api-token-group":["Access: Service Tokens Write"]},"get":{"description":"Fetches a single service token.","operationId":"zone-level-access-service-tokens-get-a-service-token","parameters":[{"in":"path","name":"service_token_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_service-tokens_components-schemas-single_response"}}},"description":"Get a service token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Get a service token response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a service token","tags":["Zone-Level Access service tokens"],"x-api-token-group":["Access: Service Tokens Write","Access: Service Tokens Read"]},"put":{"description":"Updates a configured service token.","operationId":"zone-level-access-service-tokens-update-a-service-token","parameters":[{"in":"path","name":"service_token_id","required":true,"schema":{"$ref":"#/components/schemas/access_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/access_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"client_secret_version":{"$ref":"#/components/schemas/access_client_secret_version"},"duration":{"$ref":"#/components/schemas/access_schemas-duration"},"name":{"$ref":"#/components/schemas/access_service-tokens_components-schemas-name"},"previous_client_secret_expires_at":{"$ref":"#/components/schemas/access_previous_client_secret_expires_at"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_service-tokens_components-schemas-single_response"}}},"description":"Update a service token response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access_api-response-common-failure"}}},"description":"Update a service token response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update a service token","tags":["Zone-Level Access service tokens"],"x-api-token-group":["Access: Service Tokens Write"]}},"/zones/{zone_id}/acm/custom_trust_store":{"get":{"description":"Get Custom Origin Trust Store for a Zone.","operationId":"custom-origin-trust-store-list-details","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of records per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"limit","schema":{"description":"Limit to the number of records returned.","example":10,"type":"integer"}},{"in":"query","name":"offset","schema":{"description":"Offset the results","example":10,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_trust_store_response_collection"}}},"description":"Custom Origin Trust Store Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_trust_store_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Custom Origin Trust Store response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Custom Origin Trust Store Details","tags":["Custom Origin Trust Store"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Add Custom Origin Trust Store for a Zone.","operationId":"custom-origin-trust-store-create","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate"}},"required":["certificate"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_trust_store_response_single"}}},"description":"Upload Custom Origin Trust Store response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_trust_store_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Upload Custom Origin Trust Store response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Upload Custom Origin Trust Store","tags":["Custom Origin Trust Store"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/acm/custom_trust_store/{custom_origin_trust_store_id}":{"delete":{"operationId":"custom-origin-trust-store-delete","parameters":[{"in":"path","name":"custom_origin_trust_store_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_trust_store_response_id_only"}}},"description":"Delete Custom Origin Trust Store response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Delete Custom Origin Trust Store response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Custom Origin Trust Store","tags":["Custom Origin Trust Store"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"custom-origin-trust-store-details","parameters":[{"in":"path","name":"custom_origin_trust_store_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_trust_store_response_single"}}},"description":"Custom Origin Trust Store Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_trust_store_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Custom Origin Trust Store Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Custom Origin Trust Store Details","tags":["Custom Origin Trust Store"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/acm/total_tls":{"get":{"description":"Get Total TLS Settings for a Zone.","operationId":"total-tls-total-tls-settings-details","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_total_tls_settings_response"}}},"description":"Total TLS Settings Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_total_tls_settings_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Total TLS Settings Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Total TLS Settings Details","tags":["Total TLS"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Set Total TLS Settings or disable the feature for a Zone.","operationId":"total-tls-enable-or-disable-total-tls","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"certificate_authority":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_authority"},"enabled":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-enabled"}},"required":["enabled"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_total_tls_settings_response"}}},"description":"Enable or Disable Total TLS response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_total_tls_settings_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Enable or Disable Total TLS response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Enable or Disable Total TLS","tags":["Total TLS"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/activation_check":{"put":{"description":"Triggeres a new activation check for a PENDING Zone. This can be\ntriggered every 5 min for paygo/ent customers, every hour for FREE\nZones.","operationId":"put-zones-zone_id-activation_check","parameters":[{"description":"Zone ID","in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zone-activation_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone-activation_api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/zone-activation_identifier"}},"type":"object"}},"type":"object"}]}}},"description":"Successful Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone-activation_api-response-common-failure"}]}}},"description":"Client Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Rerun the Activation Check","tags":["Zone"],"x-api-token-group":["Zone Write"]}},"/zones/{zone_id}/addressing/regional_hostnames":{"get":{"description":"List all Regional Hostnames within a zone.","operationId":"dls-account-regional-hostnames-account-list-hostnames","parameters":[{"$ref":"#/components/parameters/dls_zone_id"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dls_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dls_regional_hostname_response"},"type":"array"}}}]}}},"description":"List hostnames response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dls_api-response-common-failure"}]}}},"description":"Failure to list hostnames"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Regional Hostnames","tags":["DLS Regional Services"],"x-api-token-group":["DNS Read","DNS Write"]},"post":{"description":"Create a new Regional Hostname entry. Cloudflare will only use data centers that are physically located within the chosen region to decrypt and service HTTPS traffic. Learn more about [Regional Services](https://developers.cloudflare.com/data-localization/regional-services/get-started/).","operationId":"dls-account-regional-hostnames-account-create-hostname","parameters":[{"$ref":"#/components/parameters/dls_zone_id"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"hostname":{"$ref":"#/components/schemas/dls_hostname"},"region_key":{"$ref":"#/components/schemas/dls_region_key"},"routing":{"$ref":"#/components/schemas/dls_routing"}},"required":["hostname","region_key"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dls_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/dls_regional_hostname_response"}},"type":"object"}]}}},"description":"Create hostname response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dls_api-response-common-failure"}]}}},"description":"Failure to create hostname"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Regional Hostname","tags":["DLS Regional Services"],"x-api-token-group":["DNS Write"]}},"/zones/{zone_id}/addressing/regional_hostnames/{hostname}":{"delete":{"description":"Delete the region configuration for a specific Regional Hostname.","operationId":"dls-account-regional-hostnames-account-delete-hostname","parameters":[{"$ref":"#/components/parameters/dls_zone_id"},{"$ref":"#/components/parameters/dls_hostname"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dls_api-response-common"}]}}},"description":"Delete hostname response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dls_api-response-common-failure"}]}}},"description":"Failure to delete hostname"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Regional Hostname","tags":["DLS Regional Services"],"x-api-token-group":["DNS Write"]},"get":{"description":"Fetch the configuration for a specific Regional Hostname, within a zone.","operationId":"dls-account-regional-hostnames-account-fetch-hostname","parameters":[{"$ref":"#/components/parameters/dls_zone_id"},{"$ref":"#/components/parameters/dls_hostname"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/dls_api-response-common"}],"type":"object"},{"properties":{"result":{"$ref":"#/components/schemas/dls_regional_hostname_response"}},"type":"object"}]}}},"description":"Fetch hostname response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dls_api-response-common-failure"}]}}},"description":"Failure to fetch hostname"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Fetch Regional Hostname","tags":["DLS Regional Services"],"x-api-token-group":["DNS Read","DNS Write"]},"patch":{"description":"Update the configuration for a specific Regional Hostname. Only the region_key of a hostname is mutable.","operationId":"dls-account-regional-hostnames-account-patch-hostname","parameters":[{"$ref":"#/components/parameters/dls_zone_id"},{"$ref":"#/components/parameters/dls_hostname"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"region_key":{"$ref":"#/components/schemas/dls_region_key"}},"required":["region_key"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dls_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/dls_regional_hostname_response"}},"type":"object"}]}}},"description":"Update hostname response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dls_api-response-common-failure"}]}}},"description":"Failure to update hostname"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Regional Hostname","tags":["DLS Regional Services"],"x-api-token-group":["DNS Write"]}},"/zones/{zone_id}/analytics/latency":{"get":{"operationId":"argo-analytics-for-zone-argo-analytics-for-a-zone","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/argo-analytics_identifier"}},{"in":"query","name":"bins","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/argo-analytics_response_single"}}},"description":"Argo Analytics for a zone response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/argo-analytics_response_single"},{"$ref":"#/components/schemas/argo-analytics_api-response-common-failure"}]}}},"description":"Argo Analytics for a zone response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Argo Analytics for a zone","tags":["Argo Analytics for Zone"],"x-api-token-group":["Analytics Read"],"x-cfPermissionsRequired":{"enum":["#analytics:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/analytics/latency/colos":{"get":{"operationId":"argo-analytics-for-geolocation-argo-analytics-for-a-zone-at-different-po-ps","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/argo-analytics_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/argo-analytics_response_single"}}},"description":"Argo Analytics for a zone at different PoPs response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/argo-analytics_response_single"},{"$ref":"#/components/schemas/argo-analytics_api-response-common-failure"}]}}},"description":"Argo Analytics for a zone at different PoPs response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Argo Analytics for a zone at different PoPs","tags":["Argo Analytics for Geolocation"],"x-api-token-group":["Analytics Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/api_gateway/configuration":{"get":{"operationId":"api-shield-settings-retrieve-information-about-specific-configuration-properties","responses":{"200":{"$ref":"#/components/responses/api-shield_config-get-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic-failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Retrieve information about specific configuration properties","tags":["API Shield Settings"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"},{"description":"Ensures that the configuration is written or retrieved in normalized fashion","in":"query","name":"normalize","schema":{"type":"boolean"}}],"put":{"operationId":"api-shield-settings-set-configuration-properties","requestBody":{"$ref":"#/components/requestBodies/api-shield_config-update"},"responses":{"200":{"$ref":"#/components/responses/api-shield_config-update-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic-failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update configuration properties","tags":["API Shield Settings"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/api_gateway/discovery":{"get":{"description":"Retrieve the most up to date view of discovered operations, rendered as OpenAPI schemas","operationId":"api-shield-api-discovery-retrieve-discovered-operations-on-a-zone-as-openapi","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_schema_response_discovery"}}},"description":"Retrieve discovered operations on a zone, rendered as OpenAPI schemas response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_schema_response_discovery"},{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}]}}},"description":"Retrieve discovered operations on a zone, rendered as OpenAPI schemas response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve discovered operations on a zone rendered as OpenAPI schemas","tags":["API Shield API Discovery"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}]},"/zones/{zone_id}/api_gateway/discovery/operations":{"get":{"description":"Retrieve the most up to date view of discovered operations","operationId":"api-shield-api-discovery-retrieve-discovered-operations-on-a-zone","parameters":[{"$ref":"#/components/parameters/api-shield_page"},{"$ref":"#/components/parameters/api-shield_per_page"},{"$ref":"#/components/parameters/api-shield_host_parameter"},{"$ref":"#/components/parameters/api-shield_method_parameter"},{"$ref":"#/components/parameters/api-shield_endpoint_parameter"},{"$ref":"#/components/parameters/api-shield_direction_parameter"},{"$ref":"#/components/parameters/api-shield_order_parameter"},{"$ref":"#/components/parameters/api-shield_diff_parameter"},{"$ref":"#/components/parameters/api-shield_api_discovery_origin_parameter"},{"$ref":"#/components/parameters/api-shield_api_discovery_state_parameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/api-shield_discovery_operation"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"Retrieve discovered operations on a zone response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}]}}},"description":"Retrieve discovered operations on a zone response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve discovered operations on a zone","tags":["API Shield API Discovery"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"patch":{"description":"Update the `state` on one or more discovered operations","operationId":"api-shield-api-patch-discovered-operations","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api_discovery_patch_multiple_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_patch_discoveries_response"}}},"description":"Patch discovered operations response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Patch discovered operations response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch discovered operations","tags":["API Shield API Discovery"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/api_gateway/discovery/operations/{operation_id}":{"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"},{"$ref":"#/components/parameters/api-shield_parameters-operation_id"}],"patch":{"description":"Update the `state` on a discovered operation","operationId":"api-shield-api-patch-discovered-operation","requestBody":{"content":{"application/json":{"schema":{"properties":{"state":{"allOf":[{"$ref":"#/components/schemas/api-shield_api_discovery_state_patch"}]}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_patch_discovery_response"}}},"description":"Patch discovered operation response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Patch discovered operation response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch discovered operation","tags":["API Shield API Discovery"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/api_gateway/expression-template/fallthrough":{"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"post":{"operationId":"api-shield-expression-templates-fallthrough","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_request_expression_templates_fallthrough"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_response_expression_templates_fallthrough"}},"required":["result"],"type":"object"}]}}},"description":"Generate fallthrough WAF expression template response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Generate fallthrough WAF expression template failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Generate fallthrough WAF expression template from a set of API hosts","tags":["API Shield WAF Expression Templates"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/api_gateway/operations":{"delete":{"operationId":"api-shield-endpoint-management-delete-multiple-operations","requestBody":{"content":{"application/json":{"schema":{"example":[{"operation_id":"b17c8043-99a0-4202-b7d9-8f7cdbee02cd"},{"operation_id":"3818d821-5901-4147-a474-f5f5aec1d54e"}],"items":{"$ref":"#/components/schemas/api-shield_object-with-operation-id"},"type":"array","uniqueItems":true}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common"}}},"description":"Delete multiple operations response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Delete multiple operations response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete multiple operations","tags":["API Shield Endpoint Management"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]},"get":{"operationId":"api-shield-endpoint-management-retrieve-information-about-all-operations-on-a-zone","parameters":[{"$ref":"#/components/parameters/api-shield_page"},{"$ref":"#/components/parameters/api-shield_per_page"},{"in":"query","name":"order","schema":{"description":"Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., `thresholds.suggested_threshold`.","enum":["method","host","endpoint","thresholds.$key"],"example":"method","type":"string"}},{"$ref":"#/components/parameters/api-shield_direction_parameter"},{"$ref":"#/components/parameters/api-shield_host_parameter"},{"$ref":"#/components/parameters/api-shield_method_parameter"},{"$ref":"#/components/parameters/api-shield_endpoint_parameter"},{"$ref":"#/components/parameters/api-shield_operation_feature_parameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_multiple-operation-response-paginated"}}},"description":"Retrieve information about all operations on a zone response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Retrieve information about all operations on a zone response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve information about all operations on a zone","tags":["API Shield Endpoint Management"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"post":{"description":"Add one or more operations to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date.","operationId":"api-shield-endpoint-management-add-operations-to-a-zone","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/api-shield_basic_operation"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_multiple-operation-response"}}},"description":"Add operations to a zone response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Add operations to a zone response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Add operations to a zone","tags":["API Shield Endpoint Management"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/api_gateway/operations/item":{"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"post":{"description":"Add one operation to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date.","operationId":"api-shield-endpoint-management-add-operation-to-a-zone","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_basic_operation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_single-operation-response"}}},"description":"Add one operation to a zone response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Add one operation to a zone response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Add one operation to a zone","tags":["API Shield Endpoint Management"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/api_gateway/operations/schema_validation":{"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"patch":{"deprecated":true,"description":"Updates multiple operation-level schema validation settings on the zone","operationId":"api-shield-schema-validation-update-multiple-operation-level-settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_old_operation_schema_validation_settings_multiple_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_old_operation_schema_validation_settings_multiple_request"}},"required":["result"],"type":"object"}]}}},"description":"Update multiple operation-level schema validation settings response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}]}}},"description":"Update multiple operation-level schema validation settings response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update multiple operation-level schema validation settings","tags":["API Shield Schema Validation 2.0"],"x-api-token-group":["Account API Gateway","Domain API Gateway"],"x-stainless-deprecation-message":"Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead."}},"/zones/{zone_id}/api_gateway/operations/{operation_id}":{"delete":{"operationId":"api-shield-endpoint-management-delete-an-operation","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common"}}},"description":"Delete an operation response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Delete an operation response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an operation","tags":["API Shield Endpoint Management"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]},"get":{"operationId":"api-shield-endpoint-management-retrieve-information-about-an-operation","parameters":[{"$ref":"#/components/parameters/api-shield_operation_feature_parameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_single-operation-response"}}},"description":"Retrieve information about an operation response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Retrieve information about an operation response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve information about an operation","tags":["API Shield Endpoint Management"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"},{"$ref":"#/components/parameters/api-shield_operation_id"}]},"/zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation":{"get":{"deprecated":true,"description":"Retrieves operation-level schema validation settings on the zone","operationId":"api-shield-schema-validation-retrieve-operation-level-settings","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_old_operation_schema_validation_settings"}}},"description":"Operation-level schema validation settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Operation-level schema validation settings response"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve operation-level schema validation settings","tags":["API Shield Schema Validation 2.0"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"],"x-stainless-deprecation-message":"Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead."},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"},{"$ref":"#/components/parameters/api-shield_operation_id"}],"put":{"deprecated":true,"description":"Updates operation-level schema validation settings on the zone","operationId":"api-shield-schema-validation-update-operation-level-settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_old_operation_schema_validation_settings_modify_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_old_operation_schema_validation_settings"}}},"description":"Update operation-level schema validation settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Update operation-level schema validation settings response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update operation-level schema validation settings","tags":["API Shield Schema Validation 2.0"],"x-api-token-group":["Account API Gateway","Domain API Gateway"],"x-stainless-deprecation-message":"Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead."}},"/zones/{zone_id}/api_gateway/schemas":{"get":{"operationId":"api-shield-endpoint-management-retrieve-operations-and-features-as-open-api-schemas","parameters":[{"in":"query","name":"host","schema":{"description":"Receive schema only for the given host(s).","items":{"example":"www.example.com","type":"string"},"type":"array","uniqueItems":true}},{"$ref":"#/components/parameters/api-shield_operation_feature_parameter"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_schema-response-with-thresholds"}}},"description":"Retrieve operations and features as OpenAPI schemas response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Retrieve operations and features as OpenAPI schemas response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve operations and features as OpenAPI schemas","tags":["API Shield Endpoint Management"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}]},"/zones/{zone_id}/api_gateway/settings/schema_validation":{"get":{"deprecated":true,"description":"Retrieves zone level schema validation settings currently set on the zone","operationId":"api-shield-schema-validation-retrieve-zone-level-settings","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_old_zone_schema_validation_settings"}}},"description":"Zone level schema validation settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Zone level schema validation settings response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve zone level schema validation settings","tags":["API Shield Schema Validation 2.0"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"],"x-stainless-deprecation-message":"Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead."},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"patch":{"deprecated":true,"description":"Updates zone level schema validation settings on the zone","operationId":"api-shield-schema-validation-patch-zone-level-settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_old_zone_schema_validation_settings_patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_old_zone_schema_validation_settings"}}},"description":"Update zone level schema validation settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Update zone level schema validation settings response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update zone level schema validation settings","tags":["API Shield Schema Validation 2.0"],"x-api-token-group":["Account API Gateway","Domain API Gateway"],"x-stainless-deprecation-message":"Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead."},"put":{"deprecated":true,"description":"Updates zone level schema validation settings on the zone","operationId":"api-shield-schema-validation-update-zone-level-settings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_old_zone_schema_validation_settings_put"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_old_zone_schema_validation_settings"}}},"description":"Update zone level schema validation settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Update zone level schema validation settings response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update zone level schema validation settings","tags":["API Shield Schema Validation 2.0"],"x-api-token-group":["Account API Gateway","Domain API Gateway"],"x-stainless-deprecation-message":"Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead."}},"/zones/{zone_id}/api_gateway/user_schemas":{"get":{"deprecated":true,"operationId":"api-shield-schema-validation-retrieve-information-about-all-schemas","parameters":[{"$ref":"#/components/parameters/api-shield_page"},{"$ref":"#/components/parameters/api-shield_per_page"},{"$ref":"#/components/parameters/api-shield_old_omit_source"},{"in":"query","name":"validation_enabled","schema":{"$ref":"#/components/schemas/api-shield_old_validation_enabled"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/api-shield_old_public_schema"},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"Retrieve information about all schemas on a zone response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}]}}},"description":"Retrieve information about all schemas on a zone response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve information about all schemas on a zone","tags":["API Shield Schema Validation 2.0"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"],"x-stainless-deprecation-message":"Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead."},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"post":{"deprecated":true,"operationId":"api-shield-schema-validation-post-schema","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"Schema file bytes","format":"binary","type":"string"},"kind":{"$ref":"#/components/schemas/api-shield_old_kind"},"name":{"description":"Name of the schema","example":"petstore schema","type":"string"},"validation_enabled":{"description":"Flag whether schema is enabled for validation.","enum":["true","false"],"type":"string"}},"required":["file","kind"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_old_schema_upload_response"}},"required":["result"],"type":"object"}]}}},"description":"Upload a schema response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_old_schema_upload_failure"}}},"description":"Upload a schema response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Upload a schema to a zone","tags":["API Shield Schema Validation 2.0"],"x-api-token-group":["Account API Gateway","Domain API Gateway"],"x-stainless-deprecation-message":"Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead."}},"/zones/{zone_id}/api_gateway/user_schemas/hosts":{"get":{"deprecated":true,"operationId":"api-shield-schema-validation-retrieve-user-schema-hosts","responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/api-shield_old_response_user_schemas_hosts"},"type":"array"}}}]}}},"description":"Retrieve schema hosts in a zone response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Retrieve schema hosts in a zone response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve schema hosts in a zone","tags":["API Shield Schema Validation 2.0"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"],"x-stainless-deprecation-message":"Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead."},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"},{"$ref":"#/components/parameters/api-shield_page"},{"$ref":"#/components/parameters/api-shield_per_page"}]},"/zones/{zone_id}/api_gateway/user_schemas/{schema_id}":{"delete":{"deprecated":true,"operationId":"api-shield-schema-delete-a-schema","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-single"}}},"description":"Delete a schema response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Delete a schema response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a schema","tags":["API Shield Schema Validation 2.0"],"x-api-token-group":["Account API Gateway","Domain API Gateway"],"x-stainless-deprecation-message":"Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead."},"get":{"deprecated":true,"operationId":"api-shield-schema-validation-retrieve-information-about-specific-schema","parameters":[{"$ref":"#/components/parameters/api-shield_old_omit_source"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_old_public_schema"}},"required":["result"],"type":"object"}]}}},"description":"Retrieve information about a specific schema on a zone response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Retrieve information about a specific schema zone response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve information about a specific schema on a zone","tags":["API Shield Schema Validation 2.0"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"],"x-stainless-deprecation-message":"Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead."},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"},{"$ref":"#/components/parameters/api-shield_old_schema_id"}],"patch":{"deprecated":true,"operationId":"api-shield-schema-validation-enable-validation-for-a-schema","requestBody":{"content":{"application/json":{"schema":{"properties":{"validation_enabled":{"allOf":[{"$ref":"#/components/schemas/api-shield_old_validation_enabled"},{"enum":[true]}]}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield_old_public_schema"}},"required":["result"],"type":"object"}]}}},"description":"Enable validation for a schema response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Enable validation for a schema response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Enable validation for a schema","tags":["API Shield Schema Validation 2.0"],"x-api-token-group":["Account API Gateway","Domain API Gateway"],"x-stainless-deprecation-message":"Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead."}},"/zones/{zone_id}/api_gateway/user_schemas/{schema_id}/operations":{"get":{"deprecated":true,"description":"Retrieves all operations from the schema. Operations that already exist in API Shield Endpoint Management will be returned as full operations.","operationId":"api-shield-schema-validation-extract-operations-from-schema","parameters":[{"$ref":"#/components/parameters/api-shield_operation_feature_parameter"},{"$ref":"#/components/parameters/api-shield_host_parameter"},{"$ref":"#/components/parameters/api-shield_method_parameter"},{"$ref":"#/components/parameters/api-shield_endpoint_parameter"},{"$ref":"#/components/parameters/api-shield_page"},{"$ref":"#/components/parameters/api-shield_per_page"},{"description":"Filter results by whether operations exist in API Shield Endpoint Management or not. `new` will just return operations from the schema that do not exist in API Shield Endpoint Management. `existing` will just return operations from the schema that already exist in API Shield Endpoint Management.","in":"query","name":"operation_status","schema":{"enum":["new","existing"],"example":"new","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-shield_api-response-collection"},{"properties":{"result":{"items":{"anyOf":[{"$ref":"#/components/schemas/api-shield_operation"},{"$ref":"#/components/schemas/api-shield_basic_operation"}]},"type":"array"}},"required":["result"],"type":"object"}]}}},"description":"Retrieve all operations from a schema response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-shield_api-response-common-failure"}}},"description":"Retrieve all operations from a schema response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Retrieve all operations from a schema.","tags":["API Shield Schema Validation 2.0"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"],"x-stainless-deprecation-message":"Use [Schema Validation API](https://developers.cloudflare.com/api/resources/schema_validation/) instead."},"parameters":[{"$ref":"#/components/parameters/api-shield_old_schema_id"},{"$ref":"#/components/parameters/api-shield_zone_id"}]},"/zones/{zone_id}/argo/smart_routing":{"get":{"description":"Retrieves the value of Argo Smart Routing enablement setting.","operationId":"argo-smart-routing-get-argo-smart-routing-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/argo-config_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/argo-config_api_response_single"}}},"description":"Get Argo Smart Routing enablement setting response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/argo-config_api_response_common_failure"}]}}},"description":"Get Argo Smart Routing enablement setting failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Argo Smart Routing setting","tags":["Argo Smart Routing"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Configures the value of the Argo Smart Routing enablement setting.","operationId":"argo-smart-routing-patch-argo-smart-routing-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/argo-config_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/argo-config_patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/argo-config_api_response_single"}}},"description":"Patch Argo Smart Routing enablement setting response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/argo-config_api_response_common_failure"}]}}},"description":"Patch Argo Smart Routing enablement setting failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Argo Smart Routing setting","tags":["Argo Smart Routing"],"x-api-token-group":["Zone Settings Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read","#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/argo/tiered_caching":{"get":{"description":"Tiered Cache works by dividing Cloudflare's data centers into a hierarchy of lower-tiers and upper-tiers. If content is not cached in lower-tier data centers (generally the ones closest to a visitor), the lower-tier must ask an upper-tier to see if it has the content. If the upper-tier does not have the content, only the upper-tier can ask the origin for content. This practice improves bandwidth efficiency by limiting the number of data centers that can ask the origin for content, which reduces origin load and makes websites more cost-effective to operate. Additionally, Tiered Cache concentrates connections to origin servers so they come from a small number of data centers rather than the full set of network locations. This results in fewer open connections using server resources.","operationId":"tiered-caching-get-tiered-caching-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_tiered_cache_response_value"}],"type":"object"}}},"description":"Get Tiered Caching setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Get Tiered Caching setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Tiered Caching setting","tags":["Tiered Caching"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Tiered Cache works by dividing Cloudflare's data centers into a hierarchy of lower-tiers and upper-tiers. If content is not cached in lower-tier data centers (generally the ones closest to a visitor), the lower-tier must ask an upper-tier to see if it has the content. If the upper-tier does not have the content, only the upper-tier can ask the origin for content. This practice improves bandwidth efficiency by limiting the number of data centers that can ask the origin for content, which reduces origin load and makes websites more cost-effective to operate. Additionally, Tiered Cache concentrates connections to origin servers so they come from a small number of data centers rather than the full set of network locations. This results in fewer open connections using server resources.","operationId":"tiered-caching-patch-tiered-caching-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_tiered_cache_response_value"}],"type":"object"}}},"description":"Patch Tiered Caching setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Patch Tiered Caching setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Tiered Caching setting","tags":["Tiered Caching"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/available_plans":{"get":{"description":"Lists available plans the zone can subscribe to.","operationId":"zone-rate-plan-list-available-plans","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/bill-subs-api_available-rate-plan"},"type":"array"}}}]}}},"description":"List Available Plans response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/bill-subs-api_available-rate-plan"},"type":"array"}}}]},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"List Available Plans response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Available Plans","tags":["Zone Rate Plan"],"x-api-token-group":["Billing Write","Billing Read"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/available_plans/{plan_identifier}":{"get":{"description":"Details of the available plan that the zone can subscribe to.","operationId":"zone-rate-plan-available-plan-details","parameters":[{"in":"path","name":"plan_identifier","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/bill-subs-api_available-rate-plan"}}}]}}},"description":"Available Plan Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/bill-subs-api_available-rate-plan"}}}]},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"Available Plan Details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Available Plan Details","tags":["Zone Rate Plan"],"x-api-token-group":["Billing Write","Billing Read"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/available_rate_plans":{"get":{"description":"Lists all rate plans the zone can subscribe to.","operationId":"zone-rate-plan-list-available-rate-plans","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_plan_response_collection"}}},"description":"List Available Rate Plans response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_plan_response_collection"},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"List Available Rate Plans response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Available Rate Plans","tags":["Zone Rate Plan"],"x-api-token-group":["Billing Write","Billing Read"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/bot_management":{"get":{"description":"Retrieve a zone's Bot Management Config","operationId":"bot-management-for-a-zone-get-config","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/bot-management_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot-management_bot_management_response_body"}}},"description":"Bot Management config response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bot-management_bot_management_response_body"},{"$ref":"#/components/schemas/bot-management_api-response-common-failure"}]}}},"description":"Bot Management config response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Zone Bot Management Config","tags":["Bot Settings"],"x-api-token-group":["Bot Management Write","Bot Management Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates the Bot Management configuration for a zone.\n\nThis API is used to update:\n- **Bot Fight Mode**\n- **Super Bot Fight Mode**\n- **Bot Management for Enterprise**\n\nSee [Bot Plans](https://developers.cloudflare.com/bots/plans/) for more information on the different plans \n\\\nIf you recently upgraded or downgraded your plan, refer to the following examples to clean up old configurations. \nCopy and paste the example body to remove old zone configurations based on your current plan.\n#### Clean up configuration for Bot Fight Mode plan\n```json\n{\n  \"sbfm_likely_automated\": \"allow\", \n  \"sbfm_definitely_automated\": \"allow\", \n  \"sbfm_verified_bots\": \"allow\", \n  \"sbfm_static_resource_protection\": false, \n  \"optimize_wordpress\": false, \n  \"suppress_session_score\": false\n}\n```\n#### Clean up configuration for SBFM Pro plan\n```json\n{\n  \"sbfm_likely_automated\": \"allow\", \n  \"fight_mode\": false \n}\n```\n#### Clean up configuration for SBFM Biz plan\n```json\n{\n  \"fight_mode\": false\n}\n```\n#### Clean up configuration for BM Enterprise Subscription plan\nIt is strongly recommended that you ensure you have [custom rules](https://developers.cloudflare.com/waf/custom-rules/) in place to protect your zone before disabling the SBFM rules. Without these protections, your zone is vulnerable to attacks.\n```json\n{\n  \"sbfm_likely_automated\": \"allow\", \n  \"sbfm_definitely_automated\": \"allow\", \n  \"sbfm_verified_bots\": \"allow\", \n  \"sbfm_static_resource_protection\": false, \n  \"optimize_wordpress\": false, \n  \"fight_mode\": false\n}\n```\n","operationId":"bot-management-for-a-zone-update-config","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/bot-management_identifier"}}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"summary":"Bot Fight Mode default example","value":{"ai_bots_protection":"disabled","cf_robots_variant":"off","crawler_protection":"disabled","enable_js":true,"fight_mode":true,"is_robots_txt_managed":false}},"example2":{"summary":"SBFM Pro plan default example","value":{"ai_bots_protection":"disabled","cf_robots_variant":"off","crawler_protection":"disabled","enable_js":true,"is_robots_txt_managed":false,"sbfm_definitely_automated":"block","sbfm_static_resource_protection":true,"sbfm_verified_bots":"block"}},"example3":{"summary":"SBFM Biz plan default example","value":{"ai_bots_protection":"disabled","cf_robots_variant":"off","crawler_protection":"disabled","enable_js":true,"is_robots_txt_managed":false,"sbfm_definitely_automated":"block","sbfm_likely_automated":"managed_challenge","sbfm_static_resource_protection":true,"sbfm_verified_bots":"block"}},"example4":{"summary":"BM Enterprise Subscription default example","value":{"ai_bots_protection":"disabled","auto_update_model":true,"bm_cookie_enabled":true,"cf_robots_variant":"off","crawler_protection":"disabled","enable_js":true,"is_robots_txt_managed":false}},"example5":{"summary":"Clean up configuration for Bot Fight Mode plan","value":{"bm_cookie_enabled":true,"optimize_wordpress":false,"sbfm_definitely_automated":"allow","sbfm_likely_automated":"allow","sbfm_static_resource_protection":false,"sbfm_verified_bots":"allow","suppress_session_score":false}},"example6":{"summary":"Clean up configuration for SBFM Pro plan","value":{"fight_mode":false,"sbfm_likely_automated":"allow"}},"example7":{"summary":"Clean up configuration for SBFM Biz plan","value":{"fight_mode":false}},"example8":{"summary":"Clean up configuration for BM Enterprise Subscription","value":{"fight_mode":false,"optimize_wordpress":false,"sbfm_definitely_automated":"allow","sbfm_likely_automated":"allow","sbfm_static_resource_protection":false,"sbfm_verified_bots":"allow"}},"example9":{"summary":"Block AI Bots on Ad pages only","value":{"ai_bots_protection":"only_on_ad_pages"}}},"schema":{"$ref":"#/components/schemas/bot-management_config_single"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot-management_bot_management_response_body"}}},"description":"Update Bot Management response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bot-management_bot_management_response_body"},{"$ref":"#/components/schemas/bot-management_api-response-common-failure"}]}}},"description":"Update Bot Management response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Zone Bot Management Config","tags":["Bot Settings"],"x-api-token-group":["Bot Management Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/bot_management/feedback":{"get":{"description":"Returns all feedback reports previously submitted for the specified zone. Feedback reports help improve detection by sharing samples of traffic that were misclassified as bots or humans.\n","operationId":"bot-management-zone-feedback-list","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/bot-management_identifier"}}],"responses":{"200":{"content":{"application/json":{"examples":{"sample":{"summary":"Example list response","value":[{"created_at":"2025-10-01T12:00:00Z","description":"Legitimate checkout traffic was blocked as bots","expression":"(http.host eq 'shop.example.com' and http.request.uri.path starts_with '/checkout') and cf.bot_management.score lt 5","first_request_seen_at":"2025-09-30T08:00:00Z","last_request_seen_at":"2025-09-30T09:00:00Z","requests":1200,"requests_by_attribute":{"topIPs":[{"metric":"203.0.113.10","requests":180},{"metric":"203.0.113.11","requests":150}],"topPaths":[{"metric":"/checkout","requests":1000}]},"requests_by_score":{"1":200,"2":300,"3":400,"4":300},"requests_by_score_src":{"heuristics":200,"machine_learning":1000},"subtype":"Spamming","type":"false_positive"}]}},"schema":{"items":{"$ref":"#/components/schemas/bot-management_feedback_report"},"type":"array"}}},"description":"List of feedback reports"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot-management_api-response-common-failure"}}},"description":"Feedback list failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List zone feedback reports","tags":["Feedback"],"x-api-token-group":["Bot Management Feedback Report Write","Bot Management Feedback Report Read","Bot Management Write","Bot Management Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Submit a feedback report for the specified zone. Use `type` to indicate whether the report is a false positive (good traffic flagged as bot) or a false negative (bot traffic missed). Furthermore, you can also use `expression` as a wirefilter to identify the affected traffic sample.\n\nSee more accepted API fields and expression types at https://developers.cloudflare.com/bots/concepts/feedback-loop/#api-fields and https://developers.cloudflare.com/bots/concepts/feedback-loop/#expression-fields, respectively.\n","operationId":"bot-management-zone-feedback-create","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/bot-management_identifier"}}],"requestBody":{"content":{"application/json":{"examples":{"false_negative_example":{"summary":"False negative example","value":{"description":"Automated scraping missed by detections","expression":"http.host eq 'www.example.com' and http.request.uri.path starts_with '/products' and cf.bot_management.score gt 25","first_request_seen_at":"2025-09-29T00:00:00Z","last_request_seen_at":"2025-09-29T06:00:00Z","requests":2000,"requests_by_attribute":{"topIPs":[{"metric":"203.0.113.55","requests":400}],"topJA3Hashes":[{"metric":"ab12cd34ef56...","requests":900}]},"requests_by_score":{"30":800,"40":700,"50":500},"requests_by_score_src":{"heuristics":200,"ml":1800},"subtype":"Scraping","type":"false_negative"}},"false_positive_example":{"summary":"False positive example","value":{"description":"Legitimate users flagged as bots during login","expression":"http.host eq 'app.example.com' and http.request.uri.path starts_with '/login' and cf.bot_management.score lt 5","first_request_seen_at":"2025-09-30T10:00:00Z","last_request_seen_at":"2025-09-30T11:00:00Z","requests":500,"requests_by_attribute":{"topIPs":[{"metric":"198.51.100.23","requests":60}],"topUserAgents":[{"metric":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36","requests":220}]},"requests_by_score":{"1":120,"2":150,"3":130,"4":100},"requests_by_score_src":{"heuristics":50,"ml":450},"subtype":"Login Abuse","type":"false_positive"}}},"schema":{"$ref":"#/components/schemas/bot-management_feedback_report"}}},"required":true},"responses":{"201":{"description":"Feedback report created"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot-management_api-response-common-failure"}}},"description":"Feedback creation failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Submit a feedback report","tags":["Feedback"],"x-api-token-group":["Bot Management Feedback Report Write","Bot Management Feedback Report Read","Bot Management Write","Bot Management Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/cache/cache_reserve":{"get":{"description":"Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.","operationId":"zone-cache-settings-get-cache-reserve-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"responses":{"200":{"content":{"application/json":{"examples":{"off":{"$ref":"#/components/examples/cache-rules_cache_reserve_off"}},"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_cache_reserve_response_value"}],"type":"object"}}},"description":"Get Cache Reserve setting response."},"4XX":{"content":{"application/json":{"examples":{"Error":{"$ref":"#/components/examples/cache-rules_dummy_error_response"}},"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Get Cache Reserve setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Cache Reserve setting","tags":["Zone Cache Settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","Zone Read","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.","operationId":"zone-cache-settings-change-cache-reserve-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/cache-rules_cache_reserve_value"}},"required":["value"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"on":{"$ref":"#/components/examples/cache-rules_cache_reserve_on"}},"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_cache_reserve_response_value"}],"type":"object"}}},"description":"Change Cache Reserve setting response."},"4XX":{"content":{"application/json":{"examples":{"Denied":{"$ref":"#/components/examples/cache-rules_cache_reserve_denied_clearing"}},"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Change Cache Reserve setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Change Cache Reserve setting","tags":["Zone Cache Settings"],"x-api-token-group":["Zone Settings Write","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/cache/cache_reserve_clear":{"get":{"description":"You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.","operationId":"zone-cache-settings-get-cache-reserve-clear","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"responses":{"200":{"content":{"application/json":{"examples":{"Completed":{"$ref":"#/components/examples/cache-rules_cache_reserve_clear_completed"},"In-progress":{"$ref":"#/components/examples/cache-rules_cache_reserve_clear_in_progress"}},"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_api-response-common"},{"$ref":"#/components/schemas/cache-rules_cache_reserve_clear_response_value"}],"type":"object"}}},"description":"Get Cache Reserve Clear response."},"4XX":{"content":{"application/json":{"examples":{"Not found":{"$ref":"#/components/examples/cache-rules_cache_reserve_clear_not_found"}},"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Get Cache Reserve Clear failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Cache Reserve Clear","tags":["Zone Cache Settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","Zone Read","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.","operationId":"zone-cache-settings-start-cache-reserve-clear","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"requestBody":{"content":{"application/json":{"example":"{}"}},"description":"The request body is currently not used.","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"In-progress":{"$ref":"#/components/examples/cache-rules_cache_reserve_clear_in_progress"}},"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_api-response-common"},{"$ref":"#/components/schemas/cache-rules_cache_reserve_clear_response_value"}],"type":"object"}}},"description":"Start Cache Reserve Clear response."},"4XX":{"content":{"application/json":{"examples":{"Rejected":{"$ref":"#/components/examples/cache-rules_cache_reserve_clear_rejected_cr_on"}},"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Start Cache Reserve Clear failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Start Cache Reserve Clear","tags":["Zone Cache Settings"],"x-api-token-group":["Zone Settings Write","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/cache/origin_post_quantum_encryption":{"get":{"description":"Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised.","operationId":"zone-cache-settings-get-origin-post-quantum-encryption-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_origin_post_quantum_encryption_response_value"}],"type":"object"}}},"description":"Get Origin Post-Quantum Encryption setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Get Origin Post-Quantum Encryption setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Origin Post-Quantum Encryption setting","tags":["Origin Post-Quantum"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","Zone Read","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised.","operationId":"zone-cache-settings-change-origin-post-quantum-encryption-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/cache-rules_origin_post_quantum_encryption_value"}},"required":["value"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_origin_post_quantum_encryption_response_value"}],"type":"object"}}},"description":"Change Origin Post-Quantum Encryption setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Change Origin Post-Quantum Encryption setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Change Origin Post-Quantum Encryption setting","tags":["Origin Post-Quantum"],"x-api-token-group":["Zone Settings Write","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/cache/regional_tiered_cache":{"get":{"description":"Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.","operationId":"zone-cache-settings-get-regional-tiered-cache-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_regional_tiered_cache_response_value"}],"type":"object"}}},"description":"Get Regional Tiered Cache setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Get Regional Tiered Cache setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Regional Tiered Cache setting","tags":["Zone Cache Settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","Zone Read","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.","operationId":"zone-cache-settings-change-regional-tiered-cache-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/cache-rules_regional_tiered_cache_value"}},"required":["value"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_regional_tiered_cache_response_value"}],"type":"object"}}},"description":"Change Regional Tiered Cache setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Change Regional Tiered Cache setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Change Regional Tiered Cache setting","tags":["Zone Cache Settings"],"x-api-token-group":["Zone Settings Write","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/cache/tiered_cache_smart_topology_enable":{"delete":{"description":"Smart Tiered Cache dynamically selects the single closest upper tier for each of your website’s origins with no configuration required, using our in-house performance and routing data. Cloudflare collects latency data for each request to an origin, and uses the latency data to determine how well any upper-tier data center is connected with an origin. As a result, Cloudflare can select the data center with the lowest latency to be the upper-tier for an origin.","operationId":"smart-tiered-cache-delete-smart-tiered-cache-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_delete_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/cache-rules_smart_tiered_cache"}},"type":"object"}],"type":"object"}}},"description":"Delete Smart Tiered Cache setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Delete Smart Tiered Cache setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Smart Tiered Cache setting","tags":["Smart Tiered Cache"],"x-api-token-group":["Zone Settings Write","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Smart Tiered Cache dynamically selects the single closest upper tier for each of your website’s origins with no configuration required, using our in-house performance and routing data. Cloudflare collects latency data for each request to an origin, and uses the latency data to determine how well any upper-tier data center is connected with an origin. As a result, Cloudflare can select the data center with the lowest latency to be the upper-tier for an origin.","operationId":"smart-tiered-cache-get-smart-tiered-cache-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_smart_tiered_cache_response_value"}],"type":"object"}}},"description":"Get Smart Tiered Cache setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Get Smart Tiered Cache setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Smart Tiered Cache setting","tags":["Smart Tiered Cache"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","Zone Read","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Smart Tiered Cache dynamically selects the single closest upper tier for each of your website’s origins with no configuration required, using our in-house performance and routing data. Cloudflare collects latency data for each request to an origin, and uses the latency data to determine how well any upper-tier data center is connected with an origin. As a result, Cloudflare can select the data center with the lowest latency to be the upper-tier for an origin.","operationId":"smart-tiered-cache-patch-smart-tiered-cache-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_smart_tiered_cache_patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_smart_tiered_cache_response_value"}],"type":"object"}}},"description":"Patch Smart Tiered Cache setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Patch Smart Tiered Cache setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Smart Tiered Cache setting","tags":["Smart Tiered Cache"],"x-api-token-group":["Zone Settings Write","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read","#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/cache/variants":{"delete":{"description":"Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.","operationId":"zone-cache-settings-delete-variants-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_delete_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/cache-rules_variants"}},"type":"object"}],"type":"object"}}},"description":"Delete variants setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Delete variants setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete variants setting","tags":["Zone Cache Settings"],"x-api-token-group":["Zone Settings Write","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.","operationId":"zone-cache-settings-get-variants-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_variants_response_value"}],"type":"object"}}},"description":"Get variants setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Get variants setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get variants setting","tags":["Zone Cache Settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","Zone Read","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"patch":{"description":"Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.","operationId":"zone-cache-settings-change-variants-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/cache-rules_variants_value"}},"required":["value"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_variants_response_value"}],"type":"object"}}},"description":"Change variants setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Change variants setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Change variants setting","tags":["Zone Cache Settings"],"x-api-token-group":["Zone Settings Write","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/certificate_authorities/hostname_associations":{"get":{"description":"List Hostname Associations","operationId":"client-certificate-for-a-zone-list-hostname-associations","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"query","name":"mtls_certificate_id","schema":{"description":"The UUID to match against for a certificate that was uploaded to the mTLS Certificate Management endpoint. If no mtls_certificate_id is given, the results will be the hostnames associated to your active Cloudflare Managed CA.","example":"b2134436-2555-4acf-be5b-26c48136575e","maxLength":36,"minLength":36,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname_associations_response"}}},"description":"List Hostname Associations Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"List Hostname Associations Response Failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Hostname Associations","tags":["API Shield Client Certificates for a Zone"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Replace Hostname Associations","operationId":"client-certificate-for-a-zone-put-hostname-associations","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname_association"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname_associations_response"}}},"description":"Replace Hostname Associations Response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}}},"description":"Replace Hostname Associations Response Failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Replace Hostname Associations","tags":["API Shield Client Certificates for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/client_certificates":{"get":{"description":"List all of your Zone's API Shield mTLS Client Certificates by Status and/or using Pagination","operationId":"client-certificate-for-a-zone-list-client-certificates","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"query","name":"status","schema":{"description":"Client Certitifcate Status to filter results by.","enum":["all","active","pending_reactivation","pending_revocation","revoked"],"example":"all"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of records per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"limit","schema":{"description":"Limit to the number of records returned.","example":10,"type":"integer"}},{"in":"query","name":"offset","schema":{"description":"Offset the results","example":10,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_collection"}}},"description":"List Client Certificates Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"List Client Certificates Response Failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Client Certificates","tags":["API Shield Client Certificates for a Zone"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a new API Shield mTLS Client Certificate","operationId":"client-certificate-for-a-zone-create-client-certificate","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"csr":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-csr"},"validity_days":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-validity_days"}},"required":["csr","validity_days"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single"}}},"description":"Create Client Certificate Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Create Client Certificate Response Failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create Client Certificate","tags":["API Shield Client Certificates for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/client_certificates/{client_certificate_id}":{"delete":{"description":"Set a API Shield mTLS Client Certificate to pending_revocation status for processing to revoked status.","operationId":"client-certificate-for-a-zone-delete-client-certificate","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"client_certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single"}}},"description":"Revoke Client Certificate Response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}}},"description":"Revoke Client Certificate Response Failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Revoke Client Certificate","tags":["API Shield Client Certificates for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get Details for a single mTLS API Shield Client Certificate","operationId":"client-certificate-for-a-zone-client-certificate-details","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"client_certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single"}}},"description":"Client Certificate Details Response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}}},"description":"Client Certificate Details Response Failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Client Certificate Details","tags":["API Shield Client Certificates for a Zone"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"If a API Shield mTLS Client Certificate is in a pending_revocation state, you may reactivate it with this endpoint.","operationId":"client-certificate-for-a-zone-edit-client-certificate","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"client_certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"reactivate":{"example":true,"type":"boolean"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single"}}},"description":"Reactivate Client Certificate Response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}}},"description":"Reactivate Client Certificate Response Failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Reactivate Client Certificate","tags":["API Shield Client Certificates for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/cloud_connector/rules":{"get":{"operationId":"zone-cloud-connector-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cloud-connector_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloud-connector_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloud-connector_rules"}},"type":"object"}],"type":"object"}}},"description":"Cloud Connector rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloud-connector_api-response-common-failure"}]}}},"description":"Cloud Connector response failure"},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloud-connector_api-response-common-failure"}]}}},"description":"Cloud Connector response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Rules","tags":["Zone Cloud Connector Rules GET"],"x-api-token-group":["Cloud Connector Read","Cloud Connector Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"operationId":"zone-cloud-conenctor-rules-put","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cloud-connector_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/cloud-connector_rule"},"type":"array"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloud-connector_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/cloud-connector_rules"}},"type":"object"}],"type":"object"}}},"description":"Cloud Connector rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloud-connector_api-response-common-failure"}]}}},"description":"Cloud Connector response failure"},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cloud-connector_api-response-common-failure"}]}}},"description":"Cloud Connector response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Put Rules","tags":["Zone Cloud Connector Rules PUT"],"x-api-token-group":["Cloud Connector Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/content-upload-scan/disable":{"post":{"description":"Disable Content Scanning.","operationId":"waf-content-scanning-disable","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-api-response-common"}}},"description":"Disable Content Scanning response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-api-response-common-failure"}]}}},"description":"Disable Content Scanning failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Disable Content Scanning","tags":["Content Scanning"],"x-api-token-group":["Zone WAF Write","Account WAF Write"]}},"/zones/{zone_id}/content-upload-scan/enable":{"post":{"description":"Enable Content Scanning.","operationId":"waf-content-scanning-enable","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-api-response-common"}}},"description":"Enable Content Scanning response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-api-response-common-failure"}]}}},"description":"Enable Content Scanning failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Enable Content Scanning","tags":["Content Scanning"],"x-api-token-group":["Zone WAF Write","Account WAF Write"]}},"/zones/{zone_id}/content-upload-scan/payloads":{"get":{"description":"Get a list of existing custom scan expressions for Content Scanning.","operationId":"waf-content-scanning-list-custom-scan-expressions","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-scan-collection"}}},"description":"List existing Content Scan custom scan expressions response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-scan-collection"},{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-api-response-common-failure"}]}}},"description":"List existing Content Scan custom scan expressions failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Existing Custom Scan Expressions","tags":["Content Scanning"],"x-api-token-group":["Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read"]},"post":{"description":"Add custom scan expressions for Content Scanning.","operationId":"waf-content-scanning-add-custom-scan-expressions","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"properties":{"payload":{"$ref":"#/components/schemas/waf-product-api-bundle_custom-scan-payload"}},"required":["payload"],"type":"object"},"type":"array"}}},"description":"Array of custom scan expressions to add.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-scan-collection"}}},"description":"Add custom scan expressions for Content Scanning."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-scan-collection"},{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-api-response-common-failure"}]}}},"description":"List existing Content Scan custom scan expressions failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Add Custom Scan Expressions","tags":["Content Scanning"],"x-api-token-group":["Zone WAF Write","Account WAF Write"]}},"/zones/{zone_id}/content-upload-scan/payloads/{expression_id}":{"delete":{"description":"Delete a Content Scan Custom Expression.","operationId":"waf-content-scanning-delete-custom-scan-expressions","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}},{"in":"path","name":"expression_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_custom-scan-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-scan-collection"}}},"description":"Delete Content Scan custom scan expressions response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-scan-collection"},{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-api-response-common-failure"}]}}},"description":"Delete Content Scan custom scan expressions failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a Custom Scan Expression","tags":["Content Scanning"],"x-api-token-group":["Zone WAF Write","Account WAF Write"]}},"/zones/{zone_id}/content-upload-scan/settings":{"get":{"description":"Retrieve the current status of Content Scanning.","operationId":"waf-content-scanning-get-status","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-response-status"}}},"description":"Get Content Scanning status response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-api-response-common-failure"}}},"description":"Get Content Scanning status failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Content Scanning Status","tags":["Content Scanning"],"x-api-token-group":["Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read"]},"put":{"description":"Update the Content Scanning status.","operationId":"waf-content-scanning-update-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"description":"The status value for Content Scanning.","enum":["enabled","disabled"],"example":"enabled","type":"string"}},"required":["value"],"type":"object"}}},"description":"Content Scanning settings to update.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-response-status"}}},"description":"Update Content Scanning settings response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_schemas-api-response-common-failure"}}},"description":"Update Content Scanning settings failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Content Scanning Status","tags":["Content Scanning"],"x-api-token-group":["Zone WAF Write","Account WAF Write"]}},"/zones/{zone_id}/custom_certificates":{"get":{"description":"List, search, and filter all of your custom SSL certificates. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.","operationId":"custom-ssl-for-a-zone-list-ssl-configurations","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of zones per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"match","schema":{"default":"all","description":"Whether to match all search requirements or at least one (any).","enum":["any","all"],"type":"string"}},{"in":"query","name":"status","schema":{"description":"Status of the zone's custom SSL.","enum":["active","expired","deleted","pending","initializing"],"example":"active","readOnly":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_collection"}}},"description":"List SSL Configurations response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"List SSL Configurations response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List SSL Configurations","tags":["Custom SSL for a Zone"],"x-api-token-group":["Access: Mutual TLS Certificates Write","Access: Mutual TLS Certificates Read","SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Upload a new SSL certificate for a zone.","operationId":"custom-ssl-for-a-zone-create-ssl-configuration","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"bundle_method":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_bundle_method"},"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate"},"geo_restrictions":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_geo_restrictions"},"policy":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_policy"},"private_key":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_private_key"},"type":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_type"}},"required":["certificate","private_key"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_single"}}},"description":"Create SSL Configuration response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Create SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create SSL Configuration","tags":["Custom SSL for a Zone"],"x-api-token-group":["Access: Mutual TLS Certificates Write","SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/custom_certificates/prioritize":{"put":{"description":"If a zone has multiple SSL certificates, you can set the order in which they should be used during a request. The higher priority will break ties across overlapping 'legacy_custom' certificates.","operationId":"custom-ssl-for-a-zone-re-prioritize-ssl-certificates","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"certificates":{"description":"Array of ordered certificates.","example":[{"id":"5a7805061c76ada191ed06f989cc3dac","priority":2},{"id":"9a7806061c88ada191ed06f989cc3dac","priority":1}],"items":{"properties":{"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"},"priority":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_priority"}},"type":"object"},"type":"array"}},"required":["certificates"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_collection"}}},"description":"Re-prioritize SSL Certificates response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Re-prioritize SSL Certificates response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Re-prioritize SSL Certificates","tags":["Custom SSL for a Zone"],"x-api-token-group":["Access: Mutual TLS Certificates Write","SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/custom_certificates/{custom_certificate_id}":{"delete":{"description":"Remove a SSL certificate from a zone.","operationId":"custom-ssl-for-a-zone-delete-ssl-configuration","parameters":[{"in":"path","name":"custom_certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_id_only"}}},"description":"Delete SSL Configuration response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_id_only"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Delete SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete SSL Configuration","tags":["Custom SSL for a Zone"],"x-api-token-group":["Access: Mutual TLS Certificates Write","SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"get":{"operationId":"custom-ssl-for-a-zone-ssl-configuration-details","parameters":[{"in":"path","name":"custom_certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_single"}}},"description":"SSL Configuration Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"SSL Configuration Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"SSL Configuration Details","tags":["Custom SSL for a Zone"],"x-api-token-group":["Access: Mutual TLS Certificates Write","Access: Mutual TLS Certificates Read","SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing a configuration for sni_custom certificates will result in a new resource id being returned, and the previous one being deleted.","operationId":"custom-ssl-for-a-zone-edit-ssl-configuration","parameters":[{"in":"path","name":"custom_certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"bundle_method":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_bundle_method"},"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate"},"geo_restrictions":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_geo_restrictions"},"policy":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_policy"},"private_key":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_private_key"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_single"}}},"description":"Edit SSL Configuration response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Edit SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Edit SSL Configuration","tags":["Custom SSL for a Zone"],"x-api-token-group":["Access: Mutual TLS Certificates Write","SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/custom_hostnames":{"get":{"description":"List, search, sort, and filter all of your custom hostnames.","operationId":"custom-hostname-for-a-zone-list-custom-hostnames","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"query","name":"hostname","schema":{"description":"Fully qualified domain name to match against. This parameter cannot be used with the 'id' parameter.","example":"app.example.com","maxLength":255,"type":"string"}},{"in":"query","name":"id","schema":{"description":"Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname' parameter.","example":"0d89c70d-ad9f-4843-b99f-6cc0252067e9","maxLength":36,"minLength":36,"type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of hostnames per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"default":"ssl","description":"Field to order hostnames by.","enum":["ssl","ssl_status"],"example":"ssl"}},{"in":"query","name":"direction","schema":{"description":"Direction to order hostnames.","enum":["asc","desc"],"example":"desc"}},{"in":"query","name":"ssl","schema":{"default":"0","description":"Whether to filter hostnames based on if they have SSL enabled.","enum":[0,1]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_collection"}}},"description":"List Custom Hostnames response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"List Custom Hostnames response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Custom Hostnames","tags":["Custom Hostname for a Zone"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Add a new custom hostname and request that an SSL certificate be issued for it. One of three validation methods—http, txt, email—should be used, with 'http' recommended if the CNAME is already in place (or will be soon). Specifying 'email' will send an email to the WHOIS contacts on file for the base domain plus hostmaster, postmaster, webmaster, admin, administrator. If http is used and the domain is not already pointing to the Managed CNAME host, the PATCH method must be used once it is (to complete validation).  Enable bundling of certificates using the custom_cert_bundle field. The bundling process requires the following condition One certificate in the bundle must use an RSA, and the other must use an ECDSA.","operationId":"custom-hostname-for-a-zone-create-custom-hostname","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"custom_metadata":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_metadata"},"hostname":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname_post"},"ssl":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_sslpost"}},"required":["hostname","ssl"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single"}}},"description":"Create Custom Hostname response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Create Custom Hostname response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create Custom Hostname","tags":["Custom Hostname for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/custom_hostnames/fallback_origin":{"delete":{"operationId":"custom-hostname-fallback-origin-for-a-zone-delete-fallback-origin-for-custom-hostnames","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response"}}},"description":"Delete Fallback Origin for Custom Hostnames response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Delete Fallback Origin for Custom Hostnames response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete Fallback Origin for Custom Hostnames","tags":["Custom Hostname Fallback Origin for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"custom-hostname-fallback-origin-for-a-zone-get-fallback-origin-for-custom-hostnames","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response"}}},"description":"Get Fallback Origin for Custom Hostnames response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Get Fallback Origin for Custom Hostnames response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Fallback Origin for Custom Hostnames","tags":["Custom Hostname Fallback Origin for a Zone"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"operationId":"custom-hostname-fallback-origin-for-a-zone-update-fallback-origin-for-custom-hostnames","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"origin":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_origin"}},"required":["origin"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response"}}},"description":"Update Fallback Origin for Custom Hostnames response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Update Fallback Origin for Custom Hostnames response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update Fallback Origin for Custom Hostnames","tags":["Custom Hostname Fallback Origin for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/custom_hostnames/{custom_hostname_id}":{"delete":{"operationId":"custom-hostname-for-a-zone-delete-custom-hostname-(-and-any-issued-ssl-certificates)","parameters":[{"in":"path","name":"custom_hostname_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},"type":"object"}}},"description":"Delete Custom Hostname (and any issued SSL certificates) response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},"type":"object"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Delete Custom Hostname (and any issued SSL certificates) response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete Custom Hostname (and any issued SSL certificates)","tags":["Custom Hostname for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"custom-hostname-for-a-zone-custom-hostname-details","parameters":[{"in":"path","name":"custom_hostname_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single"}}},"description":"Custom Hostname Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Custom Hostname Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Custom Hostname Details","tags":["Custom Hostname for a Zone"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Modify SSL configuration for a custom hostname. When sent with SSL config that matches existing config, used to indicate that hostname should pass domain control validation (DCV). Can also be used to change validation type, e.g., from 'http' to 'email'. Bundle an existing certificate with another certificate by using the \"custom_cert_bundle\" field. The bundling process supports combining certificates as long as the following condition is met. One certificate must use the RSA algorithm, and the other must use the ECDSA algorithm.","operationId":"custom-hostname-for-a-zone-edit-custom-hostname","parameters":[{"in":"path","name":"custom_hostname_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"custom_metadata":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_metadata"},"custom_origin_server":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_origin_server"},"custom_origin_sni":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_origin_sni"},"ssl":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_sslpost"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single"}}},"description":"Edit Custom Hostname response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Edit Custom Hostname response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Edit Custom Hostname","tags":["Custom Hostname for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/custom_hostnames/{custom_hostname_id}/certificate_pack/{certificate_pack_id}/certificates/{certificate_id}":{"delete":{"description":"Delete a single custom certificate from a certificate pack that contains two bundled certificates. Deletion is subject to the following constraints. You cannot delete a certificate if it is the only remaining certificate in the pack. At least one certificate must remain in the pack.","operationId":"custom-hostname-for-a-zone-delete_single_certificate_and_key_in_a_custom_hostname","parameters":[{"in":"path","name":"custom_hostname_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"certificate_pack_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},"type":"object"}}},"description":"Delete Single Certificate and Key In a Custom Hostname response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},"type":"object"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Delete Single Certificate and Key In a Custom Hostname response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete Single Certificate And Key For Custom Hostname","tags":["Custom Hostname for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Replace a single custom certificate within a certificate pack that contains two bundled certificates. The replacement must adhere to the following constraints. You can only replace an RSA certificate with another RSA certificate or an ECDSA certificate with another ECDSA certificate.","operationId":"custom-hostname-for-a-zone-edit-custom-certificate-custom-hostname","parameters":[{"in":"path","name":"custom_hostname_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"certificate_pack_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_cert_and_key"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single"}}},"description":"Edit Custom Certificate In a Custom Hostname response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Edit Custom Certificate In a Custom Hostname response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Replace Custom Certificate and Custom Key In Custom Hostname","tags":["Custom Hostname for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/custom_ns":{"get":{"deprecated":true,"description":"Get metadata for account-level custom nameservers on a zone.\n\nDeprecated in favor of [Show DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-a-zone-list-dns-settings).\n","operationId":"account-level-custom-nameservers-usage-for-a-zone-get-account-custom-nameserver-related-zone-metadata","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-custom-nameservers_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-custom-nameservers_get_response"}}},"description":"Get Account Custom Nameserver Related Zone Metadata response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_get_response"},{"$ref":"#/components/schemas/dns-custom-nameservers_api-response-common-failure"}],"type":"object"}}},"description":"Get Account Custom Nameserver Related Zone Metadata response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Account Custom Nameserver Related Zone Metadata","tags":["Account-Level Custom Nameservers Usage for a Zone"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","Zero Trust: PII Read","Zaraz Edit","Zaraz Read","Zaraz Admin","Access: Apps and Policies Revoke","Access: Apps and Policies Write","Access: Apps and Policies Read","Access: Apps and Policies Revoke","Access: Mutual TLS Certificates Write","Access: Organizations, Identity Providers, and Groups Write","Zone Settings Write","Zone Settings Read","Zone Read","DNS Read","Workers Scripts Write","Workers Scripts Read","Zone Write","Workers Routes Write","Workers Routes Read","Stream Write","Stream Read","SSL and Certificates Write","SSL and Certificates Read","Logs Write","Logs Read","Cache Purge","Page Rules Write","Page Rules Read","Load Balancers Write","Load Balancers Read","Firewall Services Write","Firewall Services Read","DNS Write","Apps Write","Analytics Read","Access: Apps and Policies Write","Access: Apps and Policies Read"],"x-cfPermissionsRequired":{"enum":["#zone:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"put":{"deprecated":true,"description":"Set metadata for account-level custom nameservers on a zone.\n\nIf you would like new zones in the account to use account custom nameservers by default, use PUT /accounts/:identifier to set the account setting use_account_custom_ns_by_default to true.\n\nDeprecated in favor of [Update DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-a-zone-update-dns-settings).\n","operationId":"account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-custom-nameservers_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-custom-nameservers_zone_metadata"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-custom-nameservers_schemas-empty_response"}}},"description":"Set Account Custom Nameserver Related Zone Metadata response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-custom-nameservers_schemas-empty_response"},{"$ref":"#/components/schemas/dns-custom-nameservers_api-response-common-failure"}],"type":"object"}}},"description":"Set Account Custom Nameserver Related Zone Metadata response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Set Account Custom Nameserver Related Zone Metadata","tags":["Account-Level Custom Nameservers Usage for a Zone"],"x-api-token-group":["Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/dcv_delegation/uuid":{"get":{"description":"Retrieve the account and zone specific unique identifier used as part of the CNAME target for DCV Delegation.","operationId":"dcv-delegation-uuid-get","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_dcv_delegation_response"}}},"description":"Retrieve the DCV Delegation unique identifier response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_dcv_delegation_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Retrieve the DCV Delegation unique identifier response failure."}},"security":[{"api_email":[],"api_key":[]}],"summary":"Retrieve the DCV Delegation unique identifier.","tags":["DCV Delegation"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/devices/policy/certificates":{"get":{"description":"Fetches device certificate provisioning.","operationId":"devices-get-policy-certificates","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_devices_policy_certificates_single"}}},"description":"Get WARP client provision certificates enabled status response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_devices_policy_certificates_single"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Get WARP client provision certificates enabled status failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get device certificate provisioning status","tags":["Devices"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"]},"patch":{"description":"Enable Zero Trust Clients to provision a certificate, containing a x509 subject, and referenced by Access device posture policies when the client visits MTLS protected domains. This facilitates device posture without a WARP session.","operationId":"devices-update-policy-certificates","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/teams-devices_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_devices_policy_certificates"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/teams-devices_devices_policy_certificates_single"}}},"description":"Update a zone to toggle permission for devices to provision certificates response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/teams-devices_devices_policy_certificates_single"},{"$ref":"#/components/schemas/teams-devices_api-response-common-failure"}]}}},"description":"Patch a zone to toggle permission for devices to provision certificates failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update device certificate provisioning status","tags":["Devices"],"x-api-token-group":["SSL and Certificates Write"]}},"/zones/{zone_id}/dns_analytics/report":{"get":{"description":"Retrieves a list of summarised aggregate metrics over a given time period.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.","operationId":"dns-analytics-table","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-analytics_identifier"}},{"in":"query","name":"metrics","schema":{"$ref":"#/components/schemas/dns-analytics_metrics"}},{"in":"query","name":"dimensions","schema":{"$ref":"#/components/schemas/dns-analytics_dimensions"}},{"in":"query","name":"since","schema":{"$ref":"#/components/schemas/dns-analytics_since"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/dns-analytics_until"}},{"in":"query","name":"limit","schema":{"$ref":"#/components/schemas/dns-analytics_limit"}},{"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/dns-analytics_sort"}},{"in":"query","name":"filters","schema":{"$ref":"#/components/schemas/dns-analytics_filters"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-analytics_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-analytics_report"}},"type":"object"}],"type":"object"}}},"description":"Table response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-analytics_api-response-common-failure"},{"properties":{"result":{"$ref":"#/components/schemas/dns-analytics_report"}},"type":"object"}],"type":"object"}}},"description":"Table response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Table","tags":["DNS Analytics"],"x-api-token-group":["Analytics Read"],"x-cfPermissionsRequired":{"enum":["#analytics:read"]}}},"/zones/{zone_id}/dns_analytics/report/bytime":{"get":{"description":"Retrieves a list of aggregate metrics grouped by time interval.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.","operationId":"dns-analytics-by-time","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-analytics_identifier"}},{"in":"query","name":"metrics","schema":{"$ref":"#/components/schemas/dns-analytics_metrics"}},{"in":"query","name":"dimensions","schema":{"$ref":"#/components/schemas/dns-analytics_dimensions"}},{"in":"query","name":"since","schema":{"$ref":"#/components/schemas/dns-analytics_since"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/dns-analytics_until"}},{"in":"query","name":"limit","schema":{"$ref":"#/components/schemas/dns-analytics_limit"}},{"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/dns-analytics_sort"}},{"in":"query","name":"filters","schema":{"$ref":"#/components/schemas/dns-analytics_filters"}},{"in":"query","name":"time_delta","schema":{"$ref":"#/components/schemas/dns-analytics_time_delta"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-analytics_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-analytics_report_bytime"}},"type":"object"}],"type":"object"}}},"description":"By Time response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-analytics_api-response-common-failure"},{"properties":{"result":{"$ref":"#/components/schemas/dns-analytics_report_bytime"}},"type":"object"}],"type":"object"}}},"description":"By Time response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"By Time","tags":["DNS Analytics"],"x-api-token-group":["Analytics Read"],"x-cfPermissionsRequired":{"enum":["#analytics:read"]}}},"/zones/{zone_id}/dns_records":{"get":{"description":"List, search, sort, and filter a zones' DNS records.","operationId":"dns-records-for-a-zone-list-dns-records","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}},{"in":"query","name":"name","schema":{"description":"Exact value of the DNS record name. This is a convenience alias for `name.exact`.\n","example":"www.example.com","type":"string"}},{"in":"query","name":"name.exact","schema":{"description":"Exact value of the DNS record name. Name filters are case-insensitive.\n","example":"www.example.com","type":"string"}},{"in":"query","name":"name.contains","schema":{"description":"Substring of the DNS record name. Name filters are case-insensitive.\n","example":"w.example.","type":"string"}},{"in":"query","name":"name.startswith","schema":{"description":"Prefix of the DNS record name. Name filters are case-insensitive.\n","example":"www.example","type":"string"}},{"in":"query","name":"name.endswith","schema":{"description":"Suffix of the DNS record name. Name filters are case-insensitive.\n","example":".example.com","type":"string"}},{"in":"query","name":"type","schema":{"$ref":"#/components/schemas/dns-records_type"}},{"in":"query","name":"content","schema":{"description":"Exact value of the DNS record content. This is a convenience alias for `content.exact`.\n","example":"127.0.0.1","type":"string"}},{"in":"query","name":"content.exact","schema":{"description":"Exact value of the DNS record content. Content filters are case-insensitive.\n","example":"127.0.0.1","type":"string"}},{"in":"query","name":"content.contains","schema":{"description":"Substring of the DNS record content. Content filters are case-insensitive.\n","example":"7.0.0.","type":"string"}},{"in":"query","name":"content.startswith","schema":{"description":"Prefix of the DNS record content. Content filters are case-insensitive.\n","example":"127.0.","type":"string"}},{"in":"query","name":"content.endswith","schema":{"description":"Suffix of the DNS record content. Content filters are case-insensitive.\n","example":".0.1","type":"string"}},{"in":"query","name":"proxied","schema":{"$ref":"#/components/schemas/dns-records_proxied"}},{"in":"query","name":"match","schema":{"$ref":"#/components/schemas/dns-records_match"}},{"in":"query","name":"comment","schema":{"description":"Exact value of the DNS record comment. This is a convenience alias for `comment.exact`.\n","example":"Hello, world","type":"string"}},{"in":"query","name":"comment.present","schema":{"description":"If this parameter is present, only records *with* a comment are returned.\n","type":"string"}},{"in":"query","name":"comment.absent","schema":{"description":"If this parameter is present, only records *without* a comment are returned.\n","type":"string"}},{"in":"query","name":"comment.exact","schema":{"description":"Exact value of the DNS record comment. Comment filters are case-insensitive.\n","example":"Hello, world","type":"string"}},{"in":"query","name":"comment.contains","schema":{"description":"Substring of the DNS record comment. Comment filters are case-insensitive.\n","example":"ello, worl","type":"string"}},{"in":"query","name":"comment.startswith","schema":{"description":"Prefix of the DNS record comment. Comment filters are case-insensitive.\n","example":"Hello, w","type":"string"}},{"in":"query","name":"comment.endswith","schema":{"description":"Suffix of the DNS record comment. Comment filters are case-insensitive.\n","example":"o, world","type":"string"}},{"in":"query","name":"tag","schema":{"description":"Condition on the DNS record tag.\n\nParameter values can be of the form `\u003ctag-name\u003e:\u003ctag-value\u003e` to search for an exact `name:value` pair, or just `\u003ctag-name\u003e` to search for records with a specific tag name regardless of its value.\n\nThis is a convenience shorthand for the more powerful `tag.\u003cpredicate\u003e` parameters.\nExamples:\n- `tag=important` is equivalent to `tag.present=important`\n- `tag=team:DNS` is equivalent to `tag.exact=team:DNS`\n","example":"team:DNS","type":"string"}},{"in":"query","name":"tag.present","schema":{"description":"Name of a tag which must be present on the DNS record. Tag filters are case-insensitive.\n","example":"important","type":"string"}},{"in":"query","name":"tag.absent","schema":{"description":"Name of a tag which must *not* be present on the DNS record. Tag filters are case-insensitive.\n","example":"important","type":"string"}},{"in":"query","name":"tag.exact","schema":{"description":"A tag and value, of the form `\u003ctag-name\u003e:\u003ctag-value\u003e`. The API will only return DNS records that have a tag named `\u003ctag-name\u003e` whose value is `\u003ctag-value\u003e`. Tag filters are case-insensitive.\n","example":"greeting:Hello, world","type":"string"}},{"in":"query","name":"tag.contains","schema":{"description":"A tag and value, of the form `\u003ctag-name\u003e:\u003ctag-value\u003e`. The API will only return DNS records that have a tag named `\u003ctag-name\u003e` whose value contains `\u003ctag-value\u003e`. Tag filters are case-insensitive.\n","example":"greeting:ello, worl","type":"string"}},{"in":"query","name":"tag.startswith","schema":{"description":"A tag and value, of the form `\u003ctag-name\u003e:\u003ctag-value\u003e`. The API will only return DNS records that have a tag named `\u003ctag-name\u003e` whose value starts with `\u003ctag-value\u003e`. Tag filters are case-insensitive.\n","example":"greeting:Hello, w","type":"string"}},{"in":"query","name":"tag.endswith","schema":{"description":"A tag and value, of the form `\u003ctag-name\u003e:\u003ctag-value\u003e`. The API will only return DNS records that have a tag named `\u003ctag-name\u003e` whose value ends with `\u003ctag-value\u003e`. Tag filters are case-insensitive.\n","example":"greeting:o, world","type":"string"}},{"in":"query","name":"search","schema":{"$ref":"#/components/schemas/dns-records_search"}},{"in":"query","name":"tag_match","schema":{"$ref":"#/components/schemas/dns-records_tag_match"}},{"in":"query","name":"page","schema":{"$ref":"#/components/schemas/dns-records_page"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/dns-records_per_page"}},{"in":"query","name":"order","schema":{"$ref":"#/components/schemas/dns-records_order"}},{"in":"query","name":"direction","schema":{"$ref":"#/components/schemas/dns-records_direction"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns_response_collection"}}},"description":"List DNS Records response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns_response_collection"},{"$ref":"#/components/schemas/dns-records_api-response-common-failure"}],"type":"object"}}},"description":"List DNS Records response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List DNS Records","tags":["DNS Records for a Zone"],"x-api-token-group":["DNS Read","DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a new DNS record for a zone.\n\nNotes:\n- A/AAAA records cannot exist on the same name as CNAME records.\n- NS records cannot exist on the same name as any other record type.\n- Domain names are always represented in Punycode, even if Unicode\n  characters were used when creating the record.\n","operationId":"dns-records-for-a-zone-create-dns-record","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns-record-post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns_response_single"}}},"description":"Create DNS Record response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns_response_single"},{"$ref":"#/components/schemas/dns-records_api-response-common-failure"}],"type":"object"}}},"description":"Create DNS Record response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create DNS Record","tags":["DNS Records for a Zone"],"x-api-token-group":["DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/dns_records/batch":{"post":{"description":"Send a Batch of DNS Record API calls to be executed together.\n\nNotes:\n- Although Cloudflare will execute the batched operations in a single database transaction, Cloudflare's distributed KV store must treat each record change as a single key-value pair. This means that the propagation of changes is not atomic. See [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/batch-record-changes/ \"Batch DNS records\") for more information.\n- The operations you specify within the /batch request body are always executed in the following order:\n\n    - Deletes\n    - Patches\n    - Puts\n    - Posts\n","operationId":"dns-records-for-a-zone-batch-dns-records","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns-request-batch-object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns_response_batch"}}},"description":"Batch DNS Records response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-records_api-response-common-failure"}],"type":"object"}}},"description":"Batch DNS Records response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Batch DNS Records","tags":["DNS Records for a Zone"],"x-api-token-group":["DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:batch"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/dns_records/export":{"get":{"description":"You can export your [BIND config](https://en.wikipedia.org/wiki/Zone_file \"Zone file\") through this endpoint.\n\nSee [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ \"Import and export records\") for more information.","operationId":"dns-records-for-a-zone-export-dns-records","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}}],"responses":{"200":{"content":{"text/plain":{"schema":{"description":"Exported BIND zone file.","example":"www.example.com. 300 IN  A 127.0.0.1\n","type":"string"}}},"description":"Export DNS Records response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_api-response-common-failure"}}},"description":"Export DNS Records response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Export DNS Records","tags":["DNS Records for a Zone"],"x-api-token-group":["DNS Read","DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/dns_records/import":{"post":{"description":"You can upload your [BIND config](https://en.wikipedia.org/wiki/Zone_file \"Zone file\") through this endpoint. It assumes that cURL is called from a location with bind_config.txt (valid BIND config) present.\n\nSee [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ \"Import and export records\") for more information.","operationId":"dns-records-for-a-zone-import-dns-records","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"BIND config to import.\n\n**Tip:** When using cURL, a file can be uploaded using `--form 'file=@bind_config.txt'`.\n","example":"www.example.com. 300 IN  A 127.0.0.1","type":"string"},"proxied":{"default":"false","description":"Whether or not proxiable records should receive the performance and security benefits of Cloudflare.\n\nThe value should be either `true` or `false`.","example":"true","type":"string"}},"required":["file"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns_response_import_scan"}}},"description":"Import DNS Records response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns_response_import_scan"},{"$ref":"#/components/schemas/dns-records_api-response-common-failure"}],"type":"object"}}},"description":"Import DNS Records response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Import DNS Records","tags":["DNS Records for a Zone"],"x-api-token-group":["DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/dns_records/scan":{"post":{"deprecated":true,"description":"Scan for common DNS records on your domain and automatically add them to your zone. Useful if you haven't updated your nameservers yet.","operationId":"dns-records-for-a-zone-scan-dns-records","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns_response_import_scan"}}},"description":"Scan DNS Records response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns_response_import_scan"},{"$ref":"#/components/schemas/dns-records_api-response-common-failure"}],"type":"object"}}},"description":"Scan DNS Records response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Scan DNS Records","tags":["DNS Records for a Zone"],"x-api-token-group":["DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"This endpoint is deprecated in favor of a new asynchronous version. Please use the [/scan/trigger](https://developers.cloudflare.com/api/resources/dns/subresources/records/methods/scan/trigger) and [/scan/review](https://developers.cloudflare.com/api/resources/dns/subresources/records/methods/scan/review) endpoints instead.\n"}},"/zones/{zone_id}/dns_records/scan/review":{"get":{"description":"Retrieves the list of DNS records discovered up to this point by the asynchronous scan. These records are temporary until explicitly accepted or rejected via `POST /scan/review`. Additional records may be discovered by the scan later.\n","operationId":"dns-records-for-a-zone-review-dns-scan","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns_response_collection"}}},"description":"List of discovered DNS records"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_api-response-common-failure"}}},"description":"Scan review failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Scanned DNS Records","tags":["DNS Records for a Zone"],"x-api-token-group":["DNS Read","DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Accept or reject DNS records found by the DNS records scan. Accepted records will be permanently added to the zone, while rejected records will be permanently deleted.\n","operationId":"dns-records-for-a-zone-apply-dns-scan-results","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns-request-review-scan-object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns_response_review_scan"}}},"description":"Records reviewed successfully"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_api-response-common-failure"}}},"description":"Review failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Review Scanned DNS Records","tags":["DNS Records for a Zone"],"x-api-token-group":["DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/dns_records/scan/trigger":{"post":{"description":"Initiates an asynchronous scan for common DNS records on your domain. Note that this **does not** automatically add records to your zone. The scan runs in the background, and results can be reviewed later using the `/scan/review` endpoints. Useful if you haven't updated your nameservers yet.","operationId":"dns-records-for-a-zone-trigger-dns-scan","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}}],"requestBody":{"content":{"application/json":{}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns_response_trigger_scan"}}},"description":"Trigger DNS Records Scan Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns_response_trigger_scan"},{"$ref":"#/components/schemas/dns-records_api-response-common-failure"}],"type":"object"}}},"description":"Trigger DNS Records Scan response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Trigger DNS Record Scan","tags":["DNS Records for a Zone"],"x-api-token-group":["DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/dns_records/{dns_record_id}":{"delete":{"operationId":"dns-records-for-a-zone-delete-dns-record","parameters":[{"in":"path","name":"dns_record_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/dns-records_identifier"}},"type":"object"}},"type":"object"}}},"description":"Delete DNS Record response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/dns-records_identifier"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/dns-records_api-response-common-failure"}],"type":"object"}}},"description":"Delete DNS Record response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete DNS Record","tags":["DNS Records for a Zone"],"x-api-token-group":["DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"dns-records-for-a-zone-dns-record-details","parameters":[{"in":"path","name":"dns_record_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns_response_single"}}},"description":"DNS Record Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns_response_single"},{"$ref":"#/components/schemas/dns-records_api-response-common-failure"}],"type":"object"}}},"description":"DNS Record Details response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"DNS Record Details","tags":["DNS Records for a Zone"],"x-api-token-group":["DNS Read","DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Update an existing DNS record.\n\nNotes:\n- A/AAAA records cannot exist on the same name as CNAME records.\n- NS records cannot exist on the same name as any other record type.\n- Domain names are always represented in Punycode, even if Unicode\n  characters were used when creating the record.\n","operationId":"dns-records-for-a-zone-patch-dns-record","parameters":[{"in":"path","name":"dns_record_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns-record-patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns_response_single"}}},"description":"Patch DNS Record response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns_response_single"},{"$ref":"#/components/schemas/dns-records_api-response-common-failure"}],"type":"object"}}},"description":"Patch DNS Record response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update DNS Record","tags":["DNS Records for a Zone"],"x-api-token-group":["DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Overwrite an existing DNS record.\n\nNotes:\n- A/AAAA records cannot exist on the same name as CNAME records.\n- NS records cannot exist on the same name as any other record type.\n- Domain names are always represented in Punycode, even if Unicode\n  characters were used when creating the record.\n","operationId":"dns-records-for-a-zone-update-dns-record","parameters":[{"in":"path","name":"dns_record_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-records_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns-record-post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-records_dns_response_single"}}},"description":"Update DNS Record response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-records_dns_response_single"},{"$ref":"#/components/schemas/dns-records_api-response-common-failure"}],"type":"object"}}},"description":"Update DNS Record response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Overwrite DNS Record","tags":["DNS Records for a Zone"],"x-api-token-group":["DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/dns_settings":{"get":{"description":"Show DNS settings for a zone","operationId":"dns-settings-for-a-zone-list-dns-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-settings_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_schemas-dns_response_single"}}},"description":"Show DNS Settings response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-settings_schemas-dns_response_single"},{"$ref":"#/components/schemas/dns-settings_api-response-common-failure"}],"type":"object"}}},"description":"Show DNS Settings response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Show DNS Settings","tags":["DNS Settings for a Zone"],"x-api-token-group":["Zone DNS Settings Write","Zone DNS Settings Read","DNS Read","DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Update DNS settings for a zone","operationId":"dns-settings-for-a-zone-update-dns-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dns-settings_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_dns-settings-zone-patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_schemas-dns_response_single"}}},"description":"Show DNS Settings response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns-settings_schemas-dns_response_single"},{"$ref":"#/components/schemas/dns-settings_api-response-common-failure"}],"type":"object"}}},"description":"Show DNS Settings response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update DNS Settings","tags":["DNS Settings for a Zone"],"x-api-token-group":["Zone DNS Settings Write","DNS Write"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/dnssec":{"delete":{"description":"Delete DNSSEC.","operationId":"dnssec-delete-dnssec-records","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dnssec_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dnssec_delete_dnssec_response_single"}}},"description":"Delete DNSSEC records response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dnssec_delete_dnssec_response_single"},{"$ref":"#/components/schemas/dnssec_api-response-common-failure"}]}}},"description":"Delete DNSSEC records response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete DNSSEC records","tags":["DNSSEC"],"x-api-token-group":["DNS Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Details about DNSSEC status and configuration.","operationId":"dnssec-dnssec-details","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dnssec_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dnssec_dnssec_response_single"}}},"description":"DNSSEC Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dnssec_dnssec_response_single"},{"$ref":"#/components/schemas/dnssec_api-response-common-failure"}]}}},"description":"DNSSEC Details response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"DNSSEC Details","tags":["DNSSEC"],"x-api-token-group":["DNS Read","DNS Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Enable or disable DNSSEC.","operationId":"dnssec-edit-dnssec-status","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/dnssec_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"dnssec_multi_signer":{"$ref":"#/components/schemas/dnssec_dnssec_multi_signer"},"dnssec_presigned":{"$ref":"#/components/schemas/dnssec_dnssec_presigned"},"dnssec_use_nsec3":{"$ref":"#/components/schemas/dnssec_dnssec_use_nsec3"},"status":{"description":"Status of DNSSEC, based on user-desired state and presence of necessary records.","enum":["active","disabled"],"example":"active","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dnssec_dnssec_response_single"}}},"description":"Edit DNSSEC Status response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dnssec_dnssec_response_single"},{"$ref":"#/components/schemas/dnssec_api-response-common-failure"}]}}},"description":"Edit DNSSEC Status response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Edit DNSSEC Status","tags":["DNSSEC"],"x-api-token-group":["DNS Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/email/routing":{"get":{"description":"Get information about the settings for your Email Routing zone.","operationId":"email-routing-settings-get-email-routing-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_email_settings_response_single"}}},"description":"Get Email Routing settings response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Email Routing settings","tags":["Email Routing settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.config.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/email/routing/disable":{"post":{"deprecated":true,"description":"Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work.","operationId":"email-routing-settings-disable-email-routing","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_email_settings_response_single"}}},"description":"Disable Email Routing response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Disable Email Routing","tags":["Email Routing settings"],"x-api-token-group":["Zone Settings Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.config.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/email/routing/dns":{"delete":{"description":"Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work.","operationId":"email-routing-settings-disable-email-routing-dns","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_email_setting_dns_request_body"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/email_api-response-single"},{"$ref":"#/components/schemas/email_dns_settings_response_collection"}]}}},"description":"Disable Email Routing response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Disable Email Routing","tags":["Email Routing settings"],"x-api-token-group":["Zone Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Show the DNS records needed to configure your Email Routing zone.","operationId":"email-routing-settings-email-routing-dns-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}},{"in":"query","name":"subdomain","schema":{"$ref":"#/components/schemas/email_email_setting_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/email_email_routing_dns_query_response"},{"$ref":"#/components/schemas/email_dns_settings_response_collection"}]}}},"description":"Email Routing - DNS settings response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Email Routing - DNS settings","tags":["Email Routing settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.config.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Unlock MX Records previously locked by Email Routing.","operationId":"email-routing-settings-unlock-email-routing-dns","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_email_setting_dns_request_body"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_email_settings_response_single"}}},"description":"Unlock Email Routing MX records"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Unlock Email Routing","tags":["Email Routing settings"],"x-api-token-group":["Zone Settings Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.config.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Enable you Email Routing zone. Add and lock the necessary MX and SPF records.","operationId":"email-routing-settings-enable-email-routing-dns","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_email_setting_dns_request_body"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_email_settings_response_single"}}},"description":"Enable Email Routing response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Enable Email Routing","tags":["Email Routing settings"],"x-api-token-group":["Zone Settings Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.config.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/email/routing/enable":{"post":{"deprecated":true,"description":"Enable you Email Routing zone. Add and lock the necessary MX and SPF records.","operationId":"email-routing-settings-enable-email-routing","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_email_settings_response_single"}}},"description":"Enable Email Routing response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Enable Email Routing","tags":["Email Routing settings"],"x-api-token-group":["Zone Settings Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.config.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/email/routing/rules":{"get":{"description":"Lists existing routing rules.","operationId":"email-routing-routing-rules-list-routing-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"enabled","schema":{"description":"Filter by enabled routing rules.","enum":[true,false],"example":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_rules_response_collection"}}},"description":"List routing rules response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List routing rules","tags":["Email Routing routing rules"],"x-api-token-group":["Email Routing Rules Write","Email Routing Rules Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.list"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Rules consist of a set of criteria for matching emails (such as an email being sent to a specific custom email address) plus a set of actions to take on the email (like forwarding it to a specific destination address).","operationId":"email-routing-routing-rules-create-routing-rule","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_create_rule_properties"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_rule_response_single"}}},"description":"Create routing rule response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create routing rule","tags":["Email Routing routing rules"],"x-api-token-group":["Email Routing Rules Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.create"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/email/routing/rules/catch_all":{"get":{"description":"Get information on the default catch-all routing rule.","operationId":"email-routing-routing-rules-get-catch-all-rule","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_catch_all_rule_response_single"}}},"description":"Get catch-all rule response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get catch-all rule","tags":["Email Routing routing rules"],"x-api-token-group":["Email Routing Rules Write","Email Routing Rules Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Enable or disable catch-all routing rule, or change action to forward to specific destination address.","operationId":"email-routing-routing-rules-update-catch-all-rule","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_update_catch_all_rule_properties"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_catch_all_rule_response_single"}}},"description":"Update catch-all rule response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update catch-all rule","tags":["Email Routing routing rules"],"x-api-token-group":["Email Routing Rules Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/email/routing/rules/{rule_identifier}":{"delete":{"description":"Delete a specific routing rule.","operationId":"email-routing-routing-rules-delete-routing-rule","parameters":[{"in":"path","name":"rule_identifier","required":true,"schema":{"$ref":"#/components/schemas/email_rule_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_rule_response_single"}}},"description":"Delete routing rule response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete routing rule","tags":["Email Routing routing rules"],"x-api-token-group":["Email Routing Rules Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.delete"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get information for a specific routing rule already created.","operationId":"email-routing-routing-rules-get-routing-rule","parameters":[{"in":"path","name":"rule_identifier","required":true,"schema":{"$ref":"#/components/schemas/email_rule_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_rule_response_single"}}},"description":"Get routing rule response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get routing rule","tags":["Email Routing routing rules"],"x-api-token-group":["Email Routing Rules Write","Email Routing Rules Read"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Update actions and matches, or enable/disable specific routing rules.","operationId":"email-routing-routing-rules-update-routing-rule","parameters":[{"in":"path","name":"rule_identifier","required":true,"schema":{"$ref":"#/components/schemas/email_rule_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/email_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_update_rule_properties"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_rule_response_single"}}},"description":"Update routing rule response"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update routing rule","tags":["Email Routing routing rules"],"x-api-token-group":["Email Routing Rules Write"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/filters":{"delete":{"deprecated":true,"description":"Deletes one or more existing filters.","operationId":"filters-delete-filters","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}},{"in":"query","name":"id","required":true,"schema":{"items":{"$ref":"#/components/schemas/firewall_filters_components-schemas-id"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-delete-response-collection"}}},"description":"Delete filters response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-delete-response-collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Delete filters response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete filters","tags":["Filters"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"deprecated":true,"description":"Fetches filters in a zone. You can filter the results using several optional parameters.","operationId":"filters-list-filters","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}},{"in":"query","name":"paused","schema":{"oneOf":[{"$ref":"#/components/schemas/firewall_filters_components-schemas-paused"}]}},{"in":"query","name":"expression","schema":{"description":"A case-insensitive string to find in the expression.","example":"php","type":"string"}},{"in":"query","name":"description","schema":{"description":"A case-insensitive string to find in the description.","example":"browsers","type":"string"}},{"in":"query","name":"ref","schema":{"description":"The filter ref (a short reference tag) to search for. Must be an exact match.","example":"FIL-100","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":25,"description":"Number of filters per page.","maximum":100,"minimum":5,"type":"number"}},{"in":"query","name":"id","schema":{"description":"The unique identifier of the filter.","example":"372e67954025e0ba6aaa6d586b9e0b61","maxLength":32,"minLength":32,"readOnly":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-response-collection"}}},"description":"List filters response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-response-collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"List filters response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List filters","tags":["Filters"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"deprecated":true,"description":"Creates one or more filters.","operationId":"filters-create-filters","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/firewall_filter"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-response-collection"}]}}},"description":"Create filters response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-response-collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Create filters response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create filters","tags":["Filters"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"deprecated":true,"description":"Updates one or more existing filters.","operationId":"filters-update-filters","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/firewall_filter-rule-update-request"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-response-collection"}}},"description":"Update filters response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-response-collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update filters response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update filters","tags":["Filters"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/filters/{filter_id}":{"delete":{"deprecated":true,"description":"Deletes an existing filter.","operationId":"filters-delete-a-filter","parameters":[{"in":"path","name":"filter_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_filters_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-delete-response-single"}}},"description":"Delete a filter response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-delete-response-single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Delete a filter response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a filter","tags":["Filters"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"deprecated":true,"description":"Fetches the details of a filter.","operationId":"filters-get-a-filter","parameters":[{"in":"path","name":"filter_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_filters_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-response-single"}}},"description":"Get a filter response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-response-single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Get a filter response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a filter","tags":["Filters"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"deprecated":true,"description":"Updates an existing filter.","operationId":"filters-update-a-filter","parameters":[{"in":"path","name":"filter_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_filters_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-response-single"}}},"description":"Update a filter response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-response-single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update a filter response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a filter","tags":["Filters"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/firewall/access_rules/rules":{"get":{"description":"Fetches IP Access rules of a zone. You can filter the results using several optional parameters.","operationId":"ip-access-rules-for-a-zone-list-ip-access-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}},{"in":"query","name":"mode","schema":{"$ref":"#/components/schemas/firewall_schemas-mode"}},{"in":"query","name":"configuration.target","schema":{"description":"The target to search in existing rules.","enum":["ip","ip_range","asn","country"],"example":"ip","type":"string"}},{"in":"query","name":"configuration.value","schema":{"description":"The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.\nNotes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.","example":"198.51.100.4","type":"string"}},{"in":"query","name":"notes","schema":{"description":"The string to search for in the notes of existing IP Access rules.\nNotes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.","example":"my note","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.","enum":["any","all"],"type":"string"}},{"in":"query","name":"page","schema":{"description":"Requested page within paginated list of results.","example":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"description":"Maximum number of results requested.","example":20,"type":"number"}},{"in":"query","name":"order","schema":{"description":"The field used to sort returned rules.","enum":["configuration.target","configuration.value","mode"],"example":"mode","type":"string"}},{"in":"query","name":"direction","schema":{"description":"The direction used to sort returned rules.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_rule_collection_response"}}},"description":"List IP Access rules response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_rule_collection_response"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"List IP Access rules response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List IP Access rules","tags":["IP Access rules for a zone"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a new IP Access rule for a zone.\n\nNote: To create an IP Access rule that applies to multiple zones, refer to [IP Access rules for a user](#ip-access-rules-for-a-user) or [IP Access rules for an account](#ip-access-rules-for-an-account) as appropriate.","operationId":"ip-access-rules-for-a-zone-create-an-ip-access-rule","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"configuration":{"$ref":"#/components/schemas/firewall_configuration"},"mode":{"$ref":"#/components/schemas/firewall_schemas-mode"},"notes":{"allOf":[{"$ref":"#/components/schemas/firewall_notes"},{"default":""}]}},"required":["mode","configuration"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_rule_single_response"}}},"description":"Create an IP Access rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_rule_single_response"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Create an IP Access rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create an IP Access rule","tags":["IP Access rules for a zone"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/firewall/access_rules/rules/{rule_id}":{"delete":{"description":"Deletes an IP Access rule defined at the zone level.\n\nOptionally, you can use the `cascade` property to specify that you wish to delete similar rules in other zones managed by the same zone owner.","operationId":"ip-access-rules-for-a-zone-delete-an-ip-access-rule","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}},{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_rule_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"cascade":{"default":"none","description":"The level to attempt to delete similar rules defined for other zones with the same owner. The default value is `none`, which will only delete the current rule. Using `basic` will delete rules that match the same action (mode) and configuration, while using `aggressive` will delete rules that match the same configuration.","enum":["none","basic","aggressive"],"type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_rule_single_id_response"}}},"description":"Delete an IP Access rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_rule_single_id_response"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Delete an IP Access rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete an IP Access rule","tags":["IP Access rules for a zone"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates an IP Access rule defined at the zone level. You can only update the rule action (`mode` parameter) and notes.","operationId":"ip-access-rules-for-a-zone-update-an-ip-access-rule","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}},{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_rule_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"mode":{"$ref":"#/components/schemas/firewall_schemas-mode"},"notes":{"$ref":"#/components/schemas/firewall_notes"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_rule_single_response"}}},"description":"Update an IP Access rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_rule_single_response"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update an IP Access rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update an IP Access rule","tags":["IP Access rules for a zone"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/firewall/lockdowns":{"get":{"description":"Fetches Zone Lockdown rules. You can filter the results using several optional parameters.","operationId":"zone-lockdown-list-zone-lockdown-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"description","schema":{"allOf":[{"$ref":"#/components/schemas/firewall_schemas-description_search"}]}},{"in":"query","name":"modified_on","schema":{"allOf":[{"$ref":"#/components/schemas/firewall_modified_on"}]}},{"in":"query","name":"ip","schema":{"allOf":[{"$ref":"#/components/schemas/firewall_ip_search"}]}},{"in":"query","name":"priority","schema":{"allOf":[{"$ref":"#/components/schemas/firewall_schemas-priority"}]}},{"in":"query","name":"uri_search","schema":{"allOf":[{"$ref":"#/components/schemas/firewall_uri_search"}]}},{"in":"query","name":"ip_range_search","schema":{"allOf":[{"$ref":"#/components/schemas/firewall_ip_range_search"}]}},{"in":"query","name":"per_page","schema":{"default":20,"description":"The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.","maximum":1000,"minimum":1,"type":"number"}},{"in":"query","name":"created_on","schema":{"description":"The timestamp of when the rule was created.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"}},{"in":"query","name":"description_search","schema":{"description":"A string to search for in the description of existing rules.","example":"endpoints","type":"string"}},{"in":"query","name":"ip_search","schema":{"description":"A single IP address to search for in existing rules.","example":"1.2.3.4","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_zonelockdown_response_collection"}}},"description":"List Zone Lockdown rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_zonelockdown_response_collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"List Zone Lockdown rules response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Zone Lockdown rules","tags":["Zone Lockdown"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"post":{"description":"Creates a new Zone Lockdown rule.","operationId":"zone-lockdown-create-a-zone-lockdown-rule","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"configurations":{"$ref":"#/components/schemas/firewall_configurations"},"description":{"$ref":"#/components/schemas/firewall_description"},"paused":{"$ref":"#/components/schemas/firewall_schemas-paused"},"priority":{"$ref":"#/components/schemas/firewall_schemas-priority"},"urls":{"$ref":"#/components/schemas/firewall_urls"}},"required":["urls","configurations"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_zonelockdown_response_single"}}},"description":"Create a Zone Lockdown rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_zonelockdown_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Create a Zone Lockdown rule response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a Zone Lockdown rule","tags":["Zone Lockdown"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/firewall/lockdowns/{lock_downs_id}":{"delete":{"description":"Deletes an existing Zone Lockdown rule.","operationId":"zone-lockdown-delete-a-zone-lockdown-rule","parameters":[{"in":"path","name":"lock_downs_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_lockdowns_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/firewall_lockdowns_components-schemas-id"}},"type":"object"}},"type":"object"}}},"description":"Delete a Zone Lockdown rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/firewall_lockdowns_components-schemas-id"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Delete a Zone Lockdown rule response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a Zone Lockdown rule","tags":["Zone Lockdown"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Fetches the details of a Zone Lockdown rule.","operationId":"zone-lockdown-get-a-zone-lockdown-rule","parameters":[{"in":"path","name":"lock_downs_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_lockdowns_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_zonelockdown_response_single"}}},"description":"Get a Zone Lockdown rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_zonelockdown_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Get a Zone Lockdown rule response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a Zone Lockdown rule","tags":["Zone Lockdown"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Updates an existing Zone Lockdown rule.","operationId":"zone-lockdown-update-a-zone-lockdown-rule","parameters":[{"in":"path","name":"lock_downs_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_lockdowns_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"configurations":{"$ref":"#/components/schemas/firewall_configurations"},"urls":{"$ref":"#/components/schemas/firewall_urls"}},"required":["urls","configurations"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_zonelockdown_response_single"}}},"description":"Update a Zone Lockdown rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_zonelockdown_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update a Zone Lockdown rule response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a Zone Lockdown rule","tags":["Zone Lockdown"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/firewall/rules":{"delete":{"deprecated":true,"description":"Deletes existing firewall rules.","operationId":"firewall-rules-delete-firewall-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/firewall_firewall-rules_components-schemas-id"}},"required":["id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-rules-response-collection-delete"}}},"description":"Delete firewall rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-rules-response-collection-delete"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Delete firewall rules response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete firewall rules","tags":["Firewall rules"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"deprecated":true,"description":"Fetches firewall rules in a zone. You can filter the results using several optional parameters.","operationId":"firewall-rules-list-firewall-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}},{"in":"query","name":"description","schema":{"description":"A case-insensitive string to find in the description.","example":"mir","type":"string"}},{"in":"query","name":"action","schema":{"description":"The action to search for. Must be an exact match.","example":"block","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":25,"description":"Number of firewall rules per page.","maximum":100,"minimum":5,"type":"number"}},{"in":"query","name":"id","schema":{"description":"The unique identifier of the firewall rule.","example":"372e67954025e0ba6aaa6d586b9e0b60","maxLength":32,"readOnly":true,"type":"string"}},{"in":"query","name":"paused","schema":{"description":"When true, indicates that the firewall rule is currently paused.","example":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-rules-response-collection"}}},"description":"List firewall rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-rules-response-collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"List firewall rules response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List firewall rules","tags":["Firewall rules"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"deprecated":true,"description":"Updates the priority of existing firewall rules.","operationId":"firewall-rules-update-priority-of-firewall-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-rules-response-collection"}}},"description":"Update priority of firewall rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-rules-response-collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update priority of firewall rules response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update priority of firewall rules","tags":["Firewall rules"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"deprecated":true,"description":"Create one or more firewall rules.","operationId":"firewall-rules-create-firewall-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"$ref":"#/components/schemas/firewall_action"},"filter":{"$ref":"#/components/schemas/firewall_filter"}},"required":["filter","action"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-rules-response-collection"}}},"description":"Create firewall rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-rules-response-collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Create firewall rules response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create firewall rules","tags":["Firewall rules"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"deprecated":true,"description":"Updates one or more existing firewall rules.","operationId":"firewall-rules-update-firewall-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-rules-response-collection"}}},"description":"Update firewall rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-rules-response-collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update firewall rules response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update firewall rules","tags":["Firewall rules"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/firewall/rules/{rule_id}":{"delete":{"deprecated":true,"description":"Deletes an existing firewall rule.","operationId":"firewall-rules-delete-a-firewall-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_firewall-rules_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"delete_filter_if_unused":{"$ref":"#/components/schemas/firewall_delete_filter_if_unused"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-rules-single-response-delete"}}},"description":"Delete a firewall rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-rules-single-response-delete"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Delete a firewall rule response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a firewall rule","tags":["Firewall rules"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"deprecated":true,"description":"Fetches the details of a firewall rule.","operationId":"firewall-rules-get-a-firewall-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_firewall-rules_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}},{"in":"query","name":"id","schema":{"allOf":[{"$ref":"#/components/schemas/firewall_firewall-rules_components-schemas-id"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-rules-single-response"}}},"description":"Get a firewall rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-rules-single-response"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Get a firewall rule response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a firewall rule","tags":["Firewall rules"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"deprecated":true,"description":"Updates the priority of an existing firewall rule.","operationId":"firewall-rules-update-priority-of-a-firewall-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_firewall-rules_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/firewall_components-schemas-identifier"}},"required":["id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-rules-response-collection"}}},"description":"Update priority of a firewall rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-rules-response-collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update priority of a firewall rule response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update priority of a firewall rule","tags":["Firewall rules"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"deprecated":true,"description":"Updates an existing firewall rule.","operationId":"firewall-rules-update-a-firewall-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_firewall-rules_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"$ref":"#/components/schemas/firewall_action"},"filter":{"$ref":"#/components/schemas/firewall_filter"},"id":{"$ref":"#/components/schemas/firewall_components-schemas-identifier"}},"required":["id","filter","action"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_filter-rules-single-response"}}},"description":"Update a firewall rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_filter-rules-single-response"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update a firewall rule response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a firewall rule","tags":["Firewall rules"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/firewall/ua_rules":{"get":{"description":"Fetches User Agent Blocking rules in a zone. You can filter the results using several optional parameters.","operationId":"user-agent-blocking-rules-list-user-agent-blocking-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"description","schema":{"allOf":[{"$ref":"#/components/schemas/firewall_description_search"}]}},{"in":"query","name":"per_page","schema":{"default":20,"description":"The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.","maximum":1000,"minimum":1,"type":"number"}},{"in":"query","name":"user_agent","schema":{"description":"A string to search for in the user agent values of existing rules.","example":"Safari","type":"string"}},{"in":"query","name":"paused","schema":{"description":"When true, indicates that the rule is currently paused.","example":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_firewalluablock_response_collection"}}},"description":"List User Agent Blocking rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_firewalluablock_response_collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"List User Agent Blocking rules response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List User Agent Blocking rules","tags":["User Agent Blocking rules"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a new User Agent Blocking rule in a zone.","operationId":"user-agent-blocking-rules-create-a-user-agent-blocking-rule","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"configuration":{"$ref":"#/components/schemas/firewall_ua_configuration"},"description":{"$ref":"#/components/schemas/firewall_description"},"mode":{"$ref":"#/components/schemas/firewall_schemas-mode"},"paused":{"$ref":"#/components/schemas/firewall_schemas-paused"}},"required":["mode","configuration"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_firewalluablock_response_single"}}},"description":"Create a User Agent Blocking rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_firewalluablock_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Create a User Agent Blocking rule response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a User Agent Blocking rule","tags":["User Agent Blocking rules"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}":{"delete":{"description":"Deletes an existing User Agent Blocking rule.","operationId":"user-agent-blocking-rules-delete-a-user-agent-blocking-rule","parameters":[{"in":"path","name":"ua_rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_components-ua-rule-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/firewall_components-ua-rule-id"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/firewall_firewalluablock_response_single"}]}}},"description":"Delete a User Agent Blocking rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/firewall_firewalluablock_response_single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/firewall_components-ua-rule-id"}},"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Delete a User Agent Blocking rule response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a User Agent Blocking rule","tags":["User Agent Blocking rules"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the details of a User Agent Blocking rule.","operationId":"user-agent-blocking-rules-get-a-user-agent-blocking-rule","parameters":[{"in":"path","name":"ua_rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_components-ua-rule-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_firewalluablock_response_single"}}},"description":"Get a User Agent Blocking rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_firewalluablock_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Get a User Agent Blocking rule response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a User Agent Blocking rule","tags":["User Agent Blocking rules"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates an existing User Agent Blocking rule.","operationId":"user-agent-blocking-rules-update-a-user-agent-blocking-rule","parameters":[{"in":"path","name":"ua_rule_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_components-ua-rule-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"configuration":{"$ref":"#/components/schemas/firewall_configuration"},"description":{"$ref":"#/components/schemas/firewall_description"},"id":{"$ref":"#/components/schemas/firewall_components-schemas-identifier"},"mode":{"$ref":"#/components/schemas/firewall_schemas-mode"},"paused":{"$ref":"#/components/schemas/firewall_schemas-paused"}},"required":["id","mode","configuration"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_firewalluablock_response_single"}}},"description":"Update a User Agent Blocking rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_firewalluablock_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update a User Agent Blocking rule response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a User Agent Blocking rule","tags":["User Agent Blocking rules"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/firewall/waf/overrides":{"get":{"deprecated":true,"description":"Fetches the URI-based WAF overrides in a zone.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-overrides-list-waf-overrides","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"The page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":50,"description":"The number of WAF overrides per page.","maximum":100,"minimum":5,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_override_response_collection"}}},"description":"List WAF overrides response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_override_response_collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"List WAF overrides response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List WAF overrides","tags":["WAF overrides"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"deprecated":true,"description":"Creates a URI-based WAF override for a zone.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-overrides-create-a-waf-override","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"urls":{"$ref":"#/components/schemas/firewall_urls"}},"required":["urls"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_override_response_single"}}},"description":"Create a WAF override response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_override_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Create a WAF override response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a WAF override","tags":["WAF overrides"],"x-api-token-group":["Zone Settings Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/firewall/waf/overrides/{overrides_id}":{"delete":{"deprecated":true,"description":"Deletes an existing URI-based WAF override.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-overrides-delete-a-waf-override","parameters":[{"in":"path","name":"overrides_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_overrides-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/firewall_overrides-id"}},"type":"object"}},"type":"object"}}},"description":"Delete a WAF override response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/firewall_overrides-id"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Delete a WAF override response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a WAF override","tags":["WAF overrides"],"x-api-token-group":["Zone Settings Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"deprecated":true,"description":"Fetches the details of a URI-based WAF override.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-overrides-get-a-waf-override","parameters":[{"in":"path","name":"overrides_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_overrides-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_override_response_single"}}},"description":"Get a WAF override response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_override_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Get a WAF override response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a WAF override","tags":["WAF overrides"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"deprecated":true,"description":"Updates an existing URI-based WAF override.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-overrides-update-waf-override","parameters":[{"in":"path","name":"overrides_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_overrides-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/firewall_identifier"},"rewrite_action":{"$ref":"#/components/schemas/firewall_rewrite_action"},"rules":{"$ref":"#/components/schemas/firewall_rules"},"urls":{"$ref":"#/components/schemas/firewall_urls"}},"required":["id","urls","rules","rewrite_action"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_override_response_single"}}},"description":"Update WAF override response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_override_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update WAF override response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update WAF override","tags":["WAF overrides"],"x-api-token-group":["Zone Settings Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/firewall/waf/packages":{"get":{"deprecated":true,"description":"Fetches WAF packages for a zone.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-packages-list-waf-packages","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"The page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":50,"description":"The number of packages per page.","maximum":100,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"The field used to sort returned packages.","enum":["name"],"example":"name","type":"string"}},{"in":"query","name":"direction","schema":{"description":"The direction used to sort returned packages.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.","enum":["any","all"],"type":"string"}},{"in":"query","name":"name","schema":{"description":"The name of the WAF package.","example":"USER","readOnly":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_package_response_collection"}}},"description":"List WAF packages response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_package_response_collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"List WAF packages response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List WAF packages","tags":["WAF packages"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/firewall/waf/packages/{package_id}":{"get":{"deprecated":true,"description":"Fetches the details of a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-packages-get-a-waf-package","parameters":[{"in":"path","name":"package_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_package_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_package_response_single"}}},"description":"Get a WAF package response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_package_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Get a WAF package response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a WAF package","tags":["WAF packages"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"patch":{"deprecated":true,"description":"Updates a WAF package. You can update the sensitivity and the action of an anomaly detection WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-packages-update-a-waf-package","parameters":[{"in":"path","name":"package_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_package_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action_mode":{"$ref":"#/components/schemas/firewall_action_mode"},"sensitivity":{"$ref":"#/components/schemas/firewall_sensitivity"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_package_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/firewall_anomaly_package"}},"type":"object"}]}}},"description":"Update a WAF package response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/firewall_package_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/firewall_anomaly_package"}},"type":"object"}]},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update a WAF package response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a WAF package","tags":["WAF packages"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/firewall/waf/packages/{package_id}/groups":{"get":{"deprecated":true,"description":"Fetches the WAF rule groups in a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-rule-groups-list-waf-rule-groups","parameters":[{"in":"path","name":"package_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_schemas-identifier"}},{"in":"query","name":"mode","schema":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_mode"}]}},{"in":"query","name":"page","schema":{"default":1,"description":"Defines the page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":50,"description":"Defines the number of rule groups per page.","maximum":100,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Defines the field used to sort returned rule groups.","enum":["mode","rules_count"],"example":"mode","type":"string"}},{"in":"query","name":"direction","schema":{"description":"Defines the direction used to sort returned rule groups.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"Defines the condition for search requirements. When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.","enum":["any","all"],"type":"string"}},{"in":"query","name":"name","schema":{"description":"Defines the name of the rule group.","example":"Project Honey Pot","readOnly":true,"type":"string"}},{"in":"query","name":"rules_count","schema":{"default":0,"description":"Defines the number of rules in the current rule group.","example":10,"readOnly":true,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-managed-rules_rule_group_response_collection"}}},"description":"Defines the list WAF rule groups response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_rule_group_response_collection"},{"$ref":"#/components/schemas/waf-managed-rules_api-response-common-failure"}]}}},"description":"Defines the list WAF rule groups response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List WAF rule groups","tags":["WAF rule groups"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}":{"get":{"deprecated":true,"description":"Fetches the details of a WAF rule group.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-rule-groups-get-a-waf-rule-group","parameters":[{"in":"path","name":"group_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_identifier"}},{"in":"path","name":"package_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-managed-rules_rule_group_response_single"}}},"description":"Get a WAF rule group response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_rule_group_response_single"},{"$ref":"#/components/schemas/waf-managed-rules_api-response-common-failure"}]}}},"description":"Get a WAF rule group response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a WAF rule group","tags":["WAF rule groups"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"patch":{"deprecated":true,"description":"Updates a WAF rule group. You can update the state (`mode` parameter) of a rule group.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-rule-groups-update-a-waf-rule-group","parameters":[{"in":"path","name":"group_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_identifier"}},{"in":"path","name":"package_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"mode":{"$ref":"#/components/schemas/waf-managed-rules_mode"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-managed-rules_rule_group_response_single"}}},"description":"Update a WAF rule group response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_rule_group_response_single"},{"$ref":"#/components/schemas/waf-managed-rules_api-response-common-failure"}]}}},"description":"Update a WAF rule group response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a WAF rule group","tags":["WAF rule groups"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/firewall/waf/packages/{package_id}/rules":{"get":{"deprecated":true,"description":"Fetches WAF rules in a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-rules-list-waf-rules","parameters":[{"in":"path","name":"package_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_schemas-identifier"}},{"in":"query","name":"mode","schema":{"description":"Defines the action/mode a rule has been overridden to perform.","enum":["DIS","CHL","BLK","SIM"],"example":"CHL","type":"string"}},{"in":"query","name":"group_id","schema":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_components-schemas-identifier"}]}},{"in":"query","name":"page","schema":{"default":1,"description":"Defines the page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":50,"description":"Defines the number of rules per page.","maximum":100,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Defines the field used to sort returned rules.","enum":["priority","group_id","description"],"example":"status","type":"string"}},{"in":"query","name":"direction","schema":{"description":"Defines the direction used to sort returned rules.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"Defines the search requirements. When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.","enum":["any","all"],"type":"string"}},{"in":"query","name":"description","schema":{"description":"Defines the public description of the WAF rule.","example":"SQL injection prevention for SELECT statements","readOnly":true,"type":"string"}},{"in":"query","name":"priority","schema":{"description":"Defines the order in which the individual WAF rule is executed within its rule group.","readOnly":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-managed-rules_rule_response_collection"}}},"description":"List WAF rules response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_rule_response_collection"},{"$ref":"#/components/schemas/waf-managed-rules_api-response-common-failure"}]}}},"description":"List WAF rules response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List WAF rules","tags":["WAF rules"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{rule_id}":{"get":{"deprecated":true,"description":"Fetches the details of a WAF rule in a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-rules-get-a-waf-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_identifier"}},{"in":"path","name":"package_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-managed-rules_rule_response_single"}}},"description":"Get a WAF rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_rule_response_single"},{"$ref":"#/components/schemas/waf-managed-rules_api-response-common-failure"}]}}},"description":"Get a WAF rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a WAF rule","tags":["WAF rules"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"patch":{"deprecated":true,"description":"Updates a WAF rule. You can only update the mode/action of the rule.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-rules-update-a-waf-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_identifier"}},{"in":"path","name":"package_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-managed-rules_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"mode":{"description":"Defines the mode/action of the rule when triggered. You must use a value from the `allowed_modes` array of the current rule.","enum":["default","disable","simulate","block","challenge","on","off"],"example":"on","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_rule_response_single"},{"properties":{"result":{"oneOf":[{"$ref":"#/components/schemas/waf-managed-rules_anomaly_rule"},{"$ref":"#/components/schemas/waf-managed-rules_traditional_deny_rule"},{"$ref":"#/components/schemas/waf-managed-rules_traditional_allow_rule"}]}},"type":"object"}]}}},"description":"Update a WAF rule response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-managed-rules_rule_response_single"},{"properties":{"result":{"oneOf":[{"$ref":"#/components/schemas/waf-managed-rules_anomaly_rule"},{"$ref":"#/components/schemas/waf-managed-rules_traditional_deny_rule"},{"$ref":"#/components/schemas/waf-managed-rules_traditional_allow_rule"}]}},"type":"object"},{"$ref":"#/components/schemas/waf-managed-rules_api-response-common-failure"}]}}},"description":"Update a WAF rule response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a WAF rule","tags":["WAF rules"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/healthchecks":{"get":{"description":"List configured health checks.","operationId":"health-checks-list-health-checks","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}},{"$ref":"#/components/parameters/healthchecks_page"},{"$ref":"#/components/parameters/healthchecks_per_page"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_response_collection"}}},"description":"List Health Checks response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_response_collection"},{"$ref":"#/components/schemas/healthchecks_api-response-common-failure"}]}}},"description":"List Health Checks response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Health Checks","tags":["Health Checks"],"x-api-token-group":["Health Checks Write","Health Checks Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"post":{"description":"Create a new health check.","operationId":"health-checks-create-health-check","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_query_healthcheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_single_response"}}},"description":"Create Health Check response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_single_response"},{"$ref":"#/components/schemas/healthchecks_api-response-common-failure"}]}}},"description":"Create Health Check response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Health Check","tags":["Health Checks"],"x-api-token-group":["Health Checks Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/healthchecks/preview":{"post":{"description":"Create a new preview health check.","operationId":"health-checks-create-preview-health-check","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_query_healthcheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_single_response"}}},"description":"Create Preview Health Check response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_single_response"},{"$ref":"#/components/schemas/healthchecks_api-response-common-failure"}]}}},"description":"Create Preview Health Check response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Preview Health Check","tags":["Health Checks"],"x-api-token-group":["Health Checks Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/healthchecks/preview/{healthcheck_id}":{"delete":{"description":"Delete a health check.","operationId":"health-checks-delete-preview-health-check","parameters":[{"in":"path","name":"healthcheck_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_id_response"}}},"description":"Delete Preview Health Check response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_id_response"},{"$ref":"#/components/schemas/healthchecks_api-response-common-failure"}]}}},"description":"Delete Preview Health Check response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Preview Health Check","tags":["Health Checks"],"x-api-token-group":["Health Checks Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Fetch a single configured health check preview.","operationId":"health-checks-health-check-preview-details","parameters":[{"in":"path","name":"healthcheck_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_single_response"}}},"description":"Health Check Preview Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_single_response"},{"$ref":"#/components/schemas/healthchecks_api-response-common-failure"}]}}},"description":"Health Check Preview Details response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Health Check Preview Details","tags":["Health Checks"],"x-api-token-group":["Health Checks Write","Health Checks Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/healthchecks/{healthcheck_id}":{"delete":{"description":"Delete a health check.","operationId":"health-checks-delete-health-check","parameters":[{"in":"path","name":"healthcheck_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_id_response"}}},"description":"Delete Health Check response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_id_response"},{"$ref":"#/components/schemas/healthchecks_api-response-common-failure"}]}}},"description":"Delete Health Check response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Health Check","tags":["Health Checks"],"x-api-token-group":["Health Checks Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Fetch a single configured health check.","operationId":"health-checks-health-check-details","parameters":[{"in":"path","name":"healthcheck_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_single_response"}}},"description":"Health Check Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_single_response"},{"$ref":"#/components/schemas/healthchecks_api-response-common-failure"}]}}},"description":"Health Check Details response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Health Check Details","tags":["Health Checks"],"x-api-token-group":["Health Checks Write","Health Checks Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"patch":{"description":"Patch a configured health check.","operationId":"health-checks-patch-health-check","parameters":[{"in":"path","name":"healthcheck_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_query_healthcheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_single_response"}}},"description":"Patch Health Check response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_single_response"},{"$ref":"#/components/schemas/healthchecks_api-response-common-failure"}]}}},"description":"Patch Health Check response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Health Check","tags":["Health Checks"],"x-api-token-group":["Health Checks Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Update a configured health check.","operationId":"health-checks-update-health-check","parameters":[{"in":"path","name":"healthcheck_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/healthchecks_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_query_healthcheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthchecks_single_response"}}},"description":"Update Health Check response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/healthchecks_single_response"},{"$ref":"#/components/schemas/healthchecks_api-response-common-failure"}]}}},"description":"Update Health Check response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Health Check","tags":["Health Checks"],"x-api-token-group":["Health Checks Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/hold":{"delete":{"description":"Stop enforcement of a zone hold on the zone, permanently or temporarily, allowing the\ncreation and activation of zones with this zone's hostname.","operationId":"zones-0-hold-delete","parameters":[{"description":"Zone ID","in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}},{"description":"If `hold_after` is provided, the hold will be temporarily disabled,\nthen automatically re-enabled by the system at the time specified\nin this RFC3339-formatted timestamp. Otherwise, the hold will be\ndisabled indefinitely.","example":"2023-01-31T15:56:36+00:00","in":"query","name":"hold_after","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-api-response-single"},{"properties":{"result":{"properties":{"hold":{"example":false,"type":"boolean"},"hold_after":{"type":"string"},"include_subdomains":{"example":false,"type":"string"}},"type":"object"}},"type":"object"}]}}},"description":"Successful Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-api-response-common-failure"}]}}},"description":"Client Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Remove Zone Hold","tags":["Zone Holds"],"x-api-token-group":["Zone Write"]},"get":{"description":"Retrieve whether the zone is subject to a zone hold, and metadata about the hold.","operationId":"zones-0-hold-get","parameters":[{"description":"Zone ID","in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-api-response-single"},{"properties":{"result":{"properties":{"hold":{"example":true,"type":"boolean"},"hold_after":{"example":"2023-01-31T15:56:36+00:00","type":"string"},"include_subdomains":{"example":false,"type":"string"}},"type":"object"}},"type":"object"}]}}},"description":"Successful Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-api-response-common-failure"}]}}},"description":"Client Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Zone Hold","tags":["Zone Holds"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","Zero Trust: PII Read","Zaraz Edit","Zaraz Read","Zaraz Admin","Access: Apps and Policies Revoke","Access: Apps and Policies Write","Access: Apps and Policies Read","Access: Apps and Policies Revoke","Access: Mutual TLS Certificates Write","Access: Organizations, Identity Providers, and Groups Write","Zone Settings Write","Zone Settings Read","Zone Read","DNS Read","Workers Scripts Write","Workers Scripts Read","Zone Write","Workers Routes Write","Workers Routes Read","Stream Write","Stream Read","SSL and Certificates Write","SSL and Certificates Read","Logs Write","Logs Read","Cache Purge","Page Rules Write","Page Rules Read","Load Balancers Write","Load Balancers Read","Firewall Services Write","Firewall Services Read","DNS Write","Apps Write","Analytics Read","Access: Apps and Policies Write","Access: Apps and Policies Read"]},"patch":{"description":"Update the `hold_after` and/or `include_subdomains` values on an existing zone hold.\nThe hold is enabled if the `hold_after` date-time value is in the past.","operationId":"zones-0-hold-patch","parameters":[{"description":"Zone ID","in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"hold_after":{"default":"","description":"If `hold_after` is provided and future-dated, the hold will be temporarily disabled,\nthen automatically re-enabled by the system at the time specified\nin this RFC3339-formatted timestamp. A past-dated `hold_after` value will have\nno effect on an existing, enabled hold. Providing an empty string will set its value\nto the current time.","example":"2023-01-31T15:56:36+00:00","type":"string"},"include_subdomains":{"default":false,"description":"If `true`, the zone hold will extend to block any subdomain of the given zone, as well\nas SSL4SaaS Custom Hostnames. For example, a zone hold on a zone with the hostname\n'example.com' and include_subdomains=true will block 'example.com',\n'staging.example.com', 'api.staging.example.com', etc.","example":true,"type":"boolean"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-api-response-single"},{"properties":{"result":{"properties":{"hold":{"example":false,"type":"boolean"},"hold_after":{"type":"string"},"include_subdomains":{"example":false,"type":"string"}},"type":"object"}},"type":"object"}]}}},"description":"Successful Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-api-response-common-failure"}]}}},"description":"Client Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Zone Hold","tags":["Zone Holds"],"x-api-token-group":["Zone Write"]},"post":{"description":"Enforce a zone hold on the zone, blocking the creation and activation of zones with this zone's hostname.","operationId":"zones-0-hold-post","parameters":[{"description":"Zone ID","in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}},{"description":"If provided, the zone hold will extend to block any subdomain of the given zone, as well\nas SSL4SaaS Custom Hostnames. For example, a zone hold on a zone with the hostname\n'example.com' and include_subdomains=true will block 'example.com',\n'staging.example.com', 'api.staging.example.com', etc.","example":true,"in":"query","name":"include_subdomains","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-api-response-single"},{"properties":{"result":{"properties":{"hold":{"example":true,"type":"boolean"},"hold_after":{"example":"2023-01-31T15:56:36+00:00","type":"string"},"include_subdomains":{"example":true,"type":"string"}},"type":"object"}},"type":"object"}]}}},"description":"Successful Response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-api-response-common-failure"}]}}},"description":"Client Error"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Zone Hold","tags":["Zone Holds"],"x-api-token-group":["Zone Write"]}},"/zones/{zone_id}/hostnames/settings/{setting_id}":{"get":{"description":"List the requested TLS setting for the hostnames under this zone.","operationId":"per-hostname-tls-settings-list","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"setting_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_setting_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response_collection"}}},"description":"List per-hostname TLS settings response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"List per-hostname TLS settings response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List TLS setting for hostnames","tags":["Per-Hostname TLS Settings"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}":{"delete":{"description":"Delete the tls setting value for the hostname.","operationId":"per-hostname-tls-settings-delete","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"setting_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_setting_id"}},{"in":"path","name":"hostname","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response_delete"}}},"description":"Delete TLS setting for hostname response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response_delete"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Delete TLS setting for hostname response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete TLS setting for hostname","tags":["Per-Hostname TLS Settings"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get the requested TLS setting for the hostname.","operationId":"per-hostname-tls-settings-get","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"setting_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_setting_id"}},{"in":"path","name":"hostname","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_value"}},"required":["value"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response"}}},"description":"Get TLS setting for hostname response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Get TLS setting for hostname response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get TLS setting for hostname","tags":["Per-Hostname TLS Settings"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Update the tls setting value for the hostname.","operationId":"per-hostname-tls-settings-put","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"setting_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_setting_id"}},{"in":"path","name":"hostname","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_value"}},"required":["value"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response"}}},"description":"Edit TLS setting for hostname response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Edit TLS setting for hostname response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Edit TLS setting for hostname","tags":["Per-Hostname TLS Settings"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/keyless_certificates":{"get":{"description":"List all Keyless SSL configurations for a given zone.","operationId":"keyless-ssl-for-a-zone-list-keyless-ssl-configurations","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_response_collection"}}},"description":"List Keyless SSL Configurations response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"List Keyless SSL Configurations response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Keyless SSL Configurations","tags":["Keyless SSL for a Zone"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"operationId":"keyless-ssl-for-a-zone-create-keyless-ssl-configuration","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"bundle_method":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_bundle_method"},"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-certificate"},"host":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_host"},"name":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_name_write"},"port":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_port"},"tunnel":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_tunnel"}},"required":["host","port","certificate"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_response_single"}}},"description":"Create Keyless SSL Configuration response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Create Keyless SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create Keyless SSL Configuration","tags":["Keyless SSL for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/keyless_certificates/{keyless_certificate_id}":{"delete":{"operationId":"keyless-ssl-for-a-zone-delete-keyless-ssl-configuration","parameters":[{"in":"path","name":"keyless_certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_response_single_id"}}},"description":"Delete Keyless SSL Configuration response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_response_single_id"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Delete Keyless SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete Keyless SSL Configuration","tags":["Keyless SSL for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get details for one Keyless SSL configuration.","operationId":"keyless-ssl-for-a-zone-get-keyless-ssl-configuration","parameters":[{"in":"path","name":"keyless_certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_response_single"}}},"description":"Get Keyless SSL Configuration response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Get Keyless SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Keyless SSL Configuration","tags":["Keyless SSL for a Zone"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","Zero Trust: PII Read","Zaraz Edit","Zaraz Read","Zaraz Admin","Access: Apps and Policies Revoke","Access: Apps and Policies Write","Access: Apps and Policies Read","Access: Apps and Policies Revoke","Access: Mutual TLS Certificates Write","Access: Organizations, Identity Providers, and Groups Write","Zone Settings Write","Zone Settings Read","Zone Read","DNS Read","Workers Scripts Write","Workers Scripts Read","Zone Write","Workers Routes Write","Workers Routes Read","Stream Write","Stream Read","SSL and Certificates Write","SSL and Certificates Read","Logs Write","Logs Read","Cache Purge","Page Rules Write","Page Rules Read","Load Balancers Write","Load Balancers Read","Firewall Services Write","Firewall Services Read","DNS Write","Apps Write","Analytics Read","Access: Apps and Policies Write","Access: Apps and Policies Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"This will update attributes of a Keyless SSL. Consists of one or more of the following:  host,name,port.","operationId":"keyless-ssl-for-a-zone-edit-keyless-ssl-configuration","parameters":[{"in":"path","name":"keyless_certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"enabled":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_enabled_write"},"host":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_host"},"name":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_name_write"},"port":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_port"},"tunnel":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_tunnel"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_response_single"}}},"description":"Edit Keyless SSL Configuration response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_keyless_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Edit Keyless SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Edit Keyless SSL Configuration","tags":["Keyless SSL for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/leaked-credential-checks":{"get":{"description":"Retrieves the current status of Leaked Credential Checks.","operationId":"waf-product-api-leaked-credentials-get-status","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_response-status"}}},"description":"Get Leaked Credential Checks status response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_response-status"},{"$ref":"#/components/schemas/waf-product-api-bundle_api-response-common-failure"}]}}},"description":"Get Leaked Credential Checks status failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Leaked Credential Checks Status","tags":["Leaked Credential Checks"],"x-api-token-group":["Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read"]},"post":{"description":"Updates the current status of Leaked Credential Checks.","operationId":"waf-product-api-leaked-credentials-set-status","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_status"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_response-status"}}},"description":"Set Leaked Credential Checks status response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_response-status"},{"$ref":"#/components/schemas/waf-product-api-bundle_api-response-common-failure"}]}}},"description":"Set Leaked Credential Checks status failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Set Leaked Credential Checks Status","tags":["Leaked Credential Checks"],"x-api-token-group":["Zone WAF Write","Account WAF Write"]}},"/zones/{zone_id}/leaked-credential-checks/detections":{"get":{"description":"List user-defined detection patterns for Leaked Credential Checks.","operationId":"waf-product-api-leaked-credentials-list-detections","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-detection-collection"}}},"description":"List Leaked Credential Checks custom detections response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-detection-collection"},{"$ref":"#/components/schemas/waf-product-api-bundle_api-response-common-failure"}]}}},"description":"List Leaked Credential Checks custom detections failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Leaked Credential Checks Custom Detections","tags":["Leaked Credential Checks"],"x-api-token-group":["Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read"]},"post":{"description":"Create user-defined detection pattern for Leaked Credential Checks.","operationId":"waf-product-api-leaked-credentials-create-detection","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_custom-detection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-detection"}}},"description":"Create Leaked Credential Checks custom detection response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-detection"},{"$ref":"#/components/schemas/waf-product-api-bundle_api-response-common-failure"}]}}},"description":"Create Leaked Credential Checks custom detection failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Leaked Credential Checks Custom Detection","tags":["Leaked Credential Checks"],"x-api-token-group":["Zone WAF Write","Account WAF Write"]}},"/zones/{zone_id}/leaked-credential-checks/detections/{detection_id}":{"delete":{"description":"Remove user-defined detection pattern for Leaked Credential Checks.","operationId":"waf-product-api-leaked-credentials-delete-detection","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}},{"in":"path","name":"detection_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_detection-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_api-response-common"}}},"description":"Delete Leaked Credential Checks custom detection response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_api-response-common-failure"}}},"description":"Delete Leaked Credential Checks custom detection failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Leaked Credential Checks Custom Detection","tags":["Leaked Credential Checks"],"x-api-token-group":["Zone WAF Write","Account WAF Write"]},"get":{"description":"Get user-defined detection pattern for Leaked Credential Checks.","operationId":"waf-product-api-leaked-credentials-get-detection","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}},{"in":"path","name":"detection_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_detection-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-detection"}}},"description":"Get Leaked Credential Checks custom detection response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-detection"},{"$ref":"#/components/schemas/waf-product-api-bundle_api-response-common-failure"}]}}},"description":"Update Leaked Credential Checks custom detection failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Leaked Credential Checks Custom Detection","tags":["Leaked Credential Checks"]},"put":{"description":"Update user-defined detection pattern for Leaked Credential Checks.","operationId":"waf-product-api-leaked-credentials-update-detection","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_identifier"}},{"in":"path","name":"detection_id","required":true,"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_detection-id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_custom-detection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-detection"}}},"description":"Update Leaked Credential Checks custom detection response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waf-product-api-bundle_response-custom-detection"},{"$ref":"#/components/schemas/waf-product-api-bundle_api-response-common-failure"}]}}},"description":"Update Leaked Credential Checks custom detection failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Leaked Credential Checks Custom Detection","tags":["Leaked Credential Checks"],"x-api-token-group":["Zone WAF Write","Account WAF Write"]}},"/zones/{zone_id}/load_balancers":{"get":{"description":"List configured load balancers.","operationId":"load-balancers-list-load-balancers","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-response_collection"}}},"description":"List Load Balancers response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-response_collection"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"List Load Balancers response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Load Balancers","tags":["Load Balancers"],"x-api-token-group":["Load Balancers Write","Load Balancers Read"]},"post":{"description":"Create a new load balancer.","operationId":"load-balancers-create-load-balancer","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"adaptive_routing":{"$ref":"#/components/schemas/load-balancing_adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/load-balancing_country_pools"},"default_pools":{"$ref":"#/components/schemas/load-balancing_default_pools"},"description":{"$ref":"#/components/schemas/load-balancing_components-schemas-description"},"fallback_pool":{"$ref":"#/components/schemas/load-balancing_fallback_pool"},"location_strategy":{"$ref":"#/components/schemas/load-balancing_location_strategy"},"name":{"$ref":"#/components/schemas/load-balancing_components-schemas-name"},"networks":{"$ref":"#/components/schemas/load-balancing_networks"},"pop_pools":{"$ref":"#/components/schemas/load-balancing_pop_pools"},"proxied":{"$ref":"#/components/schemas/load-balancing_proxied"},"random_steering":{"$ref":"#/components/schemas/load-balancing_random_steering"},"region_pools":{"$ref":"#/components/schemas/load-balancing_region_pools"},"rules":{"$ref":"#/components/schemas/load-balancing_rules"},"session_affinity":{"$ref":"#/components/schemas/load-balancing_session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/load-balancing_session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/load-balancing_session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/load-balancing_steering_policy"},"ttl":{"$ref":"#/components/schemas/load-balancing_ttl"}},"required":["name","default_pools","fallback_pool"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-single_response"}}},"description":"Create Load Balancer response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-single_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Create Load Balancer response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Load Balancer","tags":["Load Balancers"],"x-api-token-group":["Load Balancers Write"]}},"/zones/{zone_id}/load_balancers/{load_balancer_id}":{"delete":{"description":"Delete a configured load balancer.","operationId":"load-balancers-delete-load-balancer","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-identifier"}},{"in":"path","name":"load_balancer_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_components-schemas-id_response"}}},"description":"Delete Load Balancer response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_components-schemas-id_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Delete Load Balancer response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Load Balancer","tags":["Load Balancers"],"x-api-token-group":["Load Balancers Write"]},"get":{"description":"Fetch a single configured load balancer.","operationId":"load-balancers-load-balancer-details","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-identifier"}},{"in":"path","name":"load_balancer_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-single_response"}}},"description":"Load Balancer Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-single_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Load Balancer Details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Load Balancer Details","tags":["Load Balancers"],"x-api-token-group":["Load Balancers Write","Load Balancers Read"]},"patch":{"description":"Apply changes to an existing load balancer, overwriting the supplied properties.","operationId":"load-balancers-patch-load-balancer","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-identifier"}},{"in":"path","name":"load_balancer_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"adaptive_routing":{"$ref":"#/components/schemas/load-balancing_adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/load-balancing_country_pools"},"default_pools":{"$ref":"#/components/schemas/load-balancing_default_pools"},"description":{"$ref":"#/components/schemas/load-balancing_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/load-balancing_components-schemas-enabled"},"fallback_pool":{"$ref":"#/components/schemas/load-balancing_fallback_pool"},"location_strategy":{"$ref":"#/components/schemas/load-balancing_location_strategy"},"name":{"$ref":"#/components/schemas/load-balancing_components-schemas-name"},"pop_pools":{"$ref":"#/components/schemas/load-balancing_pop_pools"},"proxied":{"$ref":"#/components/schemas/load-balancing_proxied"},"random_steering":{"$ref":"#/components/schemas/load-balancing_random_steering"},"region_pools":{"$ref":"#/components/schemas/load-balancing_region_pools"},"rules":{"$ref":"#/components/schemas/load-balancing_rules"},"session_affinity":{"$ref":"#/components/schemas/load-balancing_session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/load-balancing_session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/load-balancing_session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/load-balancing_steering_policy"},"ttl":{"$ref":"#/components/schemas/load-balancing_ttl"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-single_response"}}},"description":"Patch Load Balancer response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-single_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Patch Load Balancer response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Patch Load Balancer","tags":["Load Balancers"],"x-api-token-group":["Load Balancers Write"]},"put":{"description":"Update a configured load balancer.","operationId":"load-balancers-update-load-balancer","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-identifier"}},{"in":"path","name":"load_balancer_id","required":true,"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"adaptive_routing":{"$ref":"#/components/schemas/load-balancing_adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/load-balancing_country_pools"},"default_pools":{"$ref":"#/components/schemas/load-balancing_default_pools"},"description":{"$ref":"#/components/schemas/load-balancing_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/load-balancing_components-schemas-enabled"},"fallback_pool":{"$ref":"#/components/schemas/load-balancing_fallback_pool"},"location_strategy":{"$ref":"#/components/schemas/load-balancing_location_strategy"},"name":{"$ref":"#/components/schemas/load-balancing_components-schemas-name"},"networks":{"$ref":"#/components/schemas/load-balancing_networks"},"pop_pools":{"$ref":"#/components/schemas/load-balancing_pop_pools"},"proxied":{"$ref":"#/components/schemas/load-balancing_proxied"},"random_steering":{"$ref":"#/components/schemas/load-balancing_random_steering"},"region_pools":{"$ref":"#/components/schemas/load-balancing_region_pools"},"rules":{"$ref":"#/components/schemas/load-balancing_rules"},"session_affinity":{"$ref":"#/components/schemas/load-balancing_session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/load-balancing_session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/load-balancing_session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/load-balancing_steering_policy"},"ttl":{"$ref":"#/components/schemas/load-balancing_ttl"}},"required":["name","default_pools","fallback_pool"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-single_response"}}},"description":"Update Load Balancer response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancing_load-balancer_components-schemas-single_response"},{"$ref":"#/components/schemas/load-balancing_api-response-common-failure"}]}}},"description":"Update Load Balancer response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Load Balancer","tags":["Load Balancers"],"x-api-token-group":["Load Balancers Write"]}},"/zones/{zone_id}/logpush/datasets/{dataset_id}/fields":{"get":{"description":"Lists all fields available for a dataset. The response result is. an object with key-value pairs, where keys are field names, and values are descriptions.","operationId":"get-zones-zone_id-logpush-datasets-dataset_id-fields","parameters":[{"in":"path","name":"dataset_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_dataset"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_logpush_field_response_collection"}}},"description":"List fields response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"List fields response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List fields","tags":["Logpush jobs for a zone"],"x-api-token-group":["Logs Read"],"x-cfPermissionsRequired":{"enum":["#logs:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/logpush/datasets/{dataset_id}/jobs":{"get":{"description":"Lists Logpush jobs for a zone for a dataset.","operationId":"get-zones-zone_id-logpush-datasets-dataset_id-jobs","parameters":[{"in":"path","name":"dataset_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_dataset"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":[{"dataset":"http_requests","destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"error_message":null,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","id":1,"kind":"","last_complete":null,"last_error":null,"max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"name":"example.com","output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["Datetime","DstIP","SrcIP"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"}}],"success":true},"schema":{"$ref":"#/components/schemas/logpush_logpush_job_response_collection"}}},"description":"List Logpush jobs for a dataset response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"List Logpush jobs for a dataset response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Logpush jobs for a dataset","tags":["Logpush jobs for a zone"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/logpush/edge/jobs":{"get":{"description":"Lists Instant Logs jobs for a zone.","operationId":"get-zones-zone_id-logpush-edge-jobs","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_instant_logs_job_response_collection"}}},"description":"List Instant Logs jobs response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_instant_logs_job_response_collection"},{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"List Instant Logs jobs response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Instant Logs jobs","tags":["Instant Logs jobs for a zone"],"x-api-token-group":["Logs Read"],"x-cfPermissionsRequired":{"enum":["#logs:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new Instant Logs job for a zone.","operationId":"post-zones-zone_id-logpush-edge-jobs","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"fields":{"$ref":"#/components/schemas/logpush_fields"},"filter":{"$ref":"#/components/schemas/logpush_schemas-filter"},"sample":{"$ref":"#/components/schemas/logpush_sample"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_instant_logs_job_response_single"}}},"description":"Create Instant Logs job response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_instant_logs_job_response_single"},{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Create Instant Logs job response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Instant Logs job","tags":["Instant Logs jobs for a zone"],"x-api-token-group":["Logs Read"],"x-cfPermissionsRequired":{"enum":["#logs:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/logpush/jobs":{"get":{"description":"Lists Logpush jobs for a zone.","operationId":"get-zones-zone_id-logpush-jobs","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":[{"dataset":"http_requests","destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"error_message":null,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","id":1,"kind":"","last_complete":null,"last_error":null,"max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"name":"example.com","output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["Datetime","DstIP","SrcIP"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"}}],"success":true},"schema":{"$ref":"#/components/schemas/logpush_logpush_job_response_collection"}}},"description":"List Logpush jobs response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"List Logpush jobs response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Logpush jobs","tags":["Logpush jobs for a zone"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new Logpush job for a zone.","operationId":"post-zones-zone_id-logpush-jobs","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"example":{"dataset":"http_requests","destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","kind":"","max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"name":"example.com","output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["RayID","ClientIP","EdgeStartTimestamp"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"},"ownership_challenge":"00000000000000000000"},"schema":{"properties":{"dataset":{"$ref":"#/components/schemas/logpush_dataset"},"destination_conf":{"$ref":"#/components/schemas/logpush_destination_conf"},"enabled":{"$ref":"#/components/schemas/logpush_enabled"},"filter":{"$ref":"#/components/schemas/logpush_filter"},"frequency":{"$ref":"#/components/schemas/logpush_frequency"},"kind":{"$ref":"#/components/schemas/logpush_kind"},"logpull_options":{"$ref":"#/components/schemas/logpush_logpull_options"},"max_upload_bytes":{"$ref":"#/components/schemas/logpush_max_upload_bytes"},"max_upload_interval_seconds":{"$ref":"#/components/schemas/logpush_max_upload_interval_seconds"},"max_upload_records":{"$ref":"#/components/schemas/logpush_max_upload_records"},"name":{"$ref":"#/components/schemas/logpush_name"},"output_options":{"$ref":"#/components/schemas/logpush_output_options"},"ownership_challenge":{"$ref":"#/components/schemas/logpush_ownership_challenge"}},"required":["destination_conf"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"dataset":"http_requests","destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"error_message":null,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","id":1,"kind":"","last_complete":null,"last_error":null,"max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"name":"example.com","output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["Datetime","DstIP","SrcIP"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"}},"success":true},"schema":{"$ref":"#/components/schemas/logpush_logpush_job_response_single"}}},"description":"Create Logpush job response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Create Logpush job response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Logpush job","tags":["Logpush jobs for a zone"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/logpush/jobs/{job_id}":{"delete":{"description":"Deletes a Logpush job.","operationId":"delete-zones-zone_id-logpush-jobs-job_id","parameters":[{"in":"path","name":"job_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/logpush_id"}},"type":"object"}},"type":"object"}]}}},"description":"Delete Logpush job response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Delete Logpush job response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Logpush job","tags":["Logpush jobs for a zone"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Gets the details of a Logpush job.","operationId":"get-zones-zone_id-logpush-jobs-job_id","parameters":[{"in":"path","name":"job_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"dataset":"http_requests","destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"error_message":null,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","id":1,"kind":"","last_complete":null,"last_error":null,"max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"name":"example.com","output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["Datetime","DstIP","SrcIP"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"}},"success":true},"schema":{"$ref":"#/components/schemas/logpush_logpush_job_response_single"}}},"description":"Get Logpush job details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Get Logpush job details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get Logpush job details","tags":["Logpush jobs for a zone"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a Logpush job.","operationId":"put-zones-zone_id-logpush-jobs-job_id","parameters":[{"in":"path","name":"job_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"example":{"destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","kind":"","max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["RayID","ClientIP","EdgeStartTimestamp"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"},"ownership_challenge":"00000000000000000000"},"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/logpush_destination_conf"},"enabled":{"$ref":"#/components/schemas/logpush_enabled"},"filter":{"$ref":"#/components/schemas/logpush_filter"},"frequency":{"$ref":"#/components/schemas/logpush_frequency"},"kind":{"$ref":"#/components/schemas/logpush_kind"},"logpull_options":{"$ref":"#/components/schemas/logpush_logpull_options"},"max_upload_bytes":{"$ref":"#/components/schemas/logpush_max_upload_bytes"},"max_upload_interval_seconds":{"$ref":"#/components/schemas/logpush_max_upload_interval_seconds"},"max_upload_records":{"$ref":"#/components/schemas/logpush_max_upload_records"},"name":{"$ref":"#/components/schemas/logpush_name"},"output_options":{"$ref":"#/components/schemas/logpush_output_options"},"ownership_challenge":{"$ref":"#/components/schemas/logpush_ownership_challenge"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"errors":[],"messages":[],"result":{"dataset":"http_requests","destination_conf":"s3://mybucket/logs?region=us-west-2","enabled":false,"error_message":null,"filter":"{\"where\":{\"and\":[{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/static\"},{\"key\":\"ClientRequestHost\",\"operator\":\"eq\",\"value\":\"example.com\"}]}}","id":1,"kind":"","last_complete":null,"last_error":null,"max_upload_bytes":5000000,"max_upload_interval_seconds":30,"max_upload_records":1000,"name":"example.com","output_options":{"CVE-2021-44228":false,"batch_prefix":"","batch_suffix":"","field_delimiter":",","field_names":["Datetime","DstIP","SrcIP"],"output_type":"ndjson","record_delimiter":"","record_prefix":"{","record_suffix":"}\n","sample_rate":1,"timestamp_format":"unixnano"}},"success":true},"schema":{"$ref":"#/components/schemas/logpush_logpush_job_response_single"}}},"description":"Update Logpush job response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Update Logpush job response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Logpush job","tags":["Logpush jobs for a zone"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/logpush/ownership":{"post":{"description":"Gets a new ownership challenge sent to your destination.","operationId":"post-zones-zone_id-logpush-ownership","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/logpush_destination_conf"}},"required":["destination_conf"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_get_ownership_response"}}},"description":"Get ownership challenge response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Get ownership challenge response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get ownership challenge","tags":["Logpush jobs for a zone"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/logpush/ownership/validate":{"post":{"description":"Validates ownership challenge of the destination.","operationId":"post-zones-zone_id-logpush-ownership-validate","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/logpush_destination_conf"},"ownership_challenge":{"$ref":"#/components/schemas/logpush_ownership_challenge"}},"required":["destination_conf","ownership_challenge"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_validate_ownership_response"}}},"description":"Validate ownership challenge response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Validate ownership challenge response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Validate ownership challenge","tags":["Logpush jobs for a zone"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/logpush/validate/destination":{"post":{"description":"Validates destination.","operationId":"post-zones-zone_id-logpush-validate-destination","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/logpush_destination_conf"}},"required":["destination_conf"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_validate_response"}}},"description":"Validate destination response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Validate destination response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Validate destination","tags":["Logpush jobs for a zone"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/logpush/validate/destination/exists":{"post":{"description":"Checks if there is an existing job with a destination.","operationId":"post-zones-zone_id-logpush-validate-destination-exists","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/logpush_destination_conf"}},"required":["destination_conf"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_destination_exists_response"}}},"description":"Check destination exists response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Check destination exists response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Check destination exists","tags":["Logpush jobs for a zone"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/logpush/validate/origin":{"post":{"description":"Validates logpull origin with logpull_options.","operationId":"post-zones-zone_id-logpush-validate-origin","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logpush_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"logpull_options":{"$ref":"#/components/schemas/logpush_logpull_options"}},"required":["logpull_options"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_validate_response"}}},"description":"Validate origin response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_api-response-common-failure"}]}}},"description":"Validate origin response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Validate origin","tags":["Logpush jobs for a zone"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/logs/control/retention/flag":{"get":{"description":"Gets log retention flag for Logpull API.","operationId":"get-zones-zone_id-logs-control-retention-flag","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logcontrol_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logcontrol_retention_flag_response_single"}}},"description":"Get log retention flag response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logcontrol_api-response-common-failure"}]}}},"description":"Get log retention flag response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get log retention flag","tags":["Logs Received"],"x-api-token-group":["Logs Write","Logs Read"],"x-cfPermissionsRequired":{"enum":["#logs:read","#analytics:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Updates log retention flag for Logpull API.","operationId":"post-zones-zone_id-logs-control-retention-flag","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logcontrol_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logcontrol_retention_flag"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logcontrol_retention_flag_response_single"}}},"description":"Update log retention flag response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logcontrol_api-response-common-failure"}]}}},"description":"Update log retention flag response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update log retention flag","tags":["Logs Received"],"x-api-token-group":["Logs Write"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/logs/rayids/{ray_id}":{"get":{"description":"The `/rayids` api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique).","operationId":"get-zones-zone_id-logs-rayids-ray_id","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logshare_identifier"}},{"in":"path","name":"ray_id","required":true,"schema":{"$ref":"#/components/schemas/logshare_ray_identifier"}},{"in":"query","name":"fields","schema":{"$ref":"#/components/schemas/logshare_fields"}},{"in":"query","name":"timestamps","schema":{"$ref":"#/components/schemas/logshare_timestamps"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logshare_logs_response_json_lines"}}},"description":"Get logs RayIDs response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logshare_api-response-common-failure"}]}}},"description":"Get logs RayIDs response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get logs RayIDs","tags":["Logs Received"],"x-api-token-group":["Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/logs/received":{"get":{"description":"The `/received` api route allows customers to retrieve their edge HTTP logs. The basic access pattern is \"give me all the logs for zone Z for minute M\", where the minute M refers to the time records were received at Cloudflare's central data center. `start` is inclusive, and `end` is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: `start=2018-05-20T10:00:00Z\u0026end=2018-05-20T10:01:00Z`, then `start=2018-05-20T10:01:00Z\u0026end=2018-05-20T10:02:00Z` and so on; the overlap will be handled properly.","operationId":"get-zones-zone_id-logs-received","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logshare_identifier"}},{"in":"query","name":"start","schema":{"$ref":"#/components/schemas/logshare_start"}},{"in":"query","name":"end","required":true,"schema":{"$ref":"#/components/schemas/logshare_end"}},{"in":"query","name":"fields","schema":{"$ref":"#/components/schemas/logshare_fields"}},{"in":"query","name":"sample","schema":{"$ref":"#/components/schemas/logshare_sample"}},{"in":"query","name":"count","schema":{"$ref":"#/components/schemas/logshare_count"}},{"in":"query","name":"timestamps","schema":{"$ref":"#/components/schemas/logshare_timestamps"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logshare_logs_response_json_lines"}}},"description":"Get logs received response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logshare_api-response-common-failure"}]}}},"description":"Get logs received response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get logs received","tags":["Logs Received"],"x-api-token-group":["Logs Write","Logs Read"],"x-cfPermissionsRequired":{"enum":["#logs:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/logs/received/fields":{"get":{"description":"Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions.","operationId":"get-zones-zone_id-logs-received-fields","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/logshare_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logshare_fields_response"}}},"description":"List fields response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logshare_api-response-common-failure"}]}}},"description":"List fields response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List fields","tags":["Logs Received"],"x-api-token-group":["Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/managed_headers":{"delete":{"description":"Disables all Managed Transforms.","operationId":"deleteManagedTransforms","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"204":{"$ref":"#/components/responses/rulesets_Empty"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Managed Transforms","tags":["Managed Transforms"],"x-api-token-group":["Response Compression Write","Config Settings Write","Dynamic URL Redirects Write","Cache Settings Write","Custom Errors Write","Origin Write","Managed headers Write","Zone Transform Rules Write","Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Write","Sanitize Write","Transform Rules Write","Select Configuration Write","Bot Management Write","Zone WAF Write","Account WAF Write","Account Rulesets Write","Logs Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches a list of all Managed Transforms.","operationId":"listManagedTransforms","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_ManagedTransforms"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List Managed Transforms","tags":["Managed Transforms"],"x-api-token-group":["Response Compression Write","Response Compression Read","Config Settings Write","Config Settings Read","Dynamic URL Redirects Write","Dynamic URL Redirects Read","Cache Settings Write","Cache Settings Read","Custom Errors Write","Custom Errors Read","Origin Write","Origin Read","Managed headers Write","Managed headers Read","Zone Transform Rules Write","Zone Transform Rules Read","Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","HTTP DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Read","Sanitize Write","Sanitize Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Bot Management Write","Bot Management Read","Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates the status of one or more Managed Transforms.","operationId":"updateManagedTransforms","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"requestBody":{"$ref":"#/components/requestBodies/rulesets_ManagedTransforms"},"responses":{"200":{"$ref":"#/components/responses/rulesets_ManagedTransforms"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update Managed Transforms","tags":["Managed Transforms"],"x-api-token-group":["Response Compression Write","Config Settings Write","Dynamic URL Redirects Write","Cache Settings Write","Custom Errors Write","Origin Write","Managed headers Write","Zone Transform Rules Write","Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Write","Sanitize Write","Transform Rules Write","Select Configuration Write","Bot Management Write","Zone WAF Write","Account WAF Write","Account Rulesets Write","Logs Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/origin_tls_client_auth":{"get":{"operationId":"zone-level-authenticated-origin-pulls-list-certificates","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_collection"}}},"description":"List Certificates response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"List Certificates response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Certificates","tags":["Zone-Level Authenticated Origin Pulls"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.","operationId":"zone-level-authenticated-origin-pulls-upload-certificate","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate"},"private_key":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_private_key"}},"required":["certificate","private_key"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single"}}},"description":"Upload Certificate response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Upload Certificate response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Upload Certificate","tags":["Zone-Level Authenticated Origin Pulls"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/origin_tls_client_auth/hostnames":{"put":{"description":"Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter *enabled* to invalidate the association.","operationId":"per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_config"}},"required":["config"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname_aop_response_collection"}}},"description":"Enable or Disable a Hostname for Client Authentication response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname_aop_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Enable or Disable a Hostname for Client Authentication response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Enable or Disable a Hostname for Client Authentication","tags":["Per-hostname Authenticated Origin Pull"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates":{"get":{"operationId":"per-hostname-authenticated-origin-pull-list-certificates","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_collection"}}},"description":"List Certificates response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"List Certificates response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Certificates","tags":["Per-hostname Authenticated Origin Pull"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed.","operationId":"per-hostname-authenticated-origin-pull-upload-a-hostname-client-certificate","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate"},"private_key":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-private_key"}},"required":["certificate","private_key"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_single"}}},"description":"Upload a Hostname Client Certificate response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Upload a Hostname Client Certificate response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Upload a Hostname Client Certificate","tags":["Per-hostname Authenticated Origin Pull"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}":{"delete":{"operationId":"per-hostname-authenticated-origin-pull-delete-hostname-client-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_single"}}},"description":"Delete Hostname Client Certificate response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Delete Hostname Client Certificate response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete Hostname Client Certificate","tags":["Per-hostname Authenticated Origin Pull"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get the certificate by ID to be used for client authentication on a hostname.","operationId":"per-hostname-authenticated-origin-pull-get-the-hostname-client-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_single"}}},"description":"Get the Hostname Client Certificate response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Get the Hostname Client Certificate response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get the Hostname Client Certificate","tags":["Per-hostname Authenticated Origin Pull"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/origin_tls_client_auth/hostnames/{hostname}":{"get":{"operationId":"per-hostname-authenticated-origin-pull-get-the-hostname-status-for-client-authentication","parameters":[{"in":"path","name":"hostname","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-hostname"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname_aop_single_response"}}},"description":"Get the Hostname Status for Client Authentication response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_hostname_aop_single_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Get the Hostname Status for Client Authentication response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get the Hostname Status for Client Authentication","tags":["Per-hostname Authenticated Origin Pull"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/origin_tls_client_auth/settings":{"get":{"description":"Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.","operationId":"zone-level-authenticated-origin-pulls-get-enablement-setting-for-zone","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_enabled_response"}}},"description":"Get Enablement Setting for Zone response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_enabled_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Get Enablement Setting for Zone response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Enablement Setting for Zone","tags":["Zone-Level Authenticated Origin Pulls"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.","operationId":"zone-level-authenticated-origin-pulls-set-enablement-for-zone","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"enabled":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled"}},"required":["enabled"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_enabled_response"}}},"description":"Set Enablement for Zone response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_enabled_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Set Enablement for Zone response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Set Enablement for Zone","tags":["Zone-Level Authenticated Origin Pulls"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/origin_tls_client_auth/{certificate_id}":{"delete":{"operationId":"zone-level-authenticated-origin-pulls-delete-certificate","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single"}}},"description":"Delete Certificate response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Delete Certificate response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete Certificate","tags":["Zone-Level Authenticated Origin Pulls"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"zone-level-authenticated-origin-pulls-get-certificate-details","parameters":[{"in":"path","name":"certificate_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single"}}},"description":"Get Certificate Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Get Certificate Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Certificate Details","tags":["Zone-Level Authenticated Origin Pulls"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/page_shield":{"get":{"description":"Fetches the Page Shield settings.","operationId":"page-shield-get-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-get-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/page-shield_get-zone-settings-response"}}}]}}},"description":"Get Page Shield settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_api-response-common-failure"}}},"description":"Get Page Shield settings response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Page Shield settings","tags":["Page Shield"],"x-api-token-group":["Page Shield","Domain Page Shield Read","Domain Page Shield","Page Shield Read","Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Updates Page Shield settings.","operationId":"page-shield-update-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"enabled":{"$ref":"#/components/schemas/page-shield_enabled"},"use_cloudflare_reporting_endpoint":{"$ref":"#/components/schemas/page-shield_use_cloudflare_reporting_endpoint"},"use_connection_url_path":{"$ref":"#/components/schemas/page-shield_use_connection_url_path"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/page-shield_zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/page-shield_update-zone-settings-response"}}}]}}},"description":"Update Page Shield settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_api-response-common-failure"}}},"description":"Update Page Shield settings response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update Page Shield settings","tags":["Page Shield"],"x-api-token-group":["Page Shield","Domain Page Shield","Zone Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/page_shield/connections":{"get":{"description":"Lists all connections detected by Page Shield.","operationId":"page-shield-list-connections","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}},{"in":"query","name":"exclude_urls","schema":{"description":"Excludes connections whose URL contains one of the URL-encoded URLs separated by commas.\n","example":"blog.cloudflare.com,www.example","type":"string"}},{"in":"query","name":"urls","schema":{"description":"Includes connections whose URL contain one or more URL-encoded URLs separated by commas.\n","example":"blog.cloudflare.com,www.example","type":"string"}},{"in":"query","name":"hosts","schema":{"description":"Includes connections that match one or more URL-encoded hostnames separated by commas.\n\nWildcards are supported at the start and end of each hostname to support starts with, ends with\nand contains. If no wildcards are used, results will be filtered by exact match\n","example":"blog.cloudflare.com,www.example*,*cloudflare.com","type":"string"}},{"in":"query","name":"page","schema":{"description":"The current page number of the paginated results.\n\nWe additionally support a special value \"all\". When \"all\" is used, the API will return all the connections\nwith the applied filters in a single page. This feature is best-effort and it may only work for zones with\na low number of connections\n","example":2,"type":"string"}},{"in":"query","name":"per_page","schema":{"description":"The number of results per page.","example":100,"maximum":100,"minimum":1,"type":"number"}},{"in":"query","name":"order_by","schema":{"description":"The field used to sort returned connections.","enum":["first_seen_at","last_seen_at"],"example":"first_seen_at","type":"string"}},{"in":"query","name":"direction","schema":{"description":"The direction used to sort returned connections.","enum":["asc","desc"],"example":"asc","type":"string"}},{"in":"query","name":"prioritize_malicious","schema":{"description":"When true, malicious connections appear first in the returned connections.","example":true,"type":"boolean"}},{"in":"query","name":"exclude_cdn_cgi","schema":{"description":"When true, excludes connections seen in a `/cdn-cgi` path from the returned connections. The default value is true.","example":true,"type":"boolean"}},{"in":"query","name":"status","schema":{"description":"Filters the returned connections using a comma-separated list of connection statuses. Accepted values: `active`, `infrequent`, and `inactive`. The default value is `active`.","example":"active,inactive","type":"string"}},{"in":"query","name":"page_url","schema":{"description":"Includes connections that match one or more page URLs (separated by commas) where they were last seen\n\nWildcards are supported at the start and end of each page URL to support starts with, ends with\nand contains. If no wildcards are used, results will be filtered by exact match\n","example":"example.com/page,*/checkout,example.com/*,*checkout*","type":"string"}},{"in":"query","name":"export","schema":{"description":"Export the list of connections as a file, limited to 50000 entries.","enum":["csv"],"example":"csv","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_list-zone-connections-response"}}},"description":"List Page Shield connections response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_api-response-common-failure"}}},"description":"List Page Shield connections response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Page Shield connections","tags":["Page Shield"],"x-api-token-group":["Page Shield","Domain Page Shield Read","Domain Page Shield","Page Shield Read","Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/page_shield/connections/{connection_id}":{"get":{"description":"Fetches a connection detected by Page Shield by connection ID.","operationId":"page-shield-get-connection","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}},{"in":"path","name":"connection_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_get-zone-connection-response"}}},"description":"Get a Page Shield connection response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_api-response-common-failure"}}},"description":"Get a Page Shield connection response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a Page Shield connection","tags":["Page Shield"],"x-api-token-group":["Page Shield","Domain Page Shield Read","Domain Page Shield","Page Shield Read","Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/page_shield/cookies":{"get":{"description":"Lists all cookies collected by Page Shield.","operationId":"page-shield-list-cookies","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}},{"in":"query","name":"hosts","schema":{"description":"Includes cookies that match one or more URL-encoded hostnames separated by commas.\n\nWildcards are supported at the start and end of each hostname to support starts with, ends with\nand contains. If no wildcards are used, results will be filtered by exact match\n","example":"blog.cloudflare.com,www.example*,*cloudflare.com","type":"string"}},{"in":"query","name":"page","schema":{"description":"The current page number of the paginated results.\n\nWe additionally support a special value \"all\". When \"all\" is used, the API will return all the cookies\nwith the applied filters in a single page. This feature is best-effort and it may only work for zones with \na low number of cookies\n","example":2,"type":"string"}},{"in":"query","name":"per_page","schema":{"description":"The number of results per page.","example":100,"maximum":100,"minimum":1,"type":"number"}},{"in":"query","name":"order_by","schema":{"description":"The field used to sort returned cookies.","enum":["first_seen_at","last_seen_at"],"example":"first_seen_at","type":"string"}},{"in":"query","name":"direction","schema":{"description":"The direction used to sort returned cookies.'","enum":["asc","desc"],"example":"asc","type":"string"}},{"in":"query","name":"page_url","schema":{"description":"Includes connections that match one or more page URLs (separated by commas) where they were last seen\n\nWildcards are supported at the start and end of each page URL to support starts with, ends with\nand contains. If no wildcards are used, results will be filtered by exact match\n","example":"example.com/page,*/checkout,example.com/*,*checkout*","type":"string"}},{"in":"query","name":"export","schema":{"description":"Export the list of cookies as a file, limited to 50000 entries.","enum":["csv"],"example":"csv","type":"string"}},{"in":"query","name":"name","schema":{"description":"Filters the returned cookies that match the specified name.\nWildcards are supported at the start and end to support starts with, ends with\nand contains. e.g. session*\n","example":"session_id","maxLength":1024,"type":"string"}},{"in":"query","name":"secure","schema":{"description":"Filters the returned cookies that are set with Secure","example":true,"type":"boolean"}},{"in":"query","name":"http_only","schema":{"description":"Filters the returned cookies that are set with HttpOnly","example":true,"type":"boolean"}},{"in":"query","name":"same_site","schema":{"description":"Filters the returned cookies that match the specified same_site attribute","enum":["lax","strict","none"],"example":"strict","type":"string"}},{"in":"query","name":"type","schema":{"description":"Filters the returned cookies that match the specified type attribute","enum":["first_party","unknown"],"example":"first_party","type":"string"}},{"in":"query","name":"path","schema":{"description":"Filters the returned cookies that match the specified path attribute","example":"/","maxLength":1024,"type":"string"}},{"in":"query","name":"domain","schema":{"description":"Filters the returned cookies that match the specified domain attribute","example":"example.com","maxLength":1024,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_list-zone-cookies-response"}}},"description":"List Page Shield cookies response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_api-response-common-failure"}}},"description":"List Page Shield cookies response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Page Shield Cookies","tags":["Page Shield"],"x-api-token-group":["Page Shield","Domain Page Shield Read","Domain Page Shield","Page Shield Read","Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/page_shield/cookies/{cookie_id}":{"get":{"description":"Fetches a cookie collected by Page Shield by cookie ID.","operationId":"page-shield-get-cookie","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}},{"in":"path","name":"cookie_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_get-zone-cookie-response"}}},"description":"Get a Page Shield cookie response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_api-response-common-failure"}}},"description":"Get a Page Shield cookie response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a Page Shield cookie","tags":["Page Shield"],"x-api-token-group":["Page Shield","Domain Page Shield Read","Domain Page Shield","Page Shield Read","Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/page_shield/policies":{"get":{"description":"Lists all Page Shield policies.","operationId":"page-shield-list-policies","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_list-zone-policies-response"}}},"description":"List Page Shield policies response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_api-response-common-failure"}}},"description":"List Page Shield policies response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Page Shield policies","tags":["Page Shield"],"x-api-token-group":["Page Shield","Domain Page Shield Read","Domain Page Shield","Page Shield Read","Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"post":{"description":"Create a Page Shield policy.","operationId":"page-shield-create-policy","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_policy"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_get-zone-policy-response"}}},"description":"Create a Page Shield policy response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_api-response-common-failure"}}},"description":"Create a Page Shield policy response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Create a Page Shield policy","tags":["Page Shield"],"x-api-token-group":["Page Shield","Domain Page Shield","Zone Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/page_shield/policies/{policy_id}":{"delete":{"description":"Delete a Page Shield policy by ID.","operationId":"page-shield-delete-policy","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}},{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}}],"responses":{"204":{"description":"Delete a Page Shield policy response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_api-response-common-failure"}}},"description":"Delete a Page Shield policy response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete a Page Shield policy","tags":["Page Shield"],"x-api-token-group":["Page Shield","Domain Page Shield","Zone Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Fetches a Page Shield policy by ID.","operationId":"page-shield-get-policy","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}},{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_get-zone-policy-response"}}},"description":"Get a Page Shield policy response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_api-response-common-failure"}}},"description":"Get a Page Shield policy response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a Page Shield policy","tags":["Page Shield"],"x-api-token-group":["Page Shield","Domain Page Shield Read","Domain Page Shield","Page Shield Read","Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Update a Page Shield policy by ID.","operationId":"page-shield-update-policy","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}},{"in":"path","name":"policy_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"$ref":"#/components/schemas/page-shield_policy-action"},"description":{"$ref":"#/components/schemas/page-shield_policy-description"},"enabled":{"$ref":"#/components/schemas/page-shield_policy-enabled"},"expression":{"$ref":"#/components/schemas/page-shield_policy-expression"},"value":{"$ref":"#/components/schemas/page-shield_policy-value"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_get-zone-policy-response"}}},"description":"Update a Page Shield policy response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_api-response-common-failure"}}},"description":"Update a Page Shield policy response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Update a Page Shield policy","tags":["Page Shield"],"x-api-token-group":["Page Shield","Domain Page Shield","Zone Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/page_shield/scripts":{"get":{"description":"Lists all scripts detected by Page Shield.","operationId":"page-shield-list-scripts","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}},{"in":"query","name":"exclude_urls","schema":{"description":"Excludes scripts whose URL contains one of the URL-encoded URLs separated by commas.\n","example":"blog.cloudflare.com,www.example","type":"string"}},{"in":"query","name":"urls","schema":{"description":"Includes scripts whose URL contain one or more URL-encoded URLs separated by commas.\n","example":"blog.cloudflare.com,www.example","type":"string"}},{"in":"query","name":"hosts","schema":{"description":"Includes scripts that match one or more URL-encoded hostnames separated by commas.\n\nWildcards are supported at the start and end of each hostname to support starts with, ends with\nand contains. If no wildcards are used, results will be filtered by exact match\n","example":"blog.cloudflare.com,www.example*,*cloudflare.com","type":"string"}},{"in":"query","name":"page","schema":{"description":"The current page number of the paginated results.\n\nWe additionally support a special value \"all\". When \"all\" is used, the API will return all the scripts\nwith the applied filters in a single page. This feature is best-effort and it may only work for zones with \na low number of scripts\n","example":2,"type":"string"}},{"in":"query","name":"per_page","schema":{"description":"The number of results per page.","example":100,"maximum":100,"minimum":1,"type":"number"}},{"in":"query","name":"order_by","schema":{"description":"The field used to sort returned scripts.","enum":["first_seen_at","last_seen_at"],"example":"first_seen_at","type":"string"}},{"in":"query","name":"direction","schema":{"description":"The direction used to sort returned scripts.","enum":["asc","desc"],"example":"asc","type":"string"}},{"in":"query","name":"prioritize_malicious","schema":{"description":"When true, malicious scripts appear first in the returned scripts.","example":true,"type":"boolean"}},{"in":"query","name":"exclude_cdn_cgi","schema":{"default":true,"description":"When true, excludes scripts seen in a `/cdn-cgi` path from the returned scripts. The default value is true.","example":true,"type":"boolean"}},{"in":"query","name":"exclude_duplicates","schema":{"default":true,"description":"When true, excludes duplicate scripts. We consider a script duplicate of another if their javascript\ncontent matches and they share the same url host and zone hostname. In such case, we return the most\nrecent script for the URL host and zone hostname combination.\n","example":true,"type":"boolean"}},{"in":"query","name":"status","schema":{"description":"Filters the returned scripts using a comma-separated list of scripts statuses. Accepted values: `active`, `infrequent`, and `inactive`. The default value is `active`.","example":"active,inactive","type":"string"}},{"in":"query","name":"page_url","schema":{"description":"Includes scripts that match one or more page URLs (separated by commas) where they were last seen\n\nWildcards are supported at the start and end of each page URL to support starts with, ends with\nand contains. If no wildcards are used, results will be filtered by exact match\n","example":"example.com/page,*/checkout,example.com/*,*checkout*","type":"string"}},{"in":"query","name":"export","schema":{"description":"Export the list of scripts as a file, limited to 50000 entries.","enum":["csv"],"example":"csv","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_list-zone-scripts-response"}}},"description":"List Page Shield scripts response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_api-response-common-failure"}}},"description":"List Page Shield scripts response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Page Shield scripts","tags":["Page Shield"],"x-api-token-group":["Page Shield","Domain Page Shield Read","Domain Page Shield","Page Shield Read","Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/page_shield/scripts/{script_id}":{"get":{"description":"Fetches a script detected by Page Shield by script ID.","operationId":"page-shield-get-script","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}},{"in":"path","name":"script_id","required":true,"schema":{"$ref":"#/components/schemas/page-shield_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/page-shield_get-zone-script-response"}}},"description":"Get a Page Shield script response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/page-shield_api-response-common-failure"}]}}},"description":"Get a Page Shield script response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get a Page Shield script","tags":["Page Shield"],"x-api-token-group":["Page Shield","Domain Page Shield Read","Domain Page Shield","Page Shield Read","Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/pagerules":{"get":{"description":"Fetches Page Rules in a zone.","operationId":"page-rules-list-page-rules","parameters":[{"example":"023e105f4ecef8ad9ca31a8372d0c353","in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}},{"in":"query","name":"order","schema":{"default":"priority","description":"The field used to sort returned Page Rules.","enum":["status","priority"],"example":"status","type":"string"}},{"in":"query","name":"direction","schema":{"default":"desc","description":"The direction used to sort returned Page Rules.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.","enum":["any","all"],"type":"string"}},{"in":"query","name":"status","schema":{"default":"disabled","description":"The status of the Page Rule.","enum":["active","disabled"],"example":"active","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/zones_page_rule"},"type":"array"}}}]}}},"description":"List Page Rules response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_schemas-api-response-common-failure"}}},"description":"List Page Rules response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Page Rules","tags":["Page Rules"],"x-api-token-group":["Zone Read","Zone Write","Page Rules Write","Page Rules Read"]},"post":{"description":"Creates a new Page Rule.","operationId":"page-rules-create-a-page-rule","parameters":[{"example":"023e105f4ecef8ad9ca31a8372d0c353","in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"actions":{"$ref":"#/components/schemas/zones_actions"},"priority":{"$ref":"#/components/schemas/zones_priority"},"status":{"$ref":"#/components/schemas/zones_status"},"targets":{"$ref":"#/components/schemas/zones_targets"}},"required":["targets","actions"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zones_page_rule"}}}]}}},"description":"Create a Page Rule response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_schemas-api-response-common-failure"}}},"description":"Create a Page Rule response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a Page Rule","tags":["Page Rules"],"x-api-token-group":["Zone Write","Page Rules Write"]}},"/zones/{zone_id}/pagerules/settings":{"get":{"deprecated":true,"description":"Returns a list of settings (and their details) that Page Rules can apply to matching requests.","operationId":"available-page-rules-settings-list-available-page-rules-settings","parameters":[{"example":"023e105f4ecef8ad9ca31a8372d0c353","in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_schemas-api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/zones_settings"}}}]}}},"description":"List available Page Rules settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_schemas-api-response-common-failure"}}},"description":"List available Page Rules settings response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List available Page Rules settings","tags":["Available Page Rules settings"],"x-api-token-group":["Zone Read","Zone Write","Page Rules Write","Page Rules Read"]}},"/zones/{zone_id}/pagerules/{pagerule_id}":{"delete":{"description":"Deletes an existing Page Rule.","operationId":"page-rules-delete-a-page-rule","parameters":[{"example":"023e105f4ecef8ad9ca31a8372d0c353","in":"path","name":"pagerule_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}},{"example":"023e105f4ecef8ad9ca31a8372d0c353","in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_schemas-api-response-single-id"}}},"description":"Delete a Page Rule response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_schemas-api-response-common-failure"}}},"description":"Delete a Page Rule response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a Page Rule","tags":["Page Rules"],"x-api-token-group":["Zone Write","Page Rules Write"]},"get":{"description":"Fetches the details of a Page Rule.","operationId":"page-rules-get-a-page-rule","parameters":[{"example":"023e105f4ecef8ad9ca31a8372d0c353","in":"path","name":"pagerule_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}},{"example":"023e105f4ecef8ad9ca31a8372d0c353","in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zones_page_rule"}}}]}}},"description":"Get a Page Rule response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_schemas-api-response-common-failure"}}},"description":"Get a Page Rule response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get a Page Rule","tags":["Page Rules"],"x-api-token-group":["Trust and Safety Write","Trust and Safety Read","Zero Trust: PII Read","Zaraz Edit","Zaraz Read","Zaraz Admin","Access: Apps and Policies Revoke","Access: Apps and Policies Write","Access: Apps and Policies Read","Access: Apps and Policies Revoke","Access: Mutual TLS Certificates Write","Access: Organizations, Identity Providers, and Groups Write","Zone Settings Write","Zone Settings Read","Zone Read","DNS Read","Workers Scripts Write","Workers Scripts Read","Zone Write","Workers Routes Write","Workers Routes Read","Stream Write","Stream Read","SSL and Certificates Write","SSL and Certificates Read","Logs Write","Logs Read","Cache Purge","Page Rules Write","Page Rules Read","Load Balancers Write","Load Balancers Read","Firewall Services Write","Firewall Services Read","DNS Write","Apps Write","Analytics Read","Access: Apps and Policies Write","Access: Apps and Policies Read"]},"patch":{"description":"Updates one or more fields of an existing Page Rule.","operationId":"page-rules-edit-a-page-rule","parameters":[{"example":"023e105f4ecef8ad9ca31a8372d0c353","in":"path","name":"pagerule_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}},{"example":"023e105f4ecef8ad9ca31a8372d0c353","in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"actions":{"$ref":"#/components/schemas/zones_actions"},"priority":{"$ref":"#/components/schemas/zones_priority"},"status":{"$ref":"#/components/schemas/zones_status"},"targets":{"$ref":"#/components/schemas/zones_targets"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zones_page_rule"}}}]}}},"description":"Edit a Page Rule response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_schemas-api-response-common-failure"}}},"description":"Edit a Page Rule response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Edit a Page Rule","tags":["Page Rules"],"x-api-token-group":["Zone Write","Page Rules Write"]},"put":{"description":"Replaces the configuration of an existing Page Rule. The configuration of the updated Page Rule will exactly match the data passed in the API request.","operationId":"page-rules-update-a-page-rule","parameters":[{"example":"023e105f4ecef8ad9ca31a8372d0c353","in":"path","name":"pagerule_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}},{"example":"023e105f4ecef8ad9ca31a8372d0c353","in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"actions":{"$ref":"#/components/schemas/zones_actions"},"priority":{"$ref":"#/components/schemas/zones_priority"},"status":{"$ref":"#/components/schemas/zones_status"},"targets":{"$ref":"#/components/schemas/zones_targets"}},"required":["targets","actions"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zones_page_rule"}}}]}}},"description":"Update a Page Rule response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_schemas-api-response-common-failure"}}},"description":"Update a Page Rule response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update a Page Rule","tags":["Page Rules"],"x-api-token-group":["Zone Write","Page Rules Write"]}},"/zones/{zone_id}/pay-per-crawl/configuration":{"get":{"description":"Gets the pay-per-crawl config for a zone including the bot configuration.","operationId":"pay-per-crawl.getConfig","parameters":[{"description":"zone id","in":"path","name":"zone_id","required":true,"schema":{"type":"string"},"x-auditable":true}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_getConfigResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiErrorResponse"}}},"description":"Bad Request"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get the pay-per-crawl config","tags":["ppc_config"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"]},"patch":{"description":"Changes the pay-per-crawl config for a zone.","operationId":"pay-per-crawl.patchConfig","parameters":[{"description":"zone id","in":"path","name":"zone_id","required":true,"schema":{"type":"string"},"x-auditable":true}],"requestBody":{"$ref":"#/components/requestBodies/pay-per-crawl_DaricConfig"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_getConfigResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiErrorResponse"}}},"description":"Bad Request"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Changes pay-per-crawl config for a zone","tags":["ppc_config"],"x-api-token-group":["Zone Settings Write"]},"post":{"description":"Creates the pay-per-crawl config for a zone.","operationId":"pay-per-crawl.createConfig","parameters":[{"description":"zone id","in":"path","name":"zone_id","required":true,"schema":{"type":"string"},"x-auditable":true}],"requestBody":{"$ref":"#/components/requestBodies/pay-per-crawl_DaricConfig"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_getConfigResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-per-crawl_apiErrorResponse"}}},"description":"Bad Request"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Creates pay-per-crawl config for a zone","tags":["ppc_config"],"x-api-token-group":["Zone Settings Write"]}},"/zones/{zone_id}/purge_cache":{"post":{"description":"### Purge All Cached Content\nRemoves ALL files from Cloudflare's cache. All tiers can purge everything.\n```\n{\"purge_everything\": true}\n```\n\n### Purge Cached Content by URL\nGranularly removes one or more files from Cloudflare's cache by specifying URLs. All tiers can purge by URL.\n\nTo purge files with custom cache keys, include the headers used to compute the cache key as in the example. If you have a device type or geo in your cache key, you will need to include the CF-Device-Type or CF-IPCountry headers. If you have lang in your cache key, you will need to include the Accept-Language header.\n\n**NB:** When including the Origin header, be sure to include the **scheme** and **hostname**. The port number can be omitted if it is the default port (80 for http, 443 for https), but must be included otherwise.\n\nSingle file purge example with files:\n```\n{\"files\": [\"http://www.example.com/css/styles.css\", \"http://www.example.com/js/index.js\"]}\n```\nSingle file purge example with url and header pairs:\n```\n{\"files\": [{url: \"http://www.example.com/cat_picture.jpg\", headers: { \"CF-IPCountry\": \"US\", \"CF-Device-Type\": \"desktop\", \"Accept-Language\": \"zh-CN\" }}, {url: \"http://www.example.com/dog_picture.jpg\", headers: { \"CF-IPCountry\": \"EU\", \"CF-Device-Type\": \"mobile\", \"Accept-Language\": \"en-US\" }}]}\n```\n\n### Purge Cached Content by Tag, Host or Prefix\nGranularly removes one or more files from Cloudflare's cache either by specifying the host, the associated Cache-Tag, or a Prefix.\n\nFlex purge with tags:\n```\n{\"tags\": [\"a-cache-tag\", \"another-cache-tag\"]}\n```\nFlex purge with hosts:\n```\n{\"hosts\": [\"www.example.com\", \"images.example.com\"]}\n```\nFlex purge with prefixes:\n```\n{\"prefixes\": [\"www.example.com/foo\", \"images.example.com/bar/baz\"]}\n```\n\n### Availability and limits\nplease refer to [purge cache availability and limits documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/#availability-and-limits).\n","operationId":"zone-purge","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-purge_identifier"}}],"requestBody":{"content":{"application/json":{"examples":{"Flex Purge with Hosts":{"summary":"Flex purge example with hosts list","value":{"hosts":["www.example.com","images.example.com"]}},"Flex Purge with Prefixes":{"summary":"Flex purge example with prefixes list","value":{"prefixes":["www.example.com/foo","images.example.com/bar/baz"]}},"Flex Purge with Tags":{"summary":"Flex purge example with tags list","value":{"tags":["a-cache-tag","another-cache-tag"]}},"Purge Everything":{"summary":"Purge everything example","value":{"purge_everything":true}},"Single File Purge":{"summary":"Single file purge example with files list","value":{"files":["http://www.example.com/css/styles.css","http://www.example.com/js/index.js"]}},"Single File Purge with UrlAndHeaders":{"summary":"Single file purge example with url and headers list","value":{"files":[{"headers":{"Accept-Language":"zh-CN","CF-Device-Type":"desktop","CF-IPCountry":"US"},"url":"http://www.example.com/cat_picture.jpg"},{"headers":{"Accept-Language":"en-US","CF-Device-Type":"mobile","CF-IPCountry":"EU"},"url":"http://www.example.com/dog_picture.jpg"}]}}},"schema":{"anyOf":[{"$ref":"#/components/schemas/cache-purge_FlexPurgeByTags"},{"$ref":"#/components/schemas/cache-purge_FlexPurgeByHostnames"},{"$ref":"#/components/schemas/cache-purge_FlexPurgeByPrefixes"},{"$ref":"#/components/schemas/cache-purge_Everything"},{"$ref":"#/components/schemas/cache-purge_SingleFile"},{"$ref":"#/components/schemas/cache-purge_SingleFileWithUrlAndHeaders"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-purge_api-response-single-id"}}},"description":"Request to purge cached content successfull."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-purge_api-response-single-id"},{"$ref":"#/components/schemas/cache-purge_api-response-common-failure"}]}}},"description":"Request to purge cached content failed."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Purge Cached Content","tags":["Zone"],"x-api-token-group":["Cache Purge"],"x-cfPermissionsRequired":{"enum":["#cache_purge:edit"]}}},"/zones/{zone_id}/rate_limits":{"get":{"deprecated":true,"description":"Fetches the rate limits for a zone.","operationId":"rate-limits-for-a-zone-list-rate-limits","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Defines the page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Defines the maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.","maximum":1000,"minimum":1,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_ratelimit_response_collection"}}},"description":"List rate limits response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_ratelimit_response_collection"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"List rate limits response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List rate limits","tags":["Rate limits for a zone"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"deprecated":true,"description":"Creates a new rate limit for a zone. Refer to the object definition for a list of required attributes.","operationId":"rate-limits-for-a-zone-create-a-rate-limit","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"$ref":"#/components/schemas/firewall_action"},"match":{"$ref":"#/components/schemas/firewall_match"},"period":{"$ref":"#/components/schemas/firewall_period"},"threshold":{"$ref":"#/components/schemas/firewall_threshold"}},"required":["match","threshold","period","action"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_ratelimit_response_single"}}},"description":"Create a rate limit response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_ratelimit_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Create a rate limit response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create a rate limit","tags":["Rate limits for a zone"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rate_limits/{rate_limit_id}":{"delete":{"deprecated":true,"description":"Deletes an existing rate limit.","operationId":"rate-limits-for-a-zone-delete-a-rate-limit","parameters":[{"in":"path","name":"rate_limit_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_rate_limit_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_ratelimit_response_single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/firewall_id"}},"type":"object"}},"type":"object"}]}}},"description":"Delete a rate limit response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/firewall_ratelimit_response_single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/firewall_id"}},"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Delete a rate limit response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete a rate limit","tags":["Rate limits for a zone"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"deprecated":true,"description":"Fetches the details of a rate limit.","operationId":"rate-limits-for-a-zone-get-a-rate-limit","parameters":[{"in":"path","name":"rate_limit_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_rate_limit_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_ratelimit_response_single"}}},"description":"Get a rate limit response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_ratelimit_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Get a rate limit response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get a rate limit","tags":["Rate limits for a zone"],"x-api-token-group":["Firewall Services Write","Firewall Services Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"deprecated":true,"description":"Updates an existing rate limit.","operationId":"rate-limits-for-a-zone-update-a-rate-limit","parameters":[{"in":"path","name":"rate_limit_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_rate_limit_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/firewall_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"$ref":"#/components/schemas/firewall_action"},"match":{"$ref":"#/components/schemas/firewall_match"},"period":{"$ref":"#/components/schemas/firewall_period"},"threshold":{"$ref":"#/components/schemas/firewall_threshold"}},"required":["match","threshold","period","action"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewall_ratelimit_response_single"}}},"description":"Update a rate limit response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewall_ratelimit_response_single"},{"$ref":"#/components/schemas/firewall_api-response-common-failure"}]}}},"description":"Update a rate limit response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update a rate limit","tags":["Rate limits for a zone"],"x-api-token-group":["Firewall Services Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets":{"get":{"description":"Fetches all rulesets at the zone level.","operationId":"listZoneRulesets","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}},{"in":"query","name":"cursor","schema":{"$ref":"#/components/schemas/rulesets_Cursor"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/rulesets_PerPage"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Rulesets"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List zone rulesets","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Response Compression Read","Config Settings Write","Config Settings Read","Dynamic URL Redirects Write","Dynamic URL Redirects Read","Cache Settings Write","Cache Settings Read","Custom Errors Write","Custom Errors Read","Origin Write","Origin Read","Managed headers Write","Managed headers Read","Zone Transform Rules Write","Zone Transform Rules Read","Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","HTTP DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Read","Sanitize Write","Sanitize Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Bot Management Write","Bot Management Read","Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a ruleset at the zone level.","operationId":"createZoneRuleset","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"requestBody":{"$ref":"#/components/requestBodies/rulesets_CreateRuleset"},"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Create a zone ruleset","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Config Settings Write","Dynamic URL Redirects Write","Cache Settings Write","Custom Errors Write","Origin Write","Managed headers Write","Zone Transform Rules Write","Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Write","Sanitize Write","Transform Rules Write","Select Configuration Write","Bot Management Write","Zone WAF Write","Account WAF Write","Account Rulesets Write","Logs Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint":{"get":{"description":"Fetches the latest version of the zone entry point ruleset for a given phase.","operationId":"getZoneEntrypointRuleset","parameters":[{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetPhase"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get a zone entry point ruleset","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Response Compression Read","Config Settings Write","Config Settings Read","Dynamic URL Redirects Write","Dynamic URL Redirects Read","Cache Settings Write","Cache Settings Read","Custom Errors Write","Custom Errors Read","Origin Write","Origin Read","Managed headers Write","Managed headers Read","Zone Transform Rules Write","Zone Transform Rules Read","Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","HTTP DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Read","Sanitize Write","Sanitize Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Bot Management Write","Bot Management Read","Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates a zone entry point ruleset, creating a new version.","operationId":"updateZoneEntrypointRuleset","parameters":[{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetPhase"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"requestBody":{"$ref":"#/components/requestBodies/rulesets_UpdateEntrypointRuleset"},"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update a zone entry point ruleset","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Config Settings Write","Dynamic URL Redirects Write","Cache Settings Write","Custom Errors Write","Origin Write","Managed headers Write","Zone Transform Rules Write","Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Write","Sanitize Write","Transform Rules Write","Select Configuration Write","Bot Management Write","Zone WAF Write","Account WAF Write","Account Rulesets Write","Logs Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions":{"get":{"description":"Fetches the versions of a zone entry point ruleset.","operationId":"listZoneEntrypointRulesetVersions","parameters":[{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetPhase"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Rulesets"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List a zone entry point ruleset's versions","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Response Compression Read","Config Settings Write","Config Settings Read","Dynamic URL Redirects Write","Dynamic URL Redirects Read","Cache Settings Write","Cache Settings Read","Custom Errors Write","Custom Errors Read","Origin Write","Origin Read","Managed headers Write","Managed headers Read","Zone Transform Rules Write","Zone Transform Rules Read","Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","HTTP DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Read","Sanitize Write","Sanitize Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Bot Management Write","Bot Management Read","Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}":{"get":{"description":"Fetches a specific version of a zone entry point ruleset.","operationId":"getZoneEntrypointRulesetVersion","parameters":[{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetVersion"}},{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetPhase"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get a zone entry point ruleset version","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Response Compression Read","Config Settings Write","Config Settings Read","Dynamic URL Redirects Write","Dynamic URL Redirects Read","Cache Settings Write","Cache Settings Read","Custom Errors Write","Custom Errors Read","Origin Write","Origin Read","Managed headers Write","Managed headers Read","Zone Transform Rules Write","Zone Transform Rules Read","Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","HTTP DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Read","Sanitize Write","Sanitize Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Bot Management Write","Bot Management Read","Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/{ruleset_id}":{"delete":{"description":"Deletes all versions of an existing zone ruleset.","operationId":"deleteZoneRuleset","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"204":{"$ref":"#/components/responses/rulesets_Empty"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a zone ruleset","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Config Settings Write","Dynamic URL Redirects Write","Cache Settings Write","Custom Errors Write","Origin Write","Managed headers Write","Zone Transform Rules Write","Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Write","Sanitize Write","Transform Rules Write","Select Configuration Write","Bot Management Write","Zone WAF Write","Account WAF Write","Account Rulesets Write","Logs Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the latest version of a zone ruleset.","operationId":"getZoneRuleset","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get a zone ruleset","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Response Compression Read","Config Settings Write","Config Settings Read","Dynamic URL Redirects Write","Dynamic URL Redirects Read","Cache Settings Write","Cache Settings Read","Custom Errors Write","Custom Errors Read","Origin Write","Origin Read","Managed headers Write","Managed headers Read","Zone Transform Rules Write","Zone Transform Rules Read","Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","HTTP DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Read","Sanitize Write","Sanitize Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Bot Management Write","Bot Management Read","Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates a zone ruleset, creating a new version.","operationId":"updateZoneRuleset","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"requestBody":{"$ref":"#/components/requestBodies/rulesets_UpdateRuleset"},"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update a zone ruleset","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Config Settings Write","Dynamic URL Redirects Write","Cache Settings Write","Custom Errors Write","Origin Write","Managed headers Write","Zone Transform Rules Write","Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Write","Sanitize Write","Transform Rules Write","Select Configuration Write","Bot Management Write","Zone WAF Write","Account WAF Write","Account Rulesets Write","Logs Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/{ruleset_id}/rules":{"post":{"description":"Adds a new rule to a zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default.","operationId":"createZoneRulesetRule","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"requestBody":{"$ref":"#/components/requestBodies/rulesets_Rule"},"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Create a zone ruleset rule","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Config Settings Write","Dynamic URL Redirects Write","Cache Settings Write","Custom Errors Write","Origin Write","Managed headers Write","Zone Transform Rules Write","Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Write","Sanitize Write","Transform Rules Write","Select Configuration Write","Bot Management Write","Zone WAF Write","Account WAF Write","Account Rulesets Write","Logs Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}":{"delete":{"description":"Deletes an existing rule from a zone ruleset.","operationId":"deleteZoneRulesetRule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RuleId"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a zone ruleset rule","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Config Settings Write","Dynamic URL Redirects Write","Cache Settings Write","Custom Errors Write","Origin Write","Managed headers Write","Zone Transform Rules Write","Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Write","Sanitize Write","Transform Rules Write","Select Configuration Write","Bot Management Write","Zone WAF Write","Account WAF Write","Account Rulesets Write","Logs Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates an existing rule in a zone ruleset.","operationId":"updateZoneRulesetRule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RuleId"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"requestBody":{"$ref":"#/components/requestBodies/rulesets_Rule"},"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update a zone ruleset rule","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Config Settings Write","Dynamic URL Redirects Write","Cache Settings Write","Custom Errors Write","Origin Write","Managed headers Write","Zone Transform Rules Write","Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Write","Sanitize Write","Transform Rules Write","Select Configuration Write","Bot Management Write","Zone WAF Write","Account WAF Write","Account Rulesets Write","Logs Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/{ruleset_id}/versions":{"get":{"description":"Fetches the versions of a zone ruleset.","operationId":"listZoneRulesetVersions","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Rulesets"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List a zone ruleset's versions","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Response Compression Read","Config Settings Write","Config Settings Read","Dynamic URL Redirects Write","Dynamic URL Redirects Read","Cache Settings Write","Cache Settings Read","Custom Errors Write","Custom Errors Read","Origin Write","Origin Read","Managed headers Write","Managed headers Read","Zone Transform Rules Write","Zone Transform Rules Read","Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","HTTP DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Read","Sanitize Write","Sanitize Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Bot Management Write","Bot Management Read","Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}":{"delete":{"description":"Deletes an existing version of a zone ruleset.","operationId":"deleteZoneRulesetVersion","parameters":[{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetVersion"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"204":{"$ref":"#/components/responses/rulesets_Empty"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a zone ruleset version","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Config Settings Write","Dynamic URL Redirects Write","Cache Settings Write","Custom Errors Write","Origin Write","Managed headers Write","Zone Transform Rules Write","Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Write","Sanitize Write","Transform Rules Write","Select Configuration Write","Bot Management Write","Zone WAF Write","Account WAF Write","Account Rulesets Write","Logs Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches a specific version of a zone ruleset.","operationId":"getZoneRulesetVersion","parameters":[{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetVersion"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get a zone ruleset version","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Response Compression Read","Config Settings Write","Config Settings Read","Dynamic URL Redirects Write","Dynamic URL Redirects Read","Cache Settings Write","Cache Settings Read","Custom Errors Write","Custom Errors Read","Origin Write","Origin Read","Managed headers Write","Managed headers Read","Zone Transform Rules Write","Zone Transform Rules Read","Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","HTTP DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Read","Sanitize Write","Sanitize Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Bot Management Write","Bot Management Read","Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}":{"get":{"description":"Fetches the rules of a managed zone ruleset version for a given tag.","operationId":"listZoneRulesetVersionRulesByTag","parameters":[{"in":"path","name":"rule_tag","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RuleCategory"}},{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetVersion"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_RulesetId"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_Ruleset"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List a zone ruleset version's rules by tag","tags":["Zone Rulesets"],"x-api-token-group":["Response Compression Write","Response Compression Read","Config Settings Write","Config Settings Read","Dynamic URL Redirects Write","Dynamic URL Redirects Read","Cache Settings Write","Cache Settings Read","Custom Errors Write","Custom Errors Read","Origin Write","Origin Read","Managed headers Write","Managed headers Read","Zone Transform Rules Write","Zone Transform Rules Read","Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","HTTP DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Read","Sanitize Write","Sanitize Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Bot Management Write","Bot Management Read","Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/schema_validation/schemas":{"get":{"operationId":"schema-validation-list-schemas-paginated","parameters":[{"$ref":"#/components/parameters/api-shield_page"},{"$ref":"#/components/parameters/api-shield_per_page"},{"$ref":"#/components/parameters/api-shield_omit_source_query"},{"description":"Filter for enabled schemas","in":"query","name":"validation_enabled","schema":{"description":"Flag whether schema is enabled for validation.","type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/api-shield_schemas_list_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List all uploaded schemas","tags":["Schema Validation"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"post":{"operationId":"schema-validation-create-schema","requestBody":{"$ref":"#/components/requestBodies/api-shield_schema_create"},"responses":{"200":{"$ref":"#/components/responses/api-shield_schema_create_success"},"4XX":{"$ref":"#/components/responses/api-shield_schema_create_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Upload a schema","tags":["Schema Validation"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/schema_validation/schemas/hosts":{"get":{"operationId":"schema-validation-list-schema-hosts","parameters":[{"$ref":"#/components/parameters/api-shield_page"},{"$ref":"#/components/parameters/api-shield_per_page"}],"responses":{"200":{"$ref":"#/components/responses/api-shield_schema_hosts_get_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List hosts covered by uploaded schemas","tags":["Schema Validation"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}]},"/zones/{zone_id}/schema_validation/schemas/{schema_id}":{"delete":{"operationId":"schema-validation-delete-schema","responses":{"200":{"$ref":"#/components/responses/api-shield_schema_delete_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a schema","tags":["Schema Validation"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]},"get":{"operationId":"schema-validation-get-schema","parameters":[{"$ref":"#/components/parameters/api-shield_omit_source_query"}],"responses":{"200":{"$ref":"#/components/responses/api-shield_schema_get_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get details of a schema","tags":["Schema Validation"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"},{"$ref":"#/components/parameters/api-shield_schema_id_path"}],"patch":{"operationId":"schema-validation-edit-schema","requestBody":{"$ref":"#/components/requestBodies/api-shield_schema_edit"},"responses":{"200":{"$ref":"#/components/responses/api-shield_schema_edit_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Edit details of a schema to enable validation","tags":["Schema Validation"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/schema_validation/schemas/{schema_id}/operations":{"get":{"description":"Retrieves all operations from the schema. Operations that already exist in API Shield Endpoint Management will be returned as full operations.","operationId":"schema-validation-extract-operations-from-schema","parameters":[{"$ref":"#/components/parameters/api-shield_operation_feature_parameter"},{"$ref":"#/components/parameters/api-shield_host_parameter"},{"$ref":"#/components/parameters/api-shield_method_parameter"},{"$ref":"#/components/parameters/api-shield_endpoint_parameter"},{"$ref":"#/components/parameters/api-shield_page"},{"$ref":"#/components/parameters/api-shield_per_page"},{"description":"Filter results by whether operations exist in Web Asset Management or not. `new` will just return operations from the schema that do not exist otherwise. `existing` will just return operations from the schema that already exist.","in":"query","name":"operation_status","schema":{"enum":["new","existing"],"example":"new","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/api-shield_schemas_extract_operations_get_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Retrieve all operations from the schema.","tags":["Schema Validation"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"},{"$ref":"#/components/parameters/api-shield_schema_id_path"}]},"/zones/{zone_id}/schema_validation/settings":{"get":{"operationId":"schema-validation-get-settings","responses":{"200":{"$ref":"#/components/responses/api-shield_global_settings_get_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get global schema validation settings","tags":["Schema Validation Settings"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"patch":{"operationId":"schema-validation-edit-settings","requestBody":{"$ref":"#/components/requestBodies/api-shield_global_settings_edit"},"responses":{"200":{"$ref":"#/components/responses/api-shield_global_settings_edit_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Edit global schema validation settings","tags":["Schema Validation Settings"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]},"put":{"operationId":"schema-validation-update-settings","requestBody":{"$ref":"#/components/requestBodies/api-shield_global_settings_update"},"responses":{"200":{"$ref":"#/components/responses/api-shield_global_settings_update_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update global schema validation settings","tags":["Schema Validation Settings"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/schema_validation/settings/operations":{"get":{"operationId":"schema-validation-list-per-operation-settings","parameters":[{"$ref":"#/components/parameters/api-shield_page"},{"$ref":"#/components/parameters/api-shield_per_page"}],"responses":{"200":{"$ref":"#/components/responses/api-shield_per_operation_settings_list_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List per-operation schema validation settings","tags":["Schema Validation Settings"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"patch":{"operationId":"schema-validation-bulk-edit-per-operation-settings","requestBody":{"$ref":"#/components/requestBodies/api-shield_per_operation_settings_bulk_edit"},"responses":{"200":{"$ref":"#/components/responses/api-shield_per_operation_settings_bulk_edit_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Bulk edit per-operation schema validation settings","tags":["Schema Validation Settings"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/schema_validation/settings/operations/{operation_id}":{"delete":{"operationId":"schema-validation-delete-per-operation-setting","responses":{"200":{"$ref":"#/components/responses/api-shield_per_operation_settings_delete_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete per-operation schema validation setting","tags":["Schema Validation Settings"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]},"get":{"operationId":"schema-validation-get-per-operation-setting","responses":{"200":{"$ref":"#/components/responses/api-shield_per_operation_setting_get_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get per-operation schema validation setting","tags":["Schema Validation Settings"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"},{"$ref":"#/components/parameters/api-shield_operation_id"}],"put":{"operationId":"schema-validation-update-per-operation-setting","requestBody":{"$ref":"#/components/requestBodies/api-shield_per_operation_setting_update"},"responses":{"200":{"$ref":"#/components/responses/api-shield_per_operation_setting_update_success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update per-operation schema validation setting","tags":["Schema Validation Settings"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/secondary_dns/force_axfr":{"post":{"description":"Sends AXFR zone transfer request to primary nameserver(s).","operationId":"secondary-dns-(-secondary-zone)-force-axfr","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_force_response"}}},"description":"Force AXFR response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_force_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Force AXFR response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Force AXFR","tags":["Secondary DNS (Secondary Zone)"],"x-api-token-group":["Zone Settings Write","Zone Write","DNS Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/secondary_dns/incoming":{"delete":{"description":"Delete secondary zone configuration for incoming zone transfers.","operationId":"secondary-dns-(-secondary-zone)-delete-secondary-zone-configuration","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_id_response"}}},"description":"Delete Secondary Zone Configuration response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_id_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Delete Secondary Zone Configuration response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Secondary Zone Configuration","tags":["Secondary DNS (Secondary Zone)"],"x-api-token-group":["Zone Settings Write","Zone Write","DNS Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get secondary zone configuration for incoming zone transfers.","operationId":"secondary-dns-(-secondary-zone)-secondary-zone-configuration-details","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_single_response_incoming"}}},"description":"Secondary Zone Configuration Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_single_response_incoming"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Secondary Zone Configuration Details response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Secondary Zone Configuration Details","tags":["Secondary DNS (Secondary Zone)"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","DNS Read","Zone Write","DNS Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create secondary zone configuration for incoming zone transfers.","operationId":"secondary-dns-(-secondary-zone)-create-secondary-zone-configuration","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_dns-secondary-secondary-zone"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_single_response_incoming"}}},"description":"Create Secondary Zone Configuration response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_single_response_incoming"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Create Secondary Zone Configuration response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Secondary Zone Configuration","tags":["Secondary DNS (Secondary Zone)"],"x-api-token-group":["Zone Settings Write","Zone Write","DNS Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update secondary zone configuration for incoming zone transfers.","operationId":"secondary-dns-(-secondary-zone)-update-secondary-zone-configuration","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_dns-secondary-secondary-zone"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_single_response_incoming"}}},"description":"Update Secondary Zone Configuration response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_single_response_incoming"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Update Secondary Zone Configuration response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Secondary Zone Configuration","tags":["Secondary DNS (Secondary Zone)"],"x-api-token-group":["Zone Settings Write","Zone Write","DNS Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/secondary_dns/outgoing":{"delete":{"description":"Delete primary zone configuration for outgoing zone transfers.","operationId":"secondary-dns-(-primary-zone)-delete-primary-zone-configuration","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_id_response"}}},"description":"Delete Primary Zone Configuration response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_id_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Delete Primary Zone Configuration response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Primary Zone Configuration","tags":["Secondary DNS (Primary Zone)"],"x-api-token-group":["Zone Settings Write","Zone Write","DNS Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get primary zone configuration for outgoing zone transfers.","operationId":"secondary-dns-(-primary-zone)-primary-zone-configuration-details","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_single_response_outgoing"}}},"description":"Primary Zone Configuration Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_single_response_outgoing"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Primary Zone Configuration Details response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Primary Zone Configuration Details","tags":["Secondary DNS (Primary Zone)"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","DNS Read","Zone Write","DNS Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create primary zone configuration for outgoing zone transfers.","operationId":"secondary-dns-(-primary-zone)-create-primary-zone-configuration","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_single_request_outgoing"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_single_response_outgoing"}}},"description":"Create Primary Zone Configuration response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_single_response_outgoing"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Create Primary Zone Configuration response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Primary Zone Configuration","tags":["Secondary DNS (Primary Zone)"],"x-api-token-group":["Zone Settings Write","Zone Write","DNS Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update primary zone configuration for outgoing zone transfers.","operationId":"secondary-dns-(-primary-zone)-update-primary-zone-configuration","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_single_request_outgoing"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_single_response_outgoing"}}},"description":"Update Primary Zone Configuration response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_single_response_outgoing"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Update Primary Zone Configuration response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Primary Zone Configuration","tags":["Secondary DNS (Primary Zone)"],"x-api-token-group":["Zone Settings Write","Zone Write","DNS Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/secondary_dns/outgoing/disable":{"post":{"description":"Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone.","operationId":"secondary-dns-(-primary-zone)-disable-outgoing-zone-transfers","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_disable_transfer_response"}}},"description":"Disable Outgoing Zone Transfers response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_disable_transfer_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Disable Outgoing Zone Transfers response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Disable Outgoing Zone Transfers","tags":["Secondary DNS (Primary Zone)"],"x-api-token-group":["Zone Settings Write","Zone Write","DNS Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/secondary_dns/outgoing/enable":{"post":{"description":"Enable outgoing zone transfers for primary zone.","operationId":"secondary-dns-(-primary-zone)-enable-outgoing-zone-transfers","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_enable_transfer_response"}}},"description":"Enable Outgoing Zone Transfers response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_enable_transfer_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Enable Outgoing Zone Transfers response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Enable Outgoing Zone Transfers","tags":["Secondary DNS (Primary Zone)"],"x-api-token-group":["Zone Settings Write","Zone Write","DNS Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/secondary_dns/outgoing/force_notify":{"post":{"description":"Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone.","operationId":"secondary-dns-(-primary-zone)-force-dns-notify","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_schemas-force_response"}}},"description":"Force DNS NOTIFY response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_schemas-force_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Force DNS NOTIFY response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Force DNS NOTIFY","tags":["Secondary DNS (Primary Zone)"],"x-api-token-group":["Zone Settings Write","Zone Write","DNS Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/secondary_dns/outgoing/status":{"get":{"description":"Get primary zone transfer status.","operationId":"secondary-dns-(-primary-zone)-get-outgoing-zone-transfer-status","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/secondary-dns_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/secondary-dns_enable_transfer_response"}}},"description":"Get Outgoing Zone Transfer Status response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/secondary-dns_enable_transfer_response"},{"$ref":"#/components/schemas/secondary-dns_api-response-common-failure"}]}}},"description":"Get Outgoing Zone Transfer Status response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Outgoing Zone Transfer Status","tags":["Secondary DNS (Primary Zone)"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","DNS Read","Zone Write","DNS Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/security-center/insights":{"get":{"operationId":"get-zone-security-center-insights","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"query","name":"dismissed","schema":{"$ref":"#/components/schemas/security-center_dismissed"}},{"in":"query","name":"issue_class","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"issue_class~neq","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type~neq","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product~neq","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity~neq","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject~neq","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"page","schema":{"allOf":[{"$ref":"#/components/schemas/security-center_page"}],"default":1}},{"in":"query","name":"per_page","schema":{"allOf":[{"$ref":"#/components/schemas/security-center_perPage"}],"default":25}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/security-center_api-response-common"},{"properties":{"result":{"anyOf":[{"properties":{"count":{"$ref":"#/components/schemas/security-center_count"},"issues":{"items":{"$ref":"#/components/schemas/security-center_issue"},"type":"array"},"page":{"$ref":"#/components/schemas/security-center_page"},"per_page":{"$ref":"#/components/schemas/security-center_perPage"}},"type":"object"}]}}}]}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Zone Security Center Insights","tags":["Security Center Insights"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"]}},"/zones/{zone_id}/security-center/insights/class":{"get":{"operationId":"get-zone-security-center-insight-counts-by-class","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"query","name":"dismissed","schema":{"$ref":"#/components/schemas/security-center_dismissed"}},{"in":"query","name":"issue_class","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"issue_class~neq","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type~neq","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product~neq","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity~neq","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject~neq","schema":{"$ref":"#/components/schemas/security-center_subjects"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_valueCountsResponse"}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Zone Security Center Insight Counts by Class","tags":["Security Center Insights"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"]}},"/zones/{zone_id}/security-center/insights/severity":{"get":{"operationId":"get-zone-security-center-insight-counts-by-severity","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"query","name":"dismissed","schema":{"$ref":"#/components/schemas/security-center_dismissed"}},{"in":"query","name":"issue_class","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"issue_class~neq","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type~neq","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product~neq","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity~neq","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject~neq","schema":{"$ref":"#/components/schemas/security-center_subjects"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_valueCountsResponse"}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Zone Security Center Insight Counts by Severity","tags":["Security Center Insights"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"]}},"/zones/{zone_id}/security-center/insights/type":{"get":{"operationId":"get-zone-security-center-insight-counts-by-type","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"query","name":"dismissed","schema":{"$ref":"#/components/schemas/security-center_dismissed"}},{"in":"query","name":"issue_class","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject","schema":{"$ref":"#/components/schemas/security-center_subjects"}},{"in":"query","name":"issue_class~neq","schema":{"$ref":"#/components/schemas/security-center_issueClasses"}},{"in":"query","name":"issue_type~neq","schema":{"$ref":"#/components/schemas/security-center_issueTypes"}},{"in":"query","name":"product~neq","schema":{"$ref":"#/components/schemas/security-center_products"}},{"in":"query","name":"severity~neq","schema":{"$ref":"#/components/schemas/security-center_severityQueryParam"}},{"in":"query","name":"subject~neq","schema":{"$ref":"#/components/schemas/security-center_subjects"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_valueCountsResponse"}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Zone Security Center Insight Counts by Type","tags":["Security Center Insights"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"]}},"/zones/{zone_id}/security-center/insights/{issue_id}/dismiss":{"put":{"operationId":"archive-zone-security-center-insight","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}},{"in":"path","name":"issue_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"dismiss":{"default":true,"type":"boolean","x-auditable":true}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/security-center_api-response-single"}]}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Archive Zone Security Center Insight","tags":["Security Center Insights"],"x-api-token-group":["Zone Settings Write"]}},"/zones/{zone_id}/security-center/securitytxt":{"delete":{"operationId":"delete-security-txt","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/security-center_api-response-single"}]}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete security.txt","tags":["security.txt"],"x-api-token-group":["Zone Settings Write"]},"get":{"operationId":"get-security-txt","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/security-center_api-response-common"},{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/security-center_securityTxt"}]}}}]}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get security.txt","tags":["security.txt"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"]},"put":{"operationId":"update-security-txt","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/security-center_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_securityTxt"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/security-center_api-response-single"}]}}},"description":"OK"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/security-center_api-response-common-failure"}}},"description":"Client Error"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update security.txt","tags":["security.txt"],"x-api-token-group":["Zone Settings Write"]}},"/zones/{zone_id}/settings":{"get":{"deprecated":true,"description":"Available settings for your user in relation to a zone.","operationId":"zone-settings-get-all-zone-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_zone_settings_response_collection"}}},"description":"Get all Zone settings response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_components-schemas-api-response-common-failure"}}},"description":"Get all Zone settings response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get all zone settings","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"This endpoint is deprecated. Zone settings should instead be managed individually."},"patch":{"deprecated":true,"description":"Edit settings for a zone.","operationId":"zone-settings-edit-zone-settings-info","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_multiple_settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_zone_settings_response_collection"}}},"description":"Edit zone settings info response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_components-schemas-api-response-common-failure"}}},"description":"Edit zone settings info response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Edit multiple zone settings","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"This endpoint is deprecated. Zone settings should instead be managed individually."}},"/zones/{zone_id}/settings/aegis":{"get":{"description":"Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses.","operationId":"zone-cache-settings-get-aegis-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_aegis_response_value"}],"type":"object"}}},"description":"Get aegis setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Get aegis setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get aegis setting","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","Zone Read","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 WAF and CDN services. The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses.","operationId":"zone-cache-settings-change-aegis-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/cache-rules_aegis_value"}},"required":["value"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_aegis_response_value"}],"type":"object"}}},"description":"Change aegis setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Change aegis setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Change aegis setting","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/settings/fonts":{"get":{"description":"Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain,\nboost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.\n","operationId":"zone-settings-get-fonts-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/speed_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/speed_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/speed_cloudflare_fonts"}},"type":"object"}]}}},"description":"Get Cloudflare Fonts setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/speed_api-response-common-failure"}}},"description":"Get Cloudflare Fonts setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Cloudflare Fonts setting","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Enhance your website's font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain,\nboost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.\n","operationId":"zone-settings-change-fonts-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/speed_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/speed_cloudflare_fonts_value"}},"required":["value"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/speed_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/speed_cloudflare_fonts"}},"type":"object"}]}}},"description":"Change Cloudflare Fonts setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/speed_api-response-common-failure"}}},"description":"Change Cloudflare Fonts setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Change Cloudflare Fonts setting","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/settings/origin_h2_max_streams":{"get":{"description":"Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled.","operationId":"zone-cache-settings-get-origin-h2-max-streams-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"responses":{"200":{"content":{"application/json":{"examples":{"origin_h2_max_streams_50":{"$ref":"#/components/examples/cache-rules_origin_h2_max_streams_50"}},"schema":{"$ref":"#/components/schemas/cache-rules_origin_h2_max_streams_response_value"}}},"description":"Get Origin H2 Max Streams setting response."},"4XX":{"content":{"application/json":{"examples":{"Error":{"$ref":"#/components/examples/cache-rules_dummy_error_response"}},"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Get Origin H2 Max Streams setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Origin H2 Max Streams Setting","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","Zone Read","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Origin H2 Max Streams configures the max number of concurrent requests that Cloudflare will send within the same connection when communicating with the origin server, if the origin supports it. Note that if your origin does not support H2 multiplexing, 5xx errors may be observed, particularly 520s. Also note that the default value is `100` for all plan types except Enterprise where it is `1`. `1` means that H2 multiplexing is disabled.","operationId":"zone-cache-settings-change-origin-h2-max-streams-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/cache-rules_origin_h2_max_streams_value"}},"required":["value"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"origin_h2_max_streams_50":{"$ref":"#/components/examples/cache-rules_origin_h2_max_streams_50"}},"schema":{"$ref":"#/components/schemas/cache-rules_origin_h2_max_streams_response_value"}}},"description":"Change Origin H2 Max Streams setting response."},"4XX":{"content":{"application/json":{"examples":{"Error":{"$ref":"#/components/examples/cache-rules_dummy_error_response"}},"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Change Origin H2 Max Streams response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Change Origin H2 Max Streams Setting","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/settings/origin_max_http_version":{"get":{"description":"Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is \"2\" for all plan types except Enterprise where it is \"1\".","operationId":"zone-cache-settings-get-origin-max-http-version-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"responses":{"200":{"content":{"application/json":{"examples":{"max_http_version_2":{"$ref":"#/components/examples/cache-rules_origin_max_http_version_2"}},"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_origin_max_http_version_response_value"}],"type":"object"}}},"description":"Get Origin Max HTTP Version setting response."},"4XX":{"content":{"application/json":{"examples":{"Error":{"$ref":"#/components/examples/cache-rules_dummy_error_response"}},"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Get Origin Max HTTP Version setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Origin Max HTTP Version Setting","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","Zone Read","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is \"2\" for all plan types except Enterprise where it is \"1\".","operationId":"zone-cache-settings-change-origin-max-http-version-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache-rules_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/cache-rules_origin_max_http_version_value"}},"required":["value"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"max_http_version_2":{"$ref":"#/components/examples/cache-rules_origin_max_http_version_2"}},"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache-rules_origin_max_http_version_response_value"}],"type":"object"}}},"description":"Change Origin Max HTTP Version setting response."},"4XX":{"content":{"application/json":{"examples":{"Error":{"$ref":"#/components/examples/cache-rules_dummy_error_response"}},"schema":{"$ref":"#/components/schemas/cache-rules_api-response-common-failure"}}},"description":"Change Origin Max HTTP Version response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Change Origin Max HTTP Version Setting","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/settings/rum":{"get":{"description":"Retrieves RUM status for a zone.","operationId":"web-analytics-get-rum-status","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_rum-site-response-single"}}},"description":"Rum Status."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Get RUM status for a zone","tags":["Web Analytics"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Toggles RUM on/off for an existing zone.","operationId":"web-analytics-toggle-rum","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rum_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_toggle-rum-request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_rum-site-response-single"}}},"description":"Rum toggled on/off for an existing zone."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rum_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Toggle RUM on/off for a zone","tags":["Web Analytics"],"x-api-token-group":["Zone Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/settings/speed_brain":{"get":{"description":"Speed Brain lets compatible browsers speculate on content which can be prefetched or preloaded, making website\nnavigation faster. Refer to the Cloudflare Speed Brain documentation for more information.\n","operationId":"zone-settings-get-speed-brain-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/speed_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/speed_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/speed_cloudflare_speed_brain_response"}},"type":"object"}]}}},"description":"Get Cloudflare Speed Brain setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/speed_api-response-common-failure"}}},"description":"Get Cloudflare Speed Brain setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Cloudflare Speed Brain setting","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Speed Brain lets compatible browsers speculate on content which can be prefetched or preloaded, making website\nnavigation faster. Refer to the Cloudflare Speed Brain documentation for more information.\n","operationId":"zone-settings-change-speed-brain-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/speed_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"description":"Whether the feature is enabled or disabled.","enum":["on","off"],"type":"string"}},"required":["value"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/speed_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/speed_cloudflare_speed_brain_response"}},"type":"object"}]}}},"description":"Cloudflare Speed Brain setting response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/speed_api-response-common-failure"}}},"description":"Change Cloudflare Speed Brain setting response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Change Cloudflare Speed Brain setting","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/settings/ssl_automatic_mode":{"get":{"description":"If the system is enabled, the response will include next_scheduled_scan, representing the next time this zone will be scanned and the zone's ssl/tls encryption mode is potentially upgraded by the system. If the system is disabled, next_scheduled_scan will not be present in the response body.","operationId":"ssl-detector-automatic-mode-get-enrollment","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache_identifier"}}],"responses":{"200":{"content":{"application/json":{"examples":{"Disabled":{"$ref":"#/components/examples/cache_dummy_automatic_upgrader_enabled_response"},"Enabled":{"$ref":"#/components/examples/cache_dummy_automatic_upgrader_disabled_response"}},"schema":{"$ref":"#/components/schemas/cache_api-response-single-id"}}},"description":"Get Automatic SSL/TLS Enrollment status response."},"4XX":{"content":{"application/json":{"examples":{"Error":{"$ref":"#/components/examples/cache_dummy_error_response"}},"schema":{"$ref":"#/components/schemas/cache_api-response-common-failure"}}},"description":"Get Automatic SSL/TLS Enrollment status failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Automatic SSL/TLS enrollment status for the given zone","tags":["Automatic SSL/TLS"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"The automatic system is enabled when this endpoint is hit with value in the request body is set to \"auto\", and disabled when the request body value is set to \"custom\".","operationId":"ssl-detector-automatic-mode-patch-enrollment","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache_schemas_patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"Enabled":{"$ref":"#/components/examples/cache_dummy_automatic_upgrader_enabled_response"}},"schema":{"$ref":"#/components/schemas/cache_api-response-single-id"}}},"description":"Patch Automatic SSL/TLS Enrollment status response."},"4XX":{"content":{"application/json":{"examples":{"Error":{"$ref":"#/components/examples/cache_dummy_error_response"}},"schema":{"$ref":"#/components/schemas/cache_api-response-common-failure"}}},"description":"Patch Automatic SSL/TLS Enrollment status failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Automatic SSL/TLS Enrollment status for given zone","tags":["Automatic SSL/TLS"],"x-api-token-group":["Zone Settings Write","SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read","#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/settings/zaraz/config":{"get":{"description":"Gets latest Zaraz configuration for a zone. It can be preview or published configuration, whichever was the last updated. Secret variables values will not be included.","operationId":"get-zones-zone_identifier-zaraz-config","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zaraz_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_zaraz-config-response"}}},"description":"Get Zaraz configuration response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_api-response-common-failure"}}},"description":"Get Zaraz configuration response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Zaraz configuration","tags":["Zaraz"],"x-api-token-group":["Zaraz Edit","Zaraz Read","Zaraz Admin"]},"put":{"description":"Updates Zaraz configuration for a zone.","operationId":"put-zones-zone_identifier-zaraz-config","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zaraz_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_zaraz-config-body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_zaraz-config-response"}}},"description":"Update Zaraz configuration response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_api-response-common-failure"}}},"description":"Update Zaraz configuration response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Zaraz configuration","tags":["Zaraz"],"x-api-token-group":["Zaraz Edit","Zaraz Admin"]}},"/zones/{zone_id}/settings/zaraz/default":{"get":{"description":"Gets default Zaraz configuration for a zone.","operationId":"get-zones-zone_identifier-zaraz-default","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zaraz_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_zaraz-config-response"}}},"description":"Get Zaraz default configuration response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_api-response-common-failure"}}},"description":"Get Zaraz default configuration response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get default Zaraz configuration","tags":["Zaraz"],"x-api-token-group":["Zaraz Edit","Zaraz Read","Zaraz Admin"]}},"/zones/{zone_id}/settings/zaraz/export":{"get":{"description":"Exports full current published Zaraz configuration for a zone, secret variables included.","operationId":"get-zones-zone_identifier-zaraz-export","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zaraz_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_zaraz-config-return"}}},"description":"Get Zaraz configuration response","headers":{"Content-Disposition":{"example":"attachment; filename=zaraz-2023-11-10-23-00.json","schema":{"type":"string"}}}},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_api-response-common-failure"}}},"description":"Get Zaraz configuration response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Export Zaraz configuration","tags":["Zaraz"],"x-api-token-group":["Zaraz Edit","Zaraz Read","Zaraz Admin"]}},"/zones/{zone_id}/settings/zaraz/history":{"get":{"description":"Lists a history of published Zaraz configuration records for a zone.","operationId":"get-zones-zone_identifier-zaraz-history","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zaraz_identifier"}},{"description":"Ordinal number to start listing the results with. Default value is 0.","example":0,"in":"query","name":"offset","schema":{"minimum":0,"type":"integer"}},{"description":"Maximum amount of results to list. Default value is 10.","example":10,"in":"query","name":"limit","schema":{"minimum":1,"type":"integer"}},{"description":"The field to sort by. Default is updated_at.","example":"updated_at","in":"query","name":"sortField","schema":{"enum":["id","user_id","description","created_at","updated_at"],"type":"string"}},{"description":"Sorting order. Default is DESC.","example":"DESC","in":"query","name":"sortOrder","schema":{"enum":["DESC","ASC"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_zaraz-history-response"}}},"description":"List Zaraz historical configuration records response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_api-response-common-failure"}}},"description":"List Zaraz historical configuration records failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Zaraz historical configuration records","tags":["Zaraz"],"x-api-token-group":["Zaraz Edit","Zaraz Read","Zaraz Admin"]},"put":{"description":"Restores a historical published Zaraz configuration by ID for a zone.","operationId":"put-zones-zone_identifier-zaraz-history","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zaraz_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"ID of the Zaraz configuration to restore.","example":12345,"minimum":1,"type":"integer"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_zaraz-config-response"}}},"description":"Restore Zaraz historical configuration by ID response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_api-response-common-failure"}}},"description":"Restore Zaraz historical configuration by ID failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Restore Zaraz historical configuration by ID","tags":["Zaraz"],"x-api-token-group":["Zaraz Edit","Zaraz Admin"]}},"/zones/{zone_id}/settings/zaraz/history/configs":{"get":{"description":"Gets a history of published Zaraz configurations by ID(s) for a zone.","operationId":"get-zones-zone_identifier-zaraz-config-history","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zaraz_identifier"}},{"description":"Comma separated list of Zaraz configuration IDs","example":[12345,23456],"explode":false,"in":"query","name":"ids","required":true,"schema":{"items":{"type":"integer"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_zaraz-config-history-response"}}},"description":"Get Zaraz historical configurations by ID(s) response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_api-response-common-failure"}}},"description":"Get Zaraz historical configurations by ID(s) failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Zaraz historical configurations by ID(s)","tags":["Zaraz"],"x-api-token-group":["Zaraz Edit","Zaraz Read","Zaraz Admin"]}},"/zones/{zone_id}/settings/zaraz/publish":{"post":{"description":"Publish current Zaraz preview configuration for a zone.","operationId":"post-zones-zone_identifier-zaraz-publish","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zaraz_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Zaraz configuration description.","example":"Config with enabled ecommerce tracking","type":"string"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zaraz_api-response-common"},{"properties":{"result":{"example":"Config has been published successfully","type":"string"}}}]}}},"description":"Update Zaraz workflow response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_api-response-common-failure"}}},"description":"Update Zaraz workflow response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Publish Zaraz preview configuration","tags":["Zaraz"],"x-api-token-group":["Zaraz Admin"],"x-cfPermissionsRequired":{"enum":["#zaraz:publish"]}}},"/zones/{zone_id}/settings/zaraz/workflow":{"get":{"description":"Gets Zaraz workflow for a zone.","operationId":"get-zones-zone_identifier-zaraz-workflow","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zaraz_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_zaraz-workflow-response"}}},"description":"Get Zaraz workflow response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_api-response-common-failure"}}},"description":"Get Zaraz workflow response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Zaraz workflow","tags":["Zaraz"],"x-api-token-group":["Zaraz Edit","Zaraz Read","Zaraz Admin"]},"put":{"description":"Updates Zaraz workflow for a zone.","operationId":"put-zones-zone_identifier-zaraz-workflow","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zaraz_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_zaraz-workflow"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_zaraz-workflow-response"}}},"description":"Update Zaraz workflow response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zaraz_api-response-common-failure"}}},"description":"Update Zaraz workflow response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Zaraz workflow","tags":["Zaraz"],"x-api-token-group":["Zaraz Edit","Zaraz Admin"]}},"/zones/{zone_id}/settings/{setting_id}":{"get":{"description":"Fetch a single zone setting by name","operationId":"zone-settings-get-single-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_identifier"}},{"in":"path","name":"setting_id","required":true,"schema":{"$ref":"#/components/schemas/zones_setting_name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_settings-api_components-schemas-api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/zones_setting"}}}]}}},"description":"Get zone setting response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_components-schemas-api-response-common-failure"}}},"description":"Get zone setting response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get zone setting","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Updates a single zone setting by the identifier","operationId":"zone-settings-edit-single-setting","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/zones_identifier"}},{"in":"path","name":"setting_id","required":true,"schema":{"$ref":"#/components/schemas/zones_setting_name"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_zone_settings_single_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zones_settings-api_components-schemas-api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/zones_setting"}}}]}}},"description":"Edit zone setting response"},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zones_components-schemas-api-response-common-failure"}}},"description":"Edit zone settings info response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Edit zone setting","tags":["Zone Settings"],"x-api-token-group":["Zone Settings Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/smart_shield":{"get":{"description":"Retrieve Smart Shield Settings.","operationId":"smart-shield-get-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/smartshield_api-response-common"},{"$ref":"#/components/schemas/smartshield_single_smart_shield_get_response"}]}}},"description":"Smart Shield Settings response."},"4XX":{"content":{"application/json":{"examples":{"Invalid value":{"$ref":"#/components/examples/smartshield_smart_shield_4xx_get_response"}},"schema":{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}}},"description":"Patch Smart Shield Settings response failure."},"500":{"content":{"application/json":{"examples":{"Invalid value":{"$ref":"#/components/examples/smartshield_smart_shield_500_response"}},"schema":{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}}},"description":"Get Smart Shield Settings response failure."},"502":{"content":{"application/json":{"examples":{"Not found":{"$ref":"#/components/examples/smartshield_smart_shield_502_get_response"}},"schema":{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}}},"description":"Get Smart Shield Settings response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Smart Shield Settings","tags":["Smart Shield Settings"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","Zone Read","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Set Smart Shield Settings.","operationId":"smart-shield-patch-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartshield_smart_shield_settings_patch_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/smartshield_api-response-common"},{"$ref":"#/components/schemas/smartshield_single_smart_shield_patch_response"}]}}},"description":"Smart Shield Settings response."},"4XX":{"content":{"application/json":{"examples":{"Invalid value":{"$ref":"#/components/examples/smartshield_smart_shield_4xx_get_response"}},"schema":{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}}},"description":"Patch Smart Shield Settings response failure."},"500":{"content":{"application/json":{"examples":{"Invalid value":{"$ref":"#/components/examples/smartshield_smart_shield_500_response"}},"schema":{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}}},"description":"Get Smart Shield Settings response failure."},"502":{"content":{"application/json":{"examples":{"Not found":{"$ref":"#/components/examples/smartshield_smart_shield_502_patch_response"}},"schema":{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}}},"description":"Smart Shield Settings response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Smart Shield Settings","tags":["Smart Shield Settings"],"x-api-token-group":["Zone Settings Write","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read","#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/smart_shield/cache_reserve_clear":{"get":{"description":"You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.","operationId":"smart-shield-settings-get-cache-reserve-clear","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}}],"responses":{"200":{"content":{"application/json":{"examples":{"Completed":{"$ref":"#/components/examples/smartshield_cache_reserve_clear_completed"},"In-progress":{"$ref":"#/components/examples/smartshield_cache_reserve_clear_in_progress"}},"schema":{"allOf":[{"$ref":"#/components/schemas/smartshield_api-response-common"},{"$ref":"#/components/schemas/smartshield_cache_reserve_clear_response_value"}],"type":"object"}}},"description":"Get Cache Reserve Clear response."},"4XX":{"content":{"application/json":{"examples":{"Not found":{"$ref":"#/components/examples/smartshield_cache_reserve_clear_not_found"}},"schema":{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}}},"description":"Get Cache Reserve Clear failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Cache Reserve Clear","tags":["Cache Reserve Clear"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","Zone Read","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.","operationId":"smart-shield-settings-start-cache-reserve-clear","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}}],"requestBody":{"content":{"application/json":{"example":"{}"}},"description":"The request body is currently not used.","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"In-progress":{"$ref":"#/components/examples/smartshield_cache_reserve_clear_in_progress"}},"schema":{"allOf":[{"$ref":"#/components/schemas/smartshield_api-response-common"},{"$ref":"#/components/schemas/smartshield_cache_reserve_clear_response_value"}],"type":"object"}}},"description":"Start Cache Reserve Clear response."},"4XX":{"content":{"application/json":{"examples":{"Rejected":{"$ref":"#/components/examples/smartshield_cache_reserve_clear_rejected_cr_on"}},"schema":{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}}},"description":"Start Cache Reserve Clear failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Start Cache Reserve Clear","tags":["Cache Reserve Clear"],"x-api-token-group":["Zone Settings Write","Zone Write"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/smart_shield/healthchecks":{"get":{"description":"List configured health checks.","operationId":"smart-shield-list-health-checks","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}},{"$ref":"#/components/parameters/smartshield_page"},{"$ref":"#/components/parameters/smartshield_per_page"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartshield_response_collection"}}},"description":"List Health Checks response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/smartshield_response_collection"},{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}]}}},"description":"List Health Checks response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Health Checks","tags":["Health Checks"],"x-api-token-group":["Health Checks Write","Health Checks Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"post":{"description":"Create a new health check.","operationId":"smart-shield-create-health-check","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartshield_query_healthcheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartshield_single_hc_response"}}},"description":"Create Health Check response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/smartshield_single_hc_response"},{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}]}}},"description":"Create Health Check response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Health Check","tags":["Health Checks"],"x-api-token-group":["Health Checks Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/smart_shield/healthchecks/{healthcheck_id}":{"delete":{"description":"Delete a health check.","operationId":"smart-shield-delete-health-check","parameters":[{"in":"path","name":"healthcheck_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartshield_single_hc_id_response"}}},"description":"Delete Health Check response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/smartshield_single_hc_id_response"},{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}]}}},"description":"Delete Health Check response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Health Check","tags":["Health Checks"],"x-api-token-group":["Health Checks Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Fetch a single configured health check.","operationId":"smart-shield-health-check-details","parameters":[{"in":"path","name":"healthcheck_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartshield_single_hc_response"}}},"description":"Health Check Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/smartshield_single_hc_response"},{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}]}}},"description":"Health Check Details response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Health Check Details","tags":["Health Checks"],"x-api-token-group":["Health Checks Write","Health Checks Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"patch":{"description":"Patch a configured health check.","operationId":"smart-shield-patch-health-check","parameters":[{"in":"path","name":"healthcheck_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartshield_query_healthcheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartshield_single_hc_response"}}},"description":"Patch Health Check response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/smartshield_single_hc_response"},{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}]}}},"description":"Patch Health Check response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Health Check","tags":["Health Checks"],"x-api-token-group":["Health Checks Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Update a configured health check.","operationId":"smart-shield-update-health-check","parameters":[{"in":"path","name":"healthcheck_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/smartshield_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartshield_single_hc_response"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartshield_single_hc_response"}}},"description":"Update Health Check response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/smartshield_single_hc_response"},{"$ref":"#/components/schemas/smartshield_api-response-common-failure"}]}}},"description":"Update Health Check response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Health Check","tags":["Health Checks"],"x-api-token-group":["Health Checks Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/snippets":{"get":{"description":"Fetches all snippets belonging to the zone.","operationId":"listZoneSnippets","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/snippets_ZoneId"}},{"in":"query","name":"page","schema":{"$ref":"#/components/schemas/snippets_Page"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/snippets_PerPage"}}],"responses":{"200":{"$ref":"#/components/responses/snippets_Snippets"},"4XX":{"$ref":"#/components/responses/snippets_Failure"},"5XX":{"$ref":"#/components/responses/snippets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List zone snippets","tags":["Zone Snippets"],"x-api-token-group":["Snippets Write","Snippets Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/snippets/snippet_rules":{"delete":{"description":"Deletes all snippet rules belonging to the zone.","operationId":"deleteZoneSnippetRules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/snippets_ZoneId"}}],"responses":{"200":{"$ref":"#/components/responses/snippets_SnippetRules"},"4XX":{"$ref":"#/components/responses/snippets_Failure"},"5XX":{"$ref":"#/components/responses/snippets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete zone snippet rules","tags":["Zone Snippets"],"x-api-token-group":["Snippets Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches all snippet rules belonging to the zone.","operationId":"listZoneSnippetRules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/snippets_ZoneId"}}],"responses":{"200":{"$ref":"#/components/responses/snippets_SnippetRules"},"4XX":{"$ref":"#/components/responses/snippets_Failure"},"5XX":{"$ref":"#/components/responses/snippets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"List zone snippet rules","tags":["Zone Snippets"],"x-api-token-group":["Snippets Write","Snippets Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates all snippet rules belonging to the zone.","operationId":"updateZoneSnippetRules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/snippets_ZoneId"}}],"requestBody":{"$ref":"#/components/requestBodies/snippets_SnippetRules"},"responses":{"200":{"$ref":"#/components/responses/snippets_SnippetRules"},"4XX":{"$ref":"#/components/responses/snippets_Failure"},"5XX":{"$ref":"#/components/responses/snippets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update zone snippet rules","tags":["Zone Snippets"],"x-api-token-group":["Snippets Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/snippets/{snippet_name}":{"delete":{"description":"Deletes a snippet belonging to the zone.","operationId":"deleteZoneSnippet","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/snippets_ZoneId"}},{"in":"path","name":"snippet_name","required":true,"schema":{"$ref":"#/components/schemas/snippets_SnippetName"}}],"responses":{"200":{"$ref":"#/components/responses/snippets_Null"},"4XX":{"$ref":"#/components/responses/snippets_Failure"},"5XX":{"$ref":"#/components/responses/snippets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a zone snippet","tags":["Zone Snippets"],"x-api-token-group":["Snippets Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches a snippet belonging to the zone.","operationId":"getZoneSnippet","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/snippets_ZoneId"}},{"in":"path","name":"snippet_name","required":true,"schema":{"$ref":"#/components/schemas/snippets_SnippetName"}}],"responses":{"200":{"$ref":"#/components/responses/snippets_Snippet"},"4XX":{"$ref":"#/components/responses/snippets_Failure"},"5XX":{"$ref":"#/components/responses/snippets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get a zone snippet","tags":["Zone Snippets"],"x-api-token-group":["Snippets Write","Snippets Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Creates or updates a snippet belonging to the zone.","operationId":"updateZoneSnippet","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/snippets_ZoneId"}},{"in":"path","name":"snippet_name","required":true,"schema":{"$ref":"#/components/schemas/snippets_SnippetName"}}],"requestBody":{"$ref":"#/components/requestBodies/snippets_Snippet"},"responses":{"200":{"$ref":"#/components/responses/snippets_Snippet"},"4XX":{"$ref":"#/components/responses/snippets_Failure"},"5XX":{"$ref":"#/components/responses/snippets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update a zone snippet","tags":["Zone Snippets"],"x-api-token-group":["Snippets Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/snippets/{snippet_name}/content":{"get":{"description":"Fetches the content of a snippet belonging to the zone.","operationId":"getZoneSnippetContent","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/snippets_ZoneId"}},{"in":"path","name":"snippet_name","required":true,"schema":{"$ref":"#/components/schemas/snippets_SnippetName"}}],"responses":{"200":{"$ref":"#/components/responses/snippets_SnippetContent"},"4XX":{"$ref":"#/components/responses/snippets_Failure"},"5XX":{"$ref":"#/components/responses/snippets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get a zone snippet content","tags":["Zone Snippets"],"x-api-token-group":["Snippets Write","Snippets Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/spectrum/analytics/aggregate/current":{"get":{"description":"Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone.","operationId":"spectrum-aggregate-analytics-get-current-aggregated-analytics","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/spectrum-analytics_identifier"}},{"in":"query","name":"appID","schema":{"$ref":"#/components/schemas/spectrum-analytics_app_id_param"}},{"in":"query","name":"colo_name","schema":{"description":"Co-location identifier.","example":"PDX","maxLength":3,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-analytics_query-response-aggregate"}}},"description":"Get current aggregated analytics response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-analytics_api-response-common-failure"}}},"description":"Get current aggregated analytics response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get current aggregated analytics","tags":["Spectrum Analytics"],"x-api-token-group":["Analytics Read"]}},"/zones/{zone_id}/spectrum/analytics/events/bytime":{"get":{"description":"Retrieves a list of aggregate metrics grouped by time interval.","operationId":"spectrum-analytics-(-by-time)-get-analytics-by-time","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/spectrum-analytics_identifier"}},{"in":"query","name":"dimensions","schema":{"$ref":"#/components/schemas/spectrum-analytics_dimensions"}},{"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/spectrum-analytics_sort"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/spectrum-analytics_until"}},{"in":"query","name":"metrics","schema":{"$ref":"#/components/schemas/spectrum-analytics_metrics"}},{"in":"query","name":"filters","schema":{"$ref":"#/components/schemas/spectrum-analytics_filters"}},{"in":"query","name":"since","schema":{"$ref":"#/components/schemas/spectrum-analytics_since"}},{"in":"query","name":"time_delta","required":true,"schema":{"description":"Used to select time series resolution.","enum":["year","quarter","month","week","day","hour","dekaminute","minute"],"example":"minute","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-analytics_query-response-single"}}},"description":"Get analytics by time response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-analytics_api-response-common-failure"}}},"description":"Get analytics by time response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get analytics by time","tags":["Spectrum Analytics"],"x-api-token-group":["Analytics Read"]}},"/zones/{zone_id}/spectrum/analytics/events/summary":{"get":{"description":"Retrieves a list of summarised aggregate metrics over a given time period.","operationId":"spectrum-analytics-(-summary)-get-analytics-summary","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/spectrum-analytics_identifier"}},{"in":"query","name":"dimensions","schema":{"$ref":"#/components/schemas/spectrum-analytics_dimensions"}},{"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/spectrum-analytics_sort"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/spectrum-analytics_until"}},{"in":"query","name":"metrics","schema":{"$ref":"#/components/schemas/spectrum-analytics_metrics"}},{"in":"query","name":"filters","schema":{"$ref":"#/components/schemas/spectrum-analytics_filters"}},{"in":"query","name":"since","schema":{"$ref":"#/components/schemas/spectrum-analytics_since"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-analytics_query-response-single"}}},"description":"Get analytics summary response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-analytics_api-response-common-failure"}}},"description":"Get analytics summary response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get analytics summary","tags":["Spectrum Analytics"],"x-api-token-group":["Analytics Read"]}},"/zones/{zone_id}/spectrum/apps":{"get":{"description":"Retrieves a list of currently existing Spectrum applications inside a zone.","operationId":"spectrum-applications-list-spectrum-applications","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/spectrum-config_zone_identifier"}},{"in":"query","name":"page","schema":{"description":"Page number of paginated results. This parameter is required in order to use other pagination parameters. If included in the query, `result_info` will be present in the response.","example":1,"minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Sets the maximum number of results per page.","maximum":100,"minimum":1,"type":"number"}},{"in":"query","name":"direction","schema":{"default":"asc","description":"Sets the direction by which results are ordered.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"order","schema":{"default":"dns","description":"Application field by which results are ordered.","enum":["protocol","app_id","created_on","modified_on","dns"],"example":"protocol","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-config_app_config_collection"}}},"description":"List Spectrum applications response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-config_api-response-common-failure"}}},"description":"List Spectrum applications response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Spectrum applications","tags":["Spectrum Applications"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"]},"post":{"description":"Creates a new Spectrum application from a configuration using a name for the origin.","operationId":"spectrum-applications-create-spectrum-application-using-a-name-for-the-origin","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/spectrum-config_zone_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-config_update_app_config"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-config_app_config_single"}}},"description":"Create Spectrum application using a name for the origin response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-config_api-response-common-failure"}}},"description":"Create Spectrum application using a name for the origin response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Spectrum application using a name for the origin","tags":["Spectrum Applications"],"x-api-token-group":["Zone Settings Write"]}},"/zones/{zone_id}/spectrum/apps/{app_id}":{"delete":{"description":"Deletes a previously existing application.","operationId":"spectrum-applications-delete-spectrum-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/spectrum-config_app_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/spectrum-config_zone_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-config_api-response-single-id"}}},"description":"Delete Spectrum application response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-config_api-response-common-failure"}}},"description":"Delete Spectrum application response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Spectrum application","tags":["Spectrum Applications"],"x-api-token-group":["Zone Settings Write"]},"get":{"description":"Gets the application configuration of a specific application inside a zone.","operationId":"spectrum-applications-get-spectrum-application-configuration","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/spectrum-config_app_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/spectrum-config_zone_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-config_app_config_single"}}},"description":"Get Spectrum application configuration response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-config_api-response-common-failure"}}},"description":"Get Spectrum application configuration response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Spectrum application configuration","tags":["Spectrum Applications"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"]},"put":{"description":"Updates a previously existing application's configuration that uses a name for the origin.","operationId":"spectrum-applications-update-spectrum-application-configuration-using-a-name-for-the-origin","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/spectrum-config_app_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/spectrum-config_zone_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-config_update_app_config"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-config_app_config_single"}}},"description":"Update Spectrum application configuration using a name for the origin response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/spectrum-config_api-response-common-failure"}}},"description":"Update Spectrum application configuration using a name for the origin response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Spectrum application configuration using a name for the origin","tags":["Spectrum Applications"],"x-api-token-group":["Zone Settings Write"]}},"/zones/{zone_id}/speed_api/availabilities":{"get":{"description":"Retrieves quota for all plans, as well as the current zone quota.","operationId":"speed-get-availabilities","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/observatory_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_availabilities-response"}}},"description":"Page test availability."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get quota and availability","tags":["Observatory"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/speed_api/pages":{"get":{"description":"Lists all webpages which have been tested.","operationId":"speed-list-pages","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/observatory_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_pages-response-collection"}}},"description":"List of pages."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List tested webpages","tags":["Observatory"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/speed_api/pages/{url}/tests":{"delete":{"description":"Deletes all tests for a specific webpage from a specific region. Deleted tests are still counted as part of the quota.","operationId":"speed-delete-tests","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/observatory_identifier"}},{"in":"path","name":"url","required":true,"schema":{"$ref":"#/components/schemas/observatory_url"}},{"in":"query","name":"region","schema":{"allOf":[{"$ref":"#/components/schemas/observatory_region"},{"default":"us-central1","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_count-response"}}},"description":"Number of deleted tests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete all page tests","tags":["Observatory"],"x-api-token-group":["Zone Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Test history (list of tests) for a specific webpage.","operationId":"speed-list-test-history","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/observatory_identifier"}},{"in":"path","name":"url","required":true,"schema":{"$ref":"#/components/schemas/observatory_url"}},{"in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"in":"query","name":"per_page","schema":{"default":20,"maximum":50,"minimum":5,"type":"integer"}},{"in":"query","name":"region","schema":{"allOf":[{"$ref":"#/components/schemas/observatory_region"},{"default":"us-central1","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_page-test-response-collection"}}},"description":"List of test history for a page."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List page test history","tags":["Observatory"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Starts a test for a specific webpage, in a specific region.","operationId":"speed-create-test","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/observatory_identifier"}},{"in":"path","name":"url","required":true,"schema":{"$ref":"#/components/schemas/observatory_url"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"region":{"allOf":[{"$ref":"#/components/schemas/observatory_region"},{"default":"us-central1","type":"string"}]}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_page-test-response-single"}}},"description":"Page test details."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Start page test","tags":["Observatory"],"x-api-token-group":["Zone Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/speed_api/pages/{url}/tests/{test_id}":{"get":{"description":"Retrieves the result of a specific test.","operationId":"speed-get-test","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/observatory_identifier"}},{"in":"path","name":"url","required":true,"schema":{"$ref":"#/components/schemas/observatory_url"}},{"in":"path","name":"test_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_page-test-response-single"}}},"description":"Page test result."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get a page test result","tags":["Observatory"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/speed_api/pages/{url}/trend":{"get":{"description":"Lists the core web vital metrics trend over time for a specific page.","operationId":"speed-list-page-trend","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/observatory_identifier"}},{"in":"path","name":"url","required":true,"schema":{"$ref":"#/components/schemas/observatory_url"}},{"in":"query","name":"region","required":true,"schema":{"$ref":"#/components/schemas/observatory_region"}},{"in":"query","name":"deviceType","required":true,"schema":{"$ref":"#/components/schemas/observatory_device_type"}},{"in":"query","name":"start","required":true,"schema":{"$ref":"#/components/schemas/observatory_timestamp"}},{"in":"query","name":"end","schema":{"$ref":"#/components/schemas/observatory_timestamp"}},{"description":"The timezone of the start and end timestamps.","example":"America/Chicago","in":"query","name":"tz","required":true,"schema":{"type":"string"}},{"description":"A comma-separated list of metrics to include in the results.","in":"query","name":"metrics","required":true,"schema":{"example":"performanceScore,ttfb,fcp,si,lcp,tti,tbt,cls","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_trend-response"}}},"description":"Page trend."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List core web vital metrics trend","tags":["Observatory"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/speed_api/schedule/{url}":{"delete":{"description":"Deletes a scheduled test for a page.","operationId":"speed-delete-test-schedule","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/observatory_identifier"}},{"in":"path","name":"url","required":true,"schema":{"$ref":"#/components/schemas/observatory_url"}},{"in":"query","name":"region","schema":{"allOf":[{"$ref":"#/components/schemas/observatory_region"},{"default":"us-central1","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_count-response"}}},"description":"Number of deleted tests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete scheduled page test","tags":["Observatory"],"x-api-token-group":["Zone Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Retrieves the test schedule for a page in a specific region.","operationId":"speed-get-scheduled-test","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/observatory_identifier"}},{"in":"path","name":"url","required":true,"schema":{"$ref":"#/components/schemas/observatory_url"}},{"in":"query","name":"region","schema":{"allOf":[{"$ref":"#/components/schemas/observatory_region"},{"default":"us-central1","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_schedule-response-single"}}},"description":"Page test schedule."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get a page test schedule","tags":["Observatory"],"x-api-token-group":["Zone Settings Write","Zone Settings Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a scheduled test for a page.","operationId":"speed-create-scheduled-test","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/observatory_identifier"}},{"in":"path","name":"url","required":true,"schema":{"$ref":"#/components/schemas/observatory_url"}},{"in":"query","name":"region","schema":{"allOf":[{"$ref":"#/components/schemas/observatory_region"},{"default":"us-central1","type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_create-schedule-response"}}},"description":"Page test schedule."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/observatory_api-response-common-failure"}}},"description":"Failure response."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create scheduled page test","tags":["Observatory"],"x-api-token-group":["Zone Settings Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/ssl/analyze":{"post":{"description":"Returns the set of hostnames, the signature algorithm, and the expiration date of the certificate.","operationId":"analyze-certificate-analyze-certificate","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"bundle_method":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_bundle_method"},"certificate":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_analyze_response"}}},"description":"Analyze Certificate response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_analyze_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Analyze Certificate response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Analyze Certificate","tags":["Analyze Certificate"],"x-api-token-group":["Access: Mutual TLS Certificates Write","Access: Mutual TLS Certificates Read","SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/ssl/certificate_packs":{"get":{"description":"For a given zone, list all active certificate packs.","operationId":"certificate-packs-list-certificate-packs","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"query","name":"status","schema":{"description":"Include Certificate Packs of all statuses, not just active ones.","enum":["all"],"example":"all"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_pack_response_collection"}}},"description":"List Certificate Packs response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_pack_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"List Certificate Packs response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"List Certificate Packs","tags":["Certificate Packs"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/ssl/certificate_packs/order":{"post":{"description":"For a given zone, order an advanced certificate pack.","operationId":"certificate-packs-order-advanced-certificate-manager-certificate-pack","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"certificate_authority":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_authority"},"cloudflare_branding":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_cloudflare_branding"},"hosts":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_schemas-hosts"},"type":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_advanced_type"},"validation_method":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_validation_method"},"validity_days":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_validity_days"}},"required":["type","hosts","validation_method","validity_days","certificate_authority"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_advanced_certificate_pack_response_single"}}},"description":"Order Advanced Certificate Manager Certificate Pack response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_advanced_certificate_pack_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Order Advanced Certificate Manager Certificate Pack response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Order Advanced Certificate Manager Certificate Pack","tags":["Certificate Packs"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/ssl/certificate_packs/quota":{"get":{"description":"For a given zone, list certificate pack quotas.","operationId":"certificate-packs-get-certificate-pack-quotas","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_pack_quota_response"}}},"description":"Get Certificate Pack Quotas response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_pack_quota_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Get Certificate Pack Quotas response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Certificate Pack Quotas","tags":["Certificate Packs"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}":{"delete":{"description":"For a given zone, delete an advanced certificate pack.","operationId":"certificate-packs-delete-advanced-certificate-manager-certificate-pack","parameters":[{"in":"path","name":"certificate_pack_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_delete_advanced_certificate_pack_response_single"}}},"description":"Delete Advanced Certificate Manager Certificate Pack response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_delete_advanced_certificate_pack_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Delete Advanced Certificate Manager Certificate Pack response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Delete Advanced Certificate Manager Certificate Pack","tags":["Certificate Packs"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"For a given zone, get a certificate pack.","operationId":"certificate-packs-get-certificate-pack","parameters":[{"in":"path","name":"certificate_pack_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_pack_response_single"}}},"description":"Get Certificate Pack response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_certificate_pack_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Get Certificate Pack response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Get Certificate Pack","tags":["Certificate Packs"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"For a given zone, restart validation or add cloudflare branding for an advanced certificate pack.  The former is only a validation operation for a Certificate Pack in a validation_timed_out status.","operationId":"certificate-packs-restart-validation-for-advanced-certificate-manager-certificate-pack","parameters":[{"in":"path","name":"certificate_pack_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"cloudflare_branding":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_cloudflare_branding"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_advanced_certificate_pack_response_single"}}},"description":"Restart Validation for Advanced Certificate Manager Certificate Pack response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_advanced_certificate_pack_response_single"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Restart Validation for Advanced Certificate Manager Certificate Pack response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Restart Validation or Update Advanced Certificate Manager Certificate Pack","tags":["Certificate Packs"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/ssl/recommendation":{"get":{"deprecated":true,"description":"Retrieve the SSL/TLS Recommender's recommendation for a zone.","operationId":"ssl/-tls-mode-recommendation-ssl/-tls-recommendation","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/cache_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache_api-response-single-id"}}},"description":"SSL/TLS Recommendation response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache_api-response-common-failure"}}},"description":"SSL/TLS Recommendation response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"SSL/TLS Recommendation","tags":["SSL/TLS Mode Recommendation"],"x-api-token-group":["Zone Settings Write","Zone Settings Read","SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true},"x-stainless-deprecation-message":"SSL/TLS Recommender has been decommissioned in favor of Automatic SSL/TLS"}},"/zones/{zone_id}/ssl/universal/settings":{"get":{"description":"Get Universal SSL Settings for a Zone.","operationId":"universal-ssl-settings-for-a-zone-universal-ssl-settings-details","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ssl_universal_settings_response"}}},"description":"Universal SSL Settings Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ssl_universal_settings_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Universal SSL Settings Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Universal SSL Settings Details","tags":["Universal SSL Settings for a Zone"],"x-api-token-group":["SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Patch Universal SSL Settings for a Zone.","operationId":"universal-ssl-settings-for-a-zone-edit-universal-ssl-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_universal"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ssl_universal_settings_response"}}},"description":"Edit Universal SSL Settings response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ssl_universal_settings_response"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Edit Universal SSL Settings response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Edit Universal SSL Settings","tags":["Universal SSL Settings for a Zone"],"x-api-token-group":["SSL and Certificates Write"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/ssl/verification":{"get":{"description":"Get SSL Verification Info for a Zone.","operationId":"ssl-verification-ssl-verification-details","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}},{"in":"query","name":"retry","schema":{"description":"Immediately retry SSL Verification.","enum":[true],"example":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ssl_verification_response_collection"}}},"description":"SSL Verification Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ssl_verification_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"SSL Verification Details response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"SSL Verification Details","tags":["SSL Verification"],"x-api-token-group":["Access: Mutual TLS Certificates Write","Access: Mutual TLS Certificates Read","SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/ssl/verification/{certificate_pack_id}":{"patch":{"description":"Edit SSL validation method for a certificate pack. A PATCH request will request an immediate validation check on any certificate, and return the updated status. If a validation method is provided, the validation will be immediately attempted using that method.","operationId":"ssl-verification-edit-ssl-certificate-pack-validation-method","parameters":[{"in":"path","name":"certificate_pack_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_cert_pack_uuid"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_components-schemas-validation_method"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ssl_validation_method_response_collection"}}},"description":"Edit SSL Certificate Pack Validation Method response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tls-certificates-and-hostnames_ssl_validation_method_response_collection"},{"$ref":"#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure"}]}}},"description":"Edit SSL Certificate Pack Validation Method response failure"}},"security":[{"api_email":[],"api_key":[]}],"summary":"Edit SSL Certificate Pack Validation Method","tags":["SSL Verification"],"x-api-token-group":["Access: Mutual TLS Certificates Write","Access: Mutual TLS Certificates Read","SSL and Certificates Write","SSL and Certificates Read"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/subscription":{"get":{"description":"Lists zone subscription details.","operationId":"zone-subscription-zone-subscription-details","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_zone_subscription_response_single"}}},"description":"Zone Subscription Details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_zone_subscription_response_single"},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"Zone Subscription Details response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Zone Subscription Details","tags":["Zone Subscription"],"x-api-token-group":["Billing Write","Billing Read"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a zone subscription, either plan or add-ons.","operationId":"zone-subscription-create-zone-subscription","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_subscription-v2"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_zone_subscription_response_single"}}},"description":"Create Zone Subscription response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_zone_subscription_response_single"},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"Create Zone Subscription response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Zone Subscription","tags":["Zone Subscription"],"x-api-token-group":["Billing Write"],"x-cfPermissionsRequired":{"enum":["#billing:read","#billing:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates zone subscriptions, either plan or add-ons.","operationId":"zone-subscription-update-zone-subscription","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/bill-subs-api_schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_subscription-v2"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bill-subs-api_zone_subscription_response_single"}}},"description":"Update Zone Subscription response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bill-subs-api_zone_subscription_response_single"},{"$ref":"#/components/schemas/bill-subs-api_api-response-common-failure"}]}}},"description":"Update Zone Subscription response failure"}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update Zone Subscription","tags":["Zone Subscription"],"x-api-token-group":["Billing Write"],"x-cfPermissionsRequired":{"enum":["#billing:read","#billing:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/token_validation/config":{"get":{"description":"Lists all token validation configurations for this zone","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-config-list","parameters":[{"$ref":"#/components/parameters/api-shield_page"},{"$ref":"#/components/parameters/api-shield_per_page"}],"responses":{"200":{"$ref":"#/components/responses/api-shield_list-configs-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List token validation configurations","tags":["Token Validation Token Configuration"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"post":{"description":"Create a new Token Validation configuration","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-config-create","requestBody":{"$ref":"#/components/requestBodies/api-shield_create-config"},"responses":{"200":{"$ref":"#/components/responses/api-shield_create-config-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a new Token Validation configuration","tags":["Token Validation Token Configuration"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/token_validation/config/{config_id}":{"delete":{"description":"Delete Token Configuration","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-config-delete","responses":{"200":{"$ref":"#/components/responses/api-shield_delete-config-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Token Configuration","tags":["Token Validation Token Configuration"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]},"get":{"description":"Get a single Token Configuration","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-config-get","responses":{"200":{"$ref":"#/components/responses/api-shield_get-config-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get a single Token Configuration","tags":["Token Validation Token Configuration"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"},{"$ref":"#/components/parameters/api-shield_config_id"}],"patch":{"description":"Edit fields of an existing Token Configuration","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-config-edit","requestBody":{"$ref":"#/components/requestBodies/api-shield_edit-config"},"responses":{"200":{"$ref":"#/components/responses/api-shield_edit-config-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Edit an existing Token Configuration","tags":["Token Validation Token Configuration"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/token_validation/config/{config_id}/credentials":{"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"},{"$ref":"#/components/parameters/api-shield_config_id"}],"put":{"description":"Update Token Configuration credentials","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-config-credentials-update","requestBody":{"$ref":"#/components/requestBodies/api-shield_update-config-credentials"},"responses":{"200":{"$ref":"#/components/responses/api-shield_update-config-credentials-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Token Configuration credentials","tags":["Token Validation Token Configuration"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/token_validation/rules":{"get":{"description":"List token validation rules","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-rules-list","parameters":[{"$ref":"#/components/parameters/api-shield_per_page"},{"$ref":"#/components/parameters/api-shield_page"},{"description":"Select rules using any of these token configurations.","examples":{"multipleIDs":{"value":["f0963ed4-f3a1-4599-8a61-9e5658c865e0,3aad66bb-059d-4b3d-87e1-cdf4d406f412"]},"multipleIDsExploded":{"value":["f0963ed4-f3a1-4599-8a61-9e5658c865e0","3aad66bb-059d-4b3d-87e1-cdf4d406f412"]}},"in":"query","name":"token_configuration","schema":{"items":{"$ref":"#/components/schemas/api-shield_schemas-uuid"},"type":"array"}},{"in":"query","name":"action","schema":{"$ref":"#/components/schemas/api-shield_action"}},{"in":"query","name":"enabled","schema":{"$ref":"#/components/schemas/api-shield_enabled"}},{"description":"Select rules with these IDs.","in":"query","name":"id","schema":{"$ref":"#/components/schemas/api-shield_schemas-uuid"}},{"description":"Select rules with these IDs.","in":"query","name":"rule_id","schema":{"$ref":"#/components/schemas/api-shield_schemas-uuid"}},{"description":"Select rules with this host in `include`.","in":"query","name":"host","schema":{"$ref":"#/components/schemas/api-shield_host"}},{"description":"Select rules with this host in `include`.","in":"query","name":"hostname","schema":{"$ref":"#/components/schemas/api-shield_host"}}],"responses":{"200":{"$ref":"#/components/responses/api-shield_list-rules-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List token validation rules","tags":["Token Validation Token Rules"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"post":{"description":"Create a token validation rule.","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-rules-create","requestBody":{"$ref":"#/components/requestBodies/api-shield_create-rule"},"responses":{"200":{"$ref":"#/components/responses/api-shield_create-rule-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a token validation rule","tags":["Token Validation Token Rules"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/token_validation/rules/bulk":{"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"patch":{"description":"Edit token validation rules.\n\nA request can update multiple Token Validation Rules.\n\nRules can be re-ordered using the `position` field.\n\nReturns all updated rules.\n","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-rules-bulk-edit","requestBody":{"$ref":"#/components/requestBodies/api-shield_bulk-edit-rules"},"responses":{"200":{"$ref":"#/components/responses/api-shield_bulk-edit-rules-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Bulk edit token validation rules","tags":["Token Validation Token Rules"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]},"post":{"description":"Create zone token validation rules.\n\nA request can create multiple Token Validation Rules.\n","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-rules-bulk-create","requestBody":{"$ref":"#/components/requestBodies/api-shield_bulk-create-rules"},"responses":{"200":{"$ref":"#/components/responses/api-shield_bulk-create-rules-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Bulk create token validation rules","tags":["Token Validation Token Rules"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/token_validation/rules/preview":{"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"}],"post":{"description":"Preview operations covered by a Token Validation rule.\n\nThe API will return all operations on a zone annotated with an additional `state` field.\nOperations with an `included` `state` will be covered by a Token Validation Rule.\n","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-rules-preview","parameters":[{"$ref":"#/components/parameters/api-shield_per_page"},{"$ref":"#/components/parameters/api-shield_page"},{"examples":{"multiple":{"value":["included,excluded"]},"multipleExploded":{"value":["included","excluded"]}},"in":"query","name":"state","schema":{"items":{"$ref":"#/components/schemas/api-shield_selector-operation-state"},"type":"array"}},{"description":"Filter operations by host.","in":"query","name":"host","schema":{"items":{"$ref":"#/components/schemas/api-shield_host"},"type":"array"}},{"description":"Filter operations by host.","in":"query","name":"hostname","schema":{"items":{"$ref":"#/components/schemas/api-shield_host"},"type":"array"}},{"description":"Filter operations by method.","in":"query","name":"method","schema":{"items":{"$ref":"#/components/schemas/api-shield_method"},"type":"array"}},{"description":"Filter operations by endpoint. Allows substring matching.","in":"query","name":"endpoint","schema":{"items":{"$ref":"#/components/schemas/api-shield_endpoint"},"type":"array"}}],"requestBody":{"$ref":"#/components/requestBodies/api-shield_preview-rules"},"responses":{"200":{"$ref":"#/components/responses/api-shield_preview-rules-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Preview operations covered by a Token Validation rule","tags":["Token Validation Token Rules"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]}},"/zones/{zone_id}/token_validation/rules/{rule_id}":{"delete":{"description":"Delete a zone token validation rule.","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-rules-delete","responses":{"200":{"$ref":"#/components/responses/api-shield_delete-rule-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete a zone token validation rule","tags":["Token Validation Token Rules"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]},"get":{"description":"Get a zone token validation rule.","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-rules-get","responses":{"200":{"$ref":"#/components/responses/api-shield_get-rule-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get a zone token validation rule","tags":["Token Validation Token Rules"],"x-api-token-group":["Account API Gateway","Account API Gateway Read","Domain API Gateway","Domain API Gateway Read"]},"parameters":[{"$ref":"#/components/parameters/api-shield_zone_id"},{"$ref":"#/components/parameters/api-shield_rule_id"}],"patch":{"description":"Edit a zone token validation rule.","externalDocs":{"description":"Learn more about JSON Web Tokens Validation.","url":"https://developers.cloudflare.com/api-shield/security/jwt-validation/"},"operationId":"token-validation-rules-edit","requestBody":{"$ref":"#/components/requestBodies/api-shield_edit-rule"},"responses":{"200":{"$ref":"#/components/responses/api-shield_edit-rule-success"},"4XX":{"$ref":"#/components/responses/api-shield_generic_failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Edit a zone token validation rule","tags":["Token Validation Token Rules"],"x-api-token-group":["Account API Gateway","Domain API Gateway"]}},"/zones/{zone_id}/url_normalization":{"delete":{"description":"Deletes the URL Normalization settings.","operationId":"deleteUrlNormalization","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"204":{"$ref":"#/components/responses/rulesets_Empty"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Delete URL Normalization settings","tags":["URL Normalization"],"x-api-token-group":["Response Compression Write","Config Settings Write","Dynamic URL Redirects Write","Cache Settings Write","Custom Errors Write","Origin Write","Managed headers Write","Zone Transform Rules Write","Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Write","Sanitize Write","Transform Rules Write","Select Configuration Write","Bot Management Write","Zone WAF Write","Account WAF Write","Account Rulesets Write","Logs Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the current URL Normalization settings.","operationId":"getUrlNormalization","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"responses":{"200":{"$ref":"#/components/responses/rulesets_UrlNormalization"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Get URL Normalization settings","tags":["URL Normalization"],"x-api-token-group":["Response Compression Write","Response Compression Read","Config Settings Write","Config Settings Read","Dynamic URL Redirects Write","Dynamic URL Redirects Read","Cache Settings Write","Cache Settings Read","Custom Errors Write","Custom Errors Read","Origin Write","Origin Read","Managed headers Write","Managed headers Read","Zone Transform Rules Write","Zone Transform Rules Read","Mass URL Redirects Write","Mass URL Redirects Read","Magic Firewall Write","Magic Firewall Read","L4 DDoS Managed Ruleset Write","L4 DDoS Managed Ruleset Read","HTTP DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Read","Sanitize Write","Sanitize Read","Transform Rules Write","Transform Rules Read","Select Configuration Write","Select Configuration Read","Bot Management Write","Bot Management Read","Zone WAF Write","Zone WAF Read","Account WAF Write","Account WAF Read","Account Rulesets Read","Account Rulesets Write","Logs Write","Logs Read","Logs Write","Logs Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates the URL Normalization settings.","operationId":"updateUrlNormalization","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_ZoneId"}}],"requestBody":{"$ref":"#/components/requestBodies/rulesets_UrlNormalization"},"responses":{"200":{"$ref":"#/components/responses/rulesets_UrlNormalization"},"4XX":{"$ref":"#/components/responses/rulesets_Failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]},{"api_email":[],"api_key":[]}],"summary":"Update URL Normalization settings","tags":["URL Normalization"],"x-api-token-group":["Response Compression Write","Config Settings Write","Dynamic URL Redirects Write","Cache Settings Write","Custom Errors Write","Origin Write","Managed headers Write","Zone Transform Rules Write","Mass URL Redirects Write","Magic Firewall Write","L4 DDoS Managed Ruleset Write","HTTP DDoS Managed Ruleset Write","Sanitize Write","Transform Rules Write","Select Configuration Write","Bot Management Write","Zone WAF Write","Account WAF Write","Account Rulesets Write","Logs Write","Logs Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/waiting_rooms":{"get":{"description":"Lists waiting rooms for zone.","operationId":"waiting-room-list-waiting-rooms","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}},{"$ref":"#/components/parameters/waitingroom_page"},{"$ref":"#/components/parameters/waitingroom_per_page"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_response_collection"}}},"description":"List waiting rooms for zone response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_response_collection"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"List waiting rooms for zone response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List waiting rooms for zone","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Read","Waiting Rooms Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new waiting room.","operationId":"waiting-room-create-waiting-room","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_query_waitingroom"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_single_response"}}},"description":"Create waiting room response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_single_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Create waiting room response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create waiting room","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/waiting_rooms/preview":{"post":{"description":"Creates a waiting room page preview. Upload a custom waiting room page for preview. You will receive a preview URL in the form `http://waitingrooms.dev/preview/\u003cuuid\u003e`. You can use the following query parameters to change the state of the preview:\n1. `force_queue`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website (also known as queueAll).\n2. `queue_is_full`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n3. `queueing_method`: The queueing method currently used by the waiting room.\n\t- **fifo** indicates a FIFO queue.\n\t- **random** indicates a Random queue.\n\t- **passthrough** indicates a Passthrough queue. Keep in mind that the waiting room page will only be displayed if `force_queue=true` or `event=prequeueing` — for other cases the request will pass through to the origin. For our preview, this will be a fake origin website returning \\\"Welcome\\\". \n\t- **reject** indicates a Reject queue.\n4. `event`: Used to preview a waiting room event.\n\t- **none** indicates no event is occurring.\n\t- **prequeueing** indicates that an event is prequeueing (between `prequeue_start_time` and `event_start_time`).\n\t- **started** indicates that an event has started (between `event_start_time` and `event_end_time`).\n5. `shuffle_at_event_start`: Boolean indicating if the event will shuffle users in the prequeue when it starts. This can only be set to **true** if an event is active (`event` is not **none**).\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/\u003cuuid\u003e?force_queue=false\u0026queue_is_full=false\u0026queueing_method=random\u0026event=started\u0026shuffle_at_event_start=true`\n6. `waitTime`: Non-zero, positive integer indicating the estimated wait time in minutes. The default value is 10 minutes.\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/\u003cuuid\u003e?waitTime=50` to configure the estimated wait time as 50 minutes.","operationId":"waiting-room-create-a-custom-waiting-room-page-preview","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_query_preview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_preview_response"}}},"description":"Create a custom waiting room page preview response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_preview_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Create a custom waiting room page preview response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create a custom waiting room page preview","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/waiting_rooms/settings":{"get":{"operationId":"waiting-room-get-zone-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_zone_settings_response"}}},"description":"The current zone-level Waiting Room settings"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_zone_settings_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"The current zone-level Waiting Room settings response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get zone-level Waiting Room settings","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Read","Waiting Rooms Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"patch":{"operationId":"waiting-room-patch-zone-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_zone_settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_zone_settings_response"}}},"description":"The updated zone-level Waiting Room settings"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_zone_settings_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"The zone-level Waiting Room settings response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch zone-level Waiting Room settings","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"put":{"operationId":"waiting-room-update-zone-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_zone_settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_zone_settings_response"}}},"description":"The updated zone-level Waiting Room settings"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_zone_settings_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"The zone-level Waiting Room settings response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update zone-level Waiting Room settings","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/waiting_rooms/{waiting_room_id}":{"delete":{"description":"Deletes a waiting room.","operationId":"waiting-room-delete-waiting-room","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id_response"}}},"description":"Delete waiting room response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_waiting_room_id_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Delete waiting room response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete waiting room","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Fetches a single configured waiting room.","operationId":"waiting-room-waiting-room-details","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_single_response"}}},"description":"Waiting room details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_single_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Waiting room details response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Waiting room details","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Read","Waiting Rooms Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Patches a configured waiting room.","operationId":"waiting-room-patch-waiting-room","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_query_waitingroom"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_single_response"}}},"description":"Patch waiting room response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_single_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Patch waiting room response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch waiting room","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a configured waiting room.","operationId":"waiting-room-update-waiting-room","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_query_waitingroom"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_single_response"}}},"description":"Update waiting room response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_single_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Update waiting room response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update waiting room","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events":{"get":{"description":"Lists events for a waiting room.","operationId":"waiting-room-list-events","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}},{"$ref":"#/components/parameters/waitingroom_page"},{"$ref":"#/components/parameters/waitingroom_per_page"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_event_response_collection"}}},"description":"List events response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_event_response_collection"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"List events response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List events","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Read","Waiting Rooms Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Only available for the Waiting Room Advanced subscription. Creates an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event's configuration may either override or inherit from the waiting room's configuration. Note that events cannot overlap with each other, so only one event can be active at a time.","operationId":"waiting-room-create-event","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_query_event"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_event_response"}}},"description":"Create event response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_event_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Create event response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create event","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}":{"delete":{"description":"Deletes an event for a waiting room.","operationId":"waiting-room-delete-event","parameters":[{"in":"path","name":"event_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_event_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_event_id_response"}}},"description":"Delete event response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_event_id_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Delete event response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete event","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Fetches a single configured event for a waiting room.","operationId":"waiting-room-event-details","parameters":[{"in":"path","name":"event_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_event_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_event_response"}}},"description":"Event details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_event_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Event details response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Event details","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Read","Waiting Rooms Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Patches a configured event for a waiting room.","operationId":"waiting-room-patch-event","parameters":[{"in":"path","name":"event_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_event_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_query_event"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_event_response"}}},"description":"Patch event response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_event_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Patch event response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch event","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a configured event for a waiting room.","operationId":"waiting-room-update-event","parameters":[{"in":"path","name":"event_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_event_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_query_event"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_event_response"}}},"description":"Update event response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_event_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Update event response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update event","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/waiting_rooms/{waiting_room_id}/events/{event_id}/details":{"get":{"description":"Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values.","operationId":"waiting-room-preview-active-event-details","parameters":[{"in":"path","name":"event_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_event_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_event_details_response"}}},"description":"Preview active event details response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_event_details_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Preview active event details response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Preview active event details","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Read","Waiting Rooms Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules":{"get":{"description":"Lists rules for a waiting room.","operationId":"waiting-room-list-waiting-room-rules","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_rules_response_collection"}}},"description":"List Waiting Room Rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_rules_response_collection"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"List Waiting Room Rules response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Waiting Room Rules","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Read","Waiting Rooms Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room.","operationId":"waiting-room-create-waiting-room-rule","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_create_rule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_rules_response_collection"}}},"description":"Create Waiting Room Rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_rules_response_collection"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Create Waiting Room Rule response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Waiting Room Rule","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room.","operationId":"waiting-room-replace-waiting-room-rules","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_update_rules"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_rules_response_collection"}}},"description":"Replace Waiting Room Rules response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_rules_response_collection"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Replace Waiting Room Rules response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Replace Waiting Room Rules","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/waiting_rooms/{waiting_room_id}/rules/{rule_id}":{"delete":{"description":"Deletes a rule for a waiting room.","operationId":"waiting-room-delete-waiting-room-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_rule_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_rules_response_collection"}}},"description":"Delete Waiting Room Rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_rules_response_collection"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Delete Waiting Room Rule response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Waiting Room Rule","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Patches a rule for a waiting room.","operationId":"waiting-room-patch-waiting-room-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_rule_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_patch_rule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_rules_response_collection"}}},"description":"Patch Waiting Room Rule response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_rules_response_collection"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Patch Waiting Room Rule response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Patch Waiting Room Rule","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/waiting_rooms/{waiting_room_id}/status":{"get":{"description":"Fetches the status of a configured waiting room. Response fields include:\n1. `status`: String indicating the status of the waiting room. The possible status are:\n\t- **not_queueing** indicates that the configured thresholds have not been met and all users are going through to the origin.\n\t- **queueing** indicates that the thresholds have been met and some users are held in the waiting room.\n\t- **event_prequeueing** indicates that an event is active and is currently prequeueing users before it starts.\n\t- **suspended** indicates that the room is suspended.\n2. `event_id`: String of the current event's `id` if an event is active, otherwise an empty string.\n3. `estimated_queued_users`: Integer of the estimated number of users currently waiting in the queue.\n4. `estimated_total_active_users`: Integer of the estimated number of users currently active on the origin.\n5. `max_estimated_time_minutes`: Integer of the maximum estimated time currently presented to the users.","operationId":"waiting-room-get-waiting-room-status","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_waiting_room_id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/waitingroom_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waitingroom_status_response"}}},"description":"Get waiting room status response"},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waitingroom_status_response"},{"$ref":"#/components/schemas/waitingroom_api-response-common-failure"}],"type":"object"}}},"description":"Get waiting room status response failure"}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get waiting room status","tags":["Waiting Room"],"x-api-token-group":["Waiting Rooms Read","Waiting Rooms Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/web3/hostnames":{"get":{"operationId":"web3-hostname-list-web3-hostnames","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_collection_response"}}},"description":"List Web3 Hostnames response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_collection_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"List Web3 Hostnames error response (4XX)."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_collection_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"List Web3 Hostnames response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List Web3 Hostnames","tags":["Web3 Hostname"],"x-api-token-group":["Web3 Hostnames Write","Web3 Hostnames Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"web3-hostname-create-web3-hostname","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_create_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_single_response"}}},"description":"Create Web3 Hostname response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_collection_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Create Web3 Hostname error response (4XX)."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_single_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Create Web3 Hostname response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create Web3 Hostname","tags":["Web3 Hostname"],"x-api-token-group":["Web3 Hostnames Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/web3/hostnames/{identifier}":{"delete":{"operationId":"web3-hostname-delete-web3-hostname","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_api-response-single-id"}}},"description":"Delete Web3 Hostname response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_collection_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Delete Web3 Hostname error response (4XX)."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_api-response-single-id"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Delete Web3 Hostname response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete Web3 Hostname","tags":["Web3 Hostname"],"x-api-token-group":["Web3 Hostnames Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"web3-hostname-web3-hostname-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_single_response"}}},"description":"Web3 Hostname Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_collection_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Web3 Hostname Details error response (4XX)."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_single_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Web3 Hostname Details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Web3 Hostname Details","tags":["Web3 Hostname"],"x-api-token-group":["Web3 Hostnames Write","Web3 Hostnames Read"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"operationId":"web3-hostname-edit-web3-hostname","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_modify_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_single_response"}}},"description":"Edit Web3 Hostname response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_collection_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Edit Web3 Hostname error response (4XX)."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_single_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Edit Web3 Hostname response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Edit Web3 Hostname","tags":["Web3 Hostname"],"x-api-token-group":["Web3 Hostnames Write"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list":{"get":{"operationId":"web3-hostname-ipfs-universal-path-gateway-content-list-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_content_list_details_response"}}},"description":"IPFS Universal Path Gateway Content List Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_content_list_details_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"IPFS Universal Path Gateway Content List Details error response (4XX)."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_content_list_details_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"IPFS Universal Path Gateway Content List Details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"IPFS Universal Path Gateway Content List Details","tags":["Web3 Hostname"],"x-api-token-group":["Web3 Hostnames Write","Web3 Hostnames Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"operationId":"web3-hostname-update-ipfs-universal-path-gateway-content-list","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_content_list_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_content_list_details_response"}}},"description":"Update IPFS Universal Path Gateway Content List response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_content_list_details_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Update IPFS Universal Path Gateway Content List error response (4XX)."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_content_list_details_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Update IPFS Universal Path Gateway Content List response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Update IPFS Universal Path Gateway Content List","tags":["Web3 Hostname"],"x-api-token-group":["Web3 Hostnames Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries":{"get":{"operationId":"web3-hostname-list-ipfs-universal-path-gateway-content-list-entries","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_content_list_entry_collection_response"}}},"description":"List IPFS Universal Path Gateway Content List Entries response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_content_list_entry_collection_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"List IPFS Universal Path Gateway Content List Entries error response (4XX)."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_content_list_entry_collection_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"List IPFS Universal Path Gateway Content List Entries response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"List IPFS Universal Path Gateway Content List Entries","tags":["Web3 Hostname"],"x-api-token-group":["Web3 Hostnames Write","Web3 Hostnames Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"operationId":"web3-hostname-create-ipfs-universal-path-gateway-content-list-entry","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_content_list_entry_create_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_content_list_entry_single_response"}}},"description":"Create IPFS Universal Path Gateway Content List Entry response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_content_list_entry_single_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Create IPFS Universal Path Gateway Content List Entry error response (4XX)."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_content_list_entry_single_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Create IPFS Universal Path Gateway Content List Entry response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Create IPFS Universal Path Gateway Content List Entry","tags":["Web3 Hostname"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}":{"delete":{"operationId":"web3-hostname-delete-ipfs-universal-path-gateway-content-list-entry","parameters":[{"in":"path","name":"content_list_entry_identifier","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_api-response-single-id"}}},"description":"Delete IPFS Universal Path Gateway Content List Entry response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_api-response-single-id"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Delete IPFS Universal Path Gateway Content List Entry error response (4XX)."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_api-response-single-id"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Delete IPFS Universal Path Gateway Content List Entry response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Delete IPFS Universal Path Gateway Content List Entry","tags":["Web3 Hostname"],"x-api-token-group":["Web3 Hostnames Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"operationId":"web3-hostname-ipfs-universal-path-gateway-content-list-entry-details","parameters":[{"in":"path","name":"content_list_entry_identifier","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_content_list_entry_single_response"}}},"description":"IPFS Universal Path Gateway Content List Entry Details response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_content_list_entry_single_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"IPFS Universal Path Gateway Content List Entry Details error response (4XX)."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_content_list_entry_single_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"IPFS Universal Path Gateway Content List Entry Details response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"IPFS Universal Path Gateway Content List Entry Details","tags":["Web3 Hostname"],"x-api-token-group":["Web3 Hostnames Write","Web3 Hostnames Read"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"operationId":"web3-hostname-edit-ipfs-universal-path-gateway-content-list-entry","parameters":[{"in":"path","name":"content_list_entry_identifier","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/web3_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_content_list_entry_create_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3_content_list_entry_single_response"}}},"description":"Edit IPFS Universal Path Gateway Content List Entry response."},"4XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_content_list_entry_single_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Edit IPFS Universal Path Gateway Content List Entry error response (4XX)."},"5XX":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3_content_list_entry_single_response"},{"$ref":"#/components/schemas/web3_api-response-common-failure"}]}}},"description":"Edit IPFS Universal Path Gateway Content List Entry response failure."}},"security":[{"api_email":[],"api_key":[],"api_token":[]}],"summary":"Edit IPFS Universal Path Gateway Content List Entry","tags":["Web3 Hostname"],"x-api-token-group":["Web3 Hostnames Write"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/workers/routes":{"get":{"description":"Returns routes for a zone.","operationId":"worker-routes-list-routes","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/workers_route"},"type":"array"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"List Routes response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"List Routes response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"List Routes","tags":["Worker Routes"],"x-api-token-group":["Workers Routes Write","Workers Routes Read"]},"post":{"description":"Creates a route that maps a URL pattern to a Worker.","operationId":"worker-routes-create-route","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_route"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_route"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Create Route response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Create Route response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Create Route","tags":["Worker Routes"],"x-api-token-group":["Workers Routes Write"]}},"/zones/{zone_id}/workers/routes/{route_id}":{"delete":{"description":"Deletes a route.","operationId":"worker-routes-delete-route","parameters":[{"in":"path","name":"route_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/workers_identifier"}},"type":"object"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Delete Route response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Delete Route response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Delete Route","tags":["Worker Routes"],"x-api-token-group":["Workers Routes Write"]},"get":{"description":"Returns information about a route, including URL pattern and Worker.","operationId":"worker-routes-get-route","parameters":[{"in":"path","name":"route_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_route"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Get Route response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Get Route response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Get Route","tags":["Worker Routes"],"x-api-token-group":["Workers Routes Write","Workers Routes Read"]},"put":{"description":"Updates the URL pattern or Worker associated with a route.","operationId":"worker-routes-update-route","parameters":[{"in":"path","name":"route_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/workers_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_route"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/workers_api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/workers_route"}},"required":["result"],"type":"object"}],"type":"object"}}},"description":"Update Route response."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/workers_api-response-common-failure"}}},"description":"Update Route response failure."}},"security":[{"api_token":[]},{"api_email":[],"api_key":[]}],"summary":"Update Route","tags":["Worker Routes"],"x-api-token-group":["Workers Routes Write"]}}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]},{"user_service_key":[]}],"servers":[{"description":"Client API","url":"https://api.cloudflare.com/client/v4"}]}